studybuddy-ai / README.md
redmint's picture
Update README.md
4271b75 verified
---
license: cc-by-nc-4.0
tags:
- text-generation
- study-assistant
- emotionally-intelligent
- casual-ai
inference: true
language:
- en
library_name: transformers
pipeline_tag: text-generation
widget:
- text: Can you help me study math?
---
---
base_model: microsoft/phi-2
library_name: peft
tags:
- study-assistant
- education
- phi-2
- fine-tuned
- emotional-intelligence
license: mit
inference: true
---
# Study Buddy AI (Lite)
A fine-tuned version of Microsoft's Phi-2, trained to act as a casual, emotionally intelligent study assistant that helps users learn deeply through conversation. Designed for real-time interaction inside a lightweight web app.
![Model Logo Placeholder](logo.png) <!-- Replace this with your logo when ready -->
## Model Details
### Model Description
Study Buddy AI Lite is built on `microsoft/phi-2` and fine-tuned using PEFT (Parameter-Efficient Fine-Tuning). It was trained to behave like a study partner β€” casual, kind, encouraging, and deeply helpful for academic subjects and personal growth.
### Features
- Friendly tone tailored for Gen Z and students
- Explains complex topics using simple language
- Emotionally intelligent responses β€” supportive and motivational
- Great for studying, reviewing, or breaking down hard concepts
### Use Cases
- Personal tutoring via chat
- Homework help and study review
- Emotional motivation during learning sessions
- Supplementing lessons with a relatable assistant
### Limitations
- May hallucinate and respond as user which you can cut out in frontend files
- Best used in short back-and-forths, not long essays
## Training & Fine-Tuning
- **Base model**: `microsoft/phi-2`
- **Fine-tuning method**: LoRA via the `peft` library
- **Custom dataset**: 3,000+ curated prompts focused on simplified teaching, emotional tone, and helpful behavior
- **Hosted via**: Hugging Face Inference Endpoints (GPU-backed)
## How It Works
Frontend ➝ Flask API ➝ Hugging Face Model ➝ Response ➝ KnowBetter Logic (to clean output)
Built to run inside a React + Flask stack with CORS enabled and token-secured backend access to Hugging Face.
## Model Creator
**Creator**: Micah Miles
**GitHub/Contact**: redmint-him
**Team**: Redmint
**Project**: Study Buddy Lite
## License
This model is licensed under the **Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0)**.
You are free to:
- Use the model for **personal or educational purposes**
- Modify, remix, or build upon it
**You may not**:
- Sell, sublicense, or use the model or its outputs for any commercial purposes
Β© 2025 Micah Miles
## NOTICE
This project is licensed for **non-commercial use only**.
For commercial licensing or partnership inquiries, contact: [email protected]
---
✨ β€œNever back down. Never give up.” β€” This is for every student who wanted to learn differently.
I'm just a kid with a dream.