NeoTutor / README.md
Mrigank005's picture
Update README.md
dfa2f71 verified
|
raw
history blame
3.32 kB

πŸ€– Enhanced AI Tutor System using LLaMA-3 and LangGraph

License: MIT Made with LangGraph Model: Meta LLaMA 3.2

An adaptive, feedback-based AI tutor system built using:

  • 🧠 Meta's LLaMA-3.2-3B-Instruct
  • πŸ”„ LangGraph for multi-agent workflow
  • ⚑ Hugging Face Transformers (4-bit quantization for efficiency)
  • βœ… PyTorch, BitsandBytes, Accelerate for seamless GPU usage

πŸŽ“ What It Does

This notebook walks you through a complete interactive tutor session that:

  1. πŸ“š Asks a question from a topic you choose
  2. πŸ“ Evaluates your answer and gives structured feedback
  3. πŸ§ͺ Generates a new practice question
  4. πŸ“ˆ Tracks your progress and adapts difficulty

It's like having your own AI teacher, personalized to your learning!


πŸš€ Quickstart

πŸ”§ Requirements

Install required packages first:

pip install langgraph transformers accelerate bitsandbytes --quiet
pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118 --quiet
pip install huggingface_hub --quiet

πŸ”‘ Login to Hugging Face

from huggingface_hub import notebook_login
notebook_login()

πŸƒβ€β™‚οΈ Run the Notebook

  1. Launch the .ipynb in a Google Colab GPU runtime
  2. Follow the prompts
  3. Learn, improve, repeat πŸ”

πŸ“ Project Structure

β”œβ”€β”€ EnhancedTutorSystem.ipynb   
β”œβ”€β”€ README.md                   
β”œβ”€β”€ requirements.txt            

🧠 Model Info

This project uses (but does not rehost) Meta's official instruction-tuned model:

Model: Meta LLaMA 3.2

The model is loaded via transformers using 4-bit quantization (BitsAndBytes)

Note: You must agree to Meta's license to access the model.


🎯 Features

  • ✍️ Adaptive questions across difficulty levels
  • πŸ“Š Real-time performance tracking
  • πŸ€“ Intelligent feedback on every answer
  • πŸ’‘ LangGraph-powered multi-agent workflow
  • 🧡 Fully reproducible session history

πŸ”œ Coming Soon

  • 🌐 A Hugging Face Space with a user-friendly UI
  • πŸ“ Student progress export to PDF
  • 🎯 Topic-based quiz sessions
  • πŸ§ͺ Integration with LangChain for evaluation metrics

πŸ“„ License

This project is released under the MIT License.


πŸ™Œ Acknowledgments

  • 🧠 Meta AI for LLaMA-3
  • πŸ”„ LangGraph by LangChain
  • πŸ€— Hugging Face for open infrastructure

πŸ“¬ Contact / Feedback

GitHub LinkedIn

Feel free to raise issues or suggestions on GitHub
Or connect via Hugging Face community tab!

Happy learning! πŸ’‘