AptlyDigital commited on
Commit
3a73492
·
verified ·
1 Parent(s): 564470d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -32
README.md CHANGED
@@ -1,36 +1,16 @@
1
- ---
2
- license: mit
3
- title: AI Learning Tutor For Computer Science Students
4
- sdk: gradio
5
- emoji: 📈
6
- colorFrom: gray
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
 
1
+ # 🇹🇹 AI SEA Exam Tutor
 
 
 
 
 
 
 
 
 
 
 
 
2
 
3
+ **Secondary Entrance Assessment (SEA) Preparation Assistant**
4
 
5
+ ## 🎯 Overview
6
+ An AI-powered tutor for Trinidad and Tobago SEA exam preparation, featuring:
7
+ - **PDF upload** for past paper analysis
8
+ - **RAG-enhanced** question generation
9
+ - **UI-based API key entry** (no command line setup)
10
+ - **SEA-aligned** Mathematics and English content
11
 
12
+ ## 🚀 Quick Start
 
 
 
 
13
 
14
+ ### 1. Install Dependencies
15
+ ```bash
16
+ pip install -r requirements.txt