readme
Browse files
README.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
| 1 |
-
# 📘 EduMate AI — Your Academic Companion
|
| 2 |
---
|
| 3 |
title: EduMate AI
|
| 4 |
emoji: 🎓
|
|
@@ -9,43 +8,46 @@ app_file: app.py
|
|
| 9 |
pinned: false
|
| 10 |
---
|
| 11 |
|
|
|
|
| 12 |
|
| 13 |
EduMate AI is an all-in-one academic assistant built with Gradio and powerful language models (via Groq LLaMA 3). It supports:
|
| 14 |
|
| 15 |
-
- 📚 AI Chatbot for homework help
|
| 16 |
-
- 📝 Smart Note Generator
|
| 17 |
-
- 🌐 Real-Time Translator + Voice (Edge TTS)
|
| 18 |
-
- 🎤 Text-to-Speech with multiple characters
|
| 19 |
-
- 🔐 Login, Signup, OTP, and Password Reset
|
| 20 |
-
- 💬 Chat History with Delete option
|
| 21 |
-
- 📄 PDF Export for Notes
|
| 22 |
|
| 23 |
---
|
| 24 |
|
| 25 |
## 🚀 Features
|
| 26 |
|
| 27 |
-
- ✍️ **Chatbot** — Ask academic questions & get relevant answers
|
| 28 |
-
- 📄 **Notes Generator** — Create neat bullet-point academic notes
|
| 29 |
-
- 🗣️ **Translate & Speak** — Translate text + hear it in different voices
|
| 30 |
-
- 🧠 **TTS Characters** — Multiple speaking voices across languages
|
| 31 |
-
- 🔒 **Auth System** — Email OTP, signup/login, and forgot password
|
| 32 |
-
- 🧾 **Chat History** — Saves and replays chats per user
|
| 33 |
-
- 📤 **Export PDF** — Export notes directly as a PDF
|
| 34 |
|
| 35 |
---
|
| 36 |
|
| 37 |
## 🔧 Tech Stack
|
| 38 |
|
| 39 |
-
- `Gradio` for UI and backend routing
|
| 40 |
-
- `Groq` + `transformers` for LLM chat/note generation
|
| 41 |
-
- `edge-tts` + `deep-translator` for voice + translation
|
| 42 |
-
- `SQLite` + `bcrypt` for user auth
|
| 43 |
-
- `reportlab` for PDF export
|
| 44 |
|
| 45 |
---
|
| 46 |
|
| 47 |
## 📦 Setup (Locally)
|
| 48 |
|
| 49 |
```bash
|
|
|
|
|
|
|
| 50 |
pip install -r requirements.txt
|
| 51 |
python app.py
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
title: EduMate AI
|
| 3 |
emoji: 🎓
|
|
|
|
| 8 |
pinned: false
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# 📘 EduMate AI — Your Academic Companion
|
| 12 |
|
| 13 |
EduMate AI is an all-in-one academic assistant built with Gradio and powerful language models (via Groq LLaMA 3). It supports:
|
| 14 |
|
| 15 |
+
- 📚 AI Chatbot for homework help
|
| 16 |
+
- 📝 Smart Note Generator
|
| 17 |
+
- 🌐 Real-Time Translator + Voice (Edge TTS)
|
| 18 |
+
- 🎤 Text-to-Speech with multiple characters
|
| 19 |
+
- 🔐 Login, Signup, OTP, and Password Reset
|
| 20 |
+
- 💬 Chat History with Delete option
|
| 21 |
+
- 📄 PDF Export for Notes
|
| 22 |
|
| 23 |
---
|
| 24 |
|
| 25 |
## 🚀 Features
|
| 26 |
|
| 27 |
+
- ✍️ **Chatbot** — Ask academic questions & get relevant answers
|
| 28 |
+
- 📄 **Notes Generator** — Create neat bullet-point academic notes
|
| 29 |
+
- 🗣️ **Translate & Speak** — Translate text + hear it in different voices
|
| 30 |
+
- 🧠 **TTS Characters** — Multiple speaking voices across languages
|
| 31 |
+
- 🔒 **Auth System** — Email OTP, signup/login, and forgot password
|
| 32 |
+
- 🧾 **Chat History** — Saves and replays chats per user
|
| 33 |
+
- 📤 **Export PDF** — Export notes directly as a PDF
|
| 34 |
|
| 35 |
---
|
| 36 |
|
| 37 |
## 🔧 Tech Stack
|
| 38 |
|
| 39 |
+
- `Gradio` for UI and backend routing
|
| 40 |
+
- `Groq` + `transformers` for LLM chat/note generation
|
| 41 |
+
- `edge-tts` + `deep-translator` for voice + translation
|
| 42 |
+
- `SQLite` + `bcrypt` for user auth
|
| 43 |
+
- `reportlab` for PDF export
|
| 44 |
|
| 45 |
---
|
| 46 |
|
| 47 |
## 📦 Setup (Locally)
|
| 48 |
|
| 49 |
```bash
|
| 50 |
+
git clone https://huggingface.co/spaces/your-username/edumate-ai
|
| 51 |
+
cd edumate-ai
|
| 52 |
pip install -r requirements.txt
|
| 53 |
python app.py
|