NeoTutor / README.md
Mrigank005's picture
Update README.md
b351531 verified
---
license: mit
base_model:
- meta-llama/Llama-3.2-3B-Instruct
pipeline_tag: text-generation
library_name: adapter-transformers
tags:
- langgraph
- educational
- tutor
- ai-tutor
- adaptive-learning
- text-generation
- llama3.2
---
# πŸ€– Enhanced AI Tutor System using LLaMA-3 and LangGraph
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Made with LangGraph](https://img.shields.io/badge/Built%20with-LangGraph-purple)](https://python.langgraph.dev/)
[![Model: Meta LLaMA 3.2](https://img.shields.io/badge/Model-Meta%20LLaMA%203.2%203B-blue)](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct)
An **adaptive, feedback-based AI tutor system** built using:
- 🧠 Meta's [LLaMA-3.2-3B-Instruct](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct)
- πŸ”„ [LangGraph](https://github.com/langchain-ai/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!
---
## πŸ“„ View Notebook in Colab
[![Open in Colab](https://img.shields.io/badge/Open%20in-Colab-yellow?logo=googlecolab&style=for-the-badge)](https://colab.research.google.com/drive/1X4QwSB48fddXATlJBYtab16l7TM72KZk?usp=sharing)
You can explore the full .ipynb notebook on Google Colab using the button above.
---
## πŸ“ 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](https://img.shields.io/badge/Model-Meta%20LLaMA%203.2%203B-blue)](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct)
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](https://img.shields.io/badge/GitHub-Mrigank005-181717?logo=github)](https://github.com/Mrigank005)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-Mrigank005-0077B5?logo=linkedin)](https://www.linkedin.com/in/mrigank005)
Feel free to raise issues or suggestions on GitHub
Or connect via Hugging Face community tab!
**Happy learning!** πŸ’‘
---