Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,44 +1,57 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
##
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
##
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: SmartTutor AI
|
| 3 |
+
emoji: π§
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: "4.44.1"
|
| 8 |
+
python_version: "3.10"
|
| 9 |
+
app_file: app.py
|
| 10 |
+
pinned: false
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
|
| 14 |
+
# π§ SmartTutor AI
|
| 15 |
+
|
| 16 |
+
SmartTutor AI is an intelligent educational assistant built with **CrewAI** and **Gradio**. It helps users summarize documents, generate quizzes, and get detailed explanations for their mistakes.
|
| 17 |
+
|
| 18 |
+
## β¨ Features
|
| 19 |
+
|
| 20 |
+
- **Document Summarization**: Get concise summaries from PDF or Text files.
|
| 21 |
+
- **Quiz Generation**: Automatically create multiple-choice quizzes based on document content.
|
| 22 |
+
- **Intelligent Grading**: Submit quiz answers and get detailed explanations for errors.
|
| 23 |
+
- **Quick Actions**: One-click shortcuts for common tasks.
|
| 24 |
+
- **Persistent Storage**: Quizzes are saved locally to `quizzes_db.json`.
|
| 25 |
+
|
| 26 |
+
## π οΈ Setup
|
| 27 |
+
|
| 28 |
+
### 1. Requirements
|
| 29 |
+
Ensure you have Python 3.9+ installed.
|
| 30 |
+
|
| 31 |
+
### 2. Installation
|
| 32 |
+
Install the dependencies:
|
| 33 |
+
```bash
|
| 34 |
+
pip install -r requirements.txt
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
### 3. Environment Variables
|
| 38 |
+
1. Create a `.env` file from the example:
|
| 39 |
+
```bash
|
| 40 |
+
cp .env.example .env
|
| 41 |
+
```
|
| 42 |
+
2. Open `.env` and add your `OPENAI_API_KEY`.
|
| 43 |
+
|
| 44 |
+
## π Usage
|
| 45 |
+
|
| 46 |
+
Run the application:
|
| 47 |
+
```bash
|
| 48 |
+
python app.py
|
| 49 |
+
```
|
| 50 |
+
The interface will be available at `http://localhost:7860`.
|
| 51 |
+
|
| 52 |
+
## π Project Structure
|
| 53 |
+
|
| 54 |
+
- `app.py`: Main application and UI.
|
| 55 |
+
- `quizzes_db.json`: Local storage for generated quizzes.
|
| 56 |
+
- `requirements.txt`: Python dependencies.
|
| 57 |
+
- `.env`: Secret configuration (not included in version control).
|