AneelaFatima commited on
Commit
4f67d2d
·
verified ·
1 Parent(s): ffa05ff

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -15
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
- # 🎓 AI Learning Tutor For Computer Science Students
 
12
 
13
- Lightweight CS/SE tutor. No GPU needed.
14
 
15
  ## Features
16
- - Step-by-step **Explanation** (Markdown)
17
- - Curated **Extra Resources**
18
- - Practical **Roadmap**
19
- - 5-question **Quiz** with radio options + scoring
20
-
21
- ## Secrets (Settings Repository secrets)
22
- - `GROQ_API_KEY` (required)
23
- - Optional: `GROQ_MODEL` (default: `llama-3.3-70b-versatile`)
24
-
25
- ## Run locally
26
- ```bash
27
- pip install -r requirements.txt
28
- python app.py
 
 
 
 
 
 
 
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