CoolFace
Apppublic

haiderijaz/EduGenie-AI-Academic-Assistant

sourceHugging Facemitupdated 11mo agoView on Hugging Face
2likes
App README

๐Ÿง  EduGenie โ€“ AI Academic Assistant

EduGenie helps students and teachers generate educational content with AI โ€” summaries, quizzes, lesson plans, diagrams, and explanations from PDFs, audio, images, or typed text.


โœจ Features

  • โ€”๐Ÿ“„ Accepts input from:
  • โ€”Typed academic content
  • โ€”PDF textbooks
  • โ€”Scanned diagrams (OCR)
  • โ€”Voice recordings (speech-to-text)
  • โ€”๐ŸŽฏ Generates:
  • โ€”๐Ÿ“˜ Summaries
  • โ€”๐Ÿง  Explanations
  • โ€”๐Ÿ“ Quizzes (MCQs, True/False, Fill in the Blank)
  • โ€”๐Ÿ“… Lesson Plans (with class/grade)
  • โ€”๐Ÿ–ผ๏ธ Mermaid.js Diagrams
  • โ€”๐ŸŒ Supports output in multiple languages (e.g., English, Urdu, Arabic)
  • โ€”๐Ÿ“š Bloomโ€™s Taxonomy quiz level detection and customization
  • โ€”๐Ÿ”Š Text-to-Speech playback of generated output
  • โ€”๐Ÿง  Built-in RAG (Retrieval-Augmented Generation) for file-specific Q&A
  • โ€”๐Ÿ“ค Export results as .txt or .pdf files

๐Ÿ“ฆ Directory Structure

EduGenie/
โ”œโ”€โ”€ app.py
โ”œโ”€โ”€ requirements.txt
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ style.css
โ”œโ”€โ”€ static/
โ”‚   โ””โ”€โ”€ index.html
โ””โ”€โ”€ utils/
    โ”œโ”€โ”€ bloom_detector.py
    โ”œโ”€โ”€ diagram_ocr.py
    โ”œโ”€โ”€ export_tools.py
    โ”œโ”€โ”€ llm_client.py
    โ”œโ”€โ”€ pdf_handler.py
    โ”œโ”€โ”€ prompt_builder.py
    โ”œโ”€โ”€ rag_client.py
    โ”œโ”€โ”€ text_to_speech.py
    โ””โ”€โ”€ voice_to_text.py

๐Ÿš€ Run Locally

bash
git clone https://huggingface.co/spaces/your-username/EduGenie
cd EduGenie
pip install -r requirements.txt
python app.py

๐Ÿง  Technologies Used


๐Ÿ”– License

MIT License โ€“ free to use and modify for educational purposes.