SMART_TUTOR / README.md
YazeedBinShihah's picture
Update README.md
8988106 verified
---
title: Smart Tutor AI
emoji: πŸŽ“
colorFrom: indigo
colorTo: purple
sdk: docker
pinned: false
license: apache-2.0
short_description: An intelligent study assistant built with CrewAI and Gradio
---
# Smart Tutor AI πŸŽ“
An intelligent study assistant built with **CrewAI** and **Gradio**.
## Features
- **Smart Summarization**: Get concise summaries from your documents.
- **Auto Quiz Generation**: Generate multiple-choice questions grounded in your text.
- **Intelligent Tutoring**: Get graded feedback with detailed explanations for incorrect answers.
## Setup for Hugging Face
1. Create a new Space on Hugging Face.
2. Select **Gradio** as the SDK.
3. Go to **Settings** -> **Variables and secrets**.
4. Add a new secret:
- Name: `OPENAI_API_KEY`
- Value: `your_openai_api_key_here`
5. Upload all files from this repository.
## Local Setup
1. Clone the repository.
2. Install dependencies: `pip install -r requirements.txt`.
3. Create a `.env` file and add your `OPENAI_API_KEY`.
4. Run the app: `python app.py`.