Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
@@ -1,14 +1,119 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
12 |
---
|
13 |
|
14 |
-
|
|
|
1 |
+
# π EduTutor AI β Personalized Learning & Assessment System
|
2 |
+
|
3 |
+
EduTutor AI is an AI-powered personalized tutoring tool designed to generate custom quizzes and feedback based on a student's score and topic of interest.
|
4 |
+
|
5 |
+
Built using the powerful IBM Granite LLM and Gradio, this app enables intelligent learning and self-assessment.
|
6 |
+
|
7 |
+
[](https://huggingface.co/ibm-granite/granite-3.3-2b-instruct)
|
8 |
+
[](https://www.gradio.app/)
|
9 |
+
[](https://www.python.org/)
|
10 |
+
|
11 |
+
---
|
12 |
+
|
13 |
+
## π Live Demo
|
14 |
+
|
15 |
+
π [Click here to use EduTutor AI](https://huggingface.co/spaces/Anusha831/EduTutor-AI)
|
16 |
+
|
17 |
+
---
|
18 |
+
|
19 |
+
## π‘ Features
|
20 |
+
|
21 |
+
- π Topic-Based Quiz Generation: Enter any topic (e.g., Algebra, History, Physics) and get a set of tailored multiple-choice questions.
|
22 |
+
- π Score-Aware Feedback: Receive personalized feedback and learning tips based on your performance.
|
23 |
+
- π€ Powered by IBM Granite LLM: High-quality AI responses backed by a powerful open-source LLM.
|
24 |
+
- π§ No Coding Required: User-friendly interface with sliders and input boxes using Gradio.
|
25 |
+
- π Deploys on Hugging Face Spaces: Free, fast, and publicly accessible.
|
26 |
+
|
27 |
+
---
|
28 |
+
|
29 |
+
## π οΈ Technologies Used
|
30 |
+
|
31 |
+
- π§ IBM Granite 3.3 2B Instruct LLM (via Hugging Face)
|
32 |
+
- π Python
|
33 |
+
- ποΈ Gradio β For building interactive UI
|
34 |
+
- π Transformers by Hugging Face
|
35 |
+
- π» Google Colab & GitHub for development
|
36 |
+
|
37 |
---
|
38 |
+
|
39 |
+
## π· App Preview
|
40 |
+
|
41 |
+

|
42 |
+
|
43 |
+
---
|
44 |
+
|
45 |
+
## π¦ Installation & Setup (Optional for Local Use)
|
46 |
+
|
47 |
+
If you want to run it locally:
|
48 |
+
|
49 |
+
`bash
|
50 |
+
|
51 |
+
git clone https://github.com/Anusha-831/EduTutor-AI.git
|
52 |
+
|
53 |
+
cd EduTutor-AI
|
54 |
+
|
55 |
+
pip install -r requirements.txt
|
56 |
+
|
57 |
+
python app.py
|
58 |
+
|
59 |
+
---
|
60 |
+
|
61 |
+
## π― Submission for IBM InnovateX Hackathon 2025
|
62 |
+
|
63 |
+
This project was developed as part of the IBM InnovateX Hackathon 2025, showcasing the use of IBM Granite LLM for solving real-world educational challenges using AI.
|
64 |
+
|
65 |
+
π₯ **Team Name:** CodeCrafters
|
66 |
+
|
67 |
+
π©βπ» **Team Members:** Koyyada Anusha, Muddassir Shakhan
|
68 |
+
|
69 |
+
π **Initial Solution Submission:** As part of the hackathon requirements, we submitted a project proposal and functional overview. [View Submitted Solution](https://drive.google.com/file/d/12NDxLZR-52vAoWG8LvyqDe2P65nbdyws/view?usp=sharing)
|
70 |
+
|
71 |
+
We collaboratively developed this solution from idea to implementation to address the core goals of personalized learning and automated assessment.
|
72 |
+
|
73 |
+
---
|
74 |
+
|
75 |
+
## πββοΈ Developed By
|
76 |
+
|
77 |
+
### Koyyada Anusha
|
78 |
+
|
79 |
+
B.Tech - CSE (AI & ML) - Year: 2022-2026
|
80 |
+
|
81 |
+
Vaageswari College of Engineering - Roll No: 22S41A6693
|
82 |
+
|
83 |
+
GitHub: https://github.com/Anusha-831
|
84 |
+
|
85 |
+
LinkedIn: https://www.linkedin.com/in/anusha-koyyada-8b3032261
|
86 |
+
|
87 |
+
Email: koyyadaanusha05@gmail.com
|
88 |
+
|
89 |
+
### Muddassir Shakhan
|
90 |
+
|
91 |
+
B.Tech - CSE (AI & ML) - Year: 2022-2026
|
92 |
+
|
93 |
+
Vaageswari College of Engineering - Roll No: 22S41A66C0
|
94 |
+
|
95 |
+
GitHub: https://github.com/Muddassirshakhan
|
96 |
+
|
97 |
+
LinkedIn: https://www.linkedin.com/in/muddassir-shakhan-559740257
|
98 |
+
|
99 |
+
Email: muddassirshakhan8@gmail.com
|
100 |
+
|
101 |
+
---
|
102 |
+
|
103 |
+
## π License
|
104 |
+
|
105 |
+
This project is licensed under the MIT License. Feel free to use, modify, and share.
|
106 |
+
|
107 |
+
---
|
108 |
+
|
109 |
+
## βοΈ Acknowledgements
|
110 |
+
|
111 |
+
π€ **IBM Granite Models β** for the open-source LLM
|
112 |
+
|
113 |
+
π§ͺ **Gradio β** for building the UI effortlessly
|
114 |
+
|
115 |
+
π§ **Hugging Face β** for hosting the app
|
116 |
+
|
117 |
---
|
118 |
|
119 |
+
> βAI canβt replace teachers β but it can empower students.β
|