Update README.md
Browse files
README.md
CHANGED
|
@@ -7,22 +7,30 @@ colorFrom: gray
|
|
| 7 |
colorTo: red
|
| 8 |
thumbnail: >-
|
| 9 |
https://cdn-uploads.huggingface.co/production/uploads/68668dfd4357f5b535fd7bdc/HhR3xv58d3TUca9PBpZWS.png
|
|
|
|
| 10 |
---
|
| 11 |
-
|
|
|
|
| 12 |
|
| 13 |
-
|
| 14 |
|
| 15 |
## Features
|
| 16 |
-
|
| 17 |
-
-
|
| 18 |
-
-
|
| 19 |
-
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
colorTo: red
|
| 8 |
thumbnail: >-
|
| 9 |
https://cdn-uploads.huggingface.co/production/uploads/68668dfd4357f5b535fd7bdc/HhR3xv58d3TUca9PBpZWS.png
|
| 10 |
+
sdk_version: 5.43.1
|
| 11 |
---
|
| 12 |
+
---
|
| 13 |
+
# AI Friendly Study Tutor
|
| 14 |
|
| 15 |
+
A student-friendly AI tutor built with the Groq API and Gradio. Select a subject, topic, language, and level. Then generate a clear explanation, curated resources, a structured roadmap, and a short quiz. Finish by evaluating your answers to see your score and feedback.
|
| 16 |
|
| 17 |
## Features
|
| 18 |
+
|
| 19 |
+
- **Generate Explanation**: Step-by-step explanation of the topic.
|
| 20 |
+
- **Generate Resources**: At least 3 recommended links (articles, videos, docs) with a short reason.
|
| 21 |
+
- **Generate Roadmap**: A structured learning path with stages, estimated effort, and outcomes.
|
| 22 |
+
- **Generate Quiz**: 3–5 multiple-choice questions with radio-button options (one correct answer).
|
| 23 |
+
- **Display Results**: Evaluates your selected answers and returns a score with brief feedback.
|
| 24 |
+
|
| 25 |
+
## Tech
|
| 26 |
+
|
| 27 |
+
- **Frontend/Backend**: [Gradio]
|
| 28 |
+
- **Model Runtime**: [Groq API] using `llama-3.1-8b-instant`
|
| 29 |
+
|
| 30 |
+
## Run Locally
|
| 31 |
+
|
| 32 |
+
1. **Create a virtual environment (optional)**
|
| 33 |
+
|
| 34 |
+
```bash
|
| 35 |
+
python -m venv .venv
|
| 36 |
+
source .venv/bin/activate # Windows: .venv\Scripts\activate
|