whatever enny
Browse files
README.md
CHANGED
|
@@ -1,10 +1,106 @@
|
|
| 1 |
---
|
| 2 |
license: cc-by-nc-4.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
language:
|
| 4 |
- en
|
| 5 |
-
|
| 6 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
library_name: peft
|
| 8 |
tags:
|
| 9 |
-
-
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: cc-by-nc-4.0
|
| 3 |
+
tags:
|
| 4 |
+
- text-generation
|
| 5 |
+
- study-assistant
|
| 6 |
+
- emotionally-intelligent
|
| 7 |
+
- casual-ai
|
| 8 |
+
inference: true
|
| 9 |
language:
|
| 10 |
- en
|
| 11 |
+
library_name: transformers
|
| 12 |
+
pipeline_tag: text-generation
|
| 13 |
+
widget:
|
| 14 |
+
- text: Can you help me study math?
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
|
| 18 |
+
---
|
| 19 |
+
base_model: microsoft/phi-2
|
| 20 |
library_name: peft
|
| 21 |
tags:
|
| 22 |
+
- study-assistant
|
| 23 |
+
- education
|
| 24 |
+
- phi-2
|
| 25 |
+
- fine-tuned
|
| 26 |
+
- emotional-intelligence
|
| 27 |
+
license: mit
|
| 28 |
+
inference: true
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
# Study Buddy AI v2.1
|
| 32 |
+
|
| 33 |
+
A fine-tuned version of Microsoft's Phi-2, trained to stay faithful to retrieved data and think in chains of thought. A study assistant that helps users learn deeply through conversation. Designed for real-time interaction inside a lightweight web app.
|
| 34 |
+
|
| 35 |
+
 <!-- Replace this with your logo when ready -->
|
| 36 |
+
|
| 37 |
+
## Model Details:
|
| 38 |
+
|
| 39 |
+
### Model Description
|
| 40 |
+
|
| 41 |
+
Study Buddy AI 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, reasoning, encouraging, and deeply helpful for academic subjects and personal growth.
|
| 42 |
+
|
| 43 |
+
### Features
|
| 44 |
+
|
| 45 |
+
- Friendly tone tailored for Gen Z and students
|
| 46 |
+
- Explains complex topics using simple language
|
| 47 |
+
- Emotionally intelligent responses — supportive and motivational
|
| 48 |
+
- Great for studying, reviewing, or breaking down hard concepts
|
| 49 |
+
|
| 50 |
+
### Use Cases
|
| 51 |
+
|
| 52 |
+
- Personal tutoring via chat
|
| 53 |
+
- Homework help and study review
|
| 54 |
+
- Emotional motivation during learning sessions
|
| 55 |
+
- Supplementing lessons with a relatable assistant
|
| 56 |
+
|
| 57 |
+
### Limitations
|
| 58 |
+
|
| 59 |
+
- Best used in short back-and-forths, not long essays
|
| 60 |
+
|
| 61 |
+
## Training & Fine-Tuning
|
| 62 |
+
|
| 63 |
+
- **Base model**: `microsoft/phi-2`
|
| 64 |
+
- **Fine-tuning method**: LoRA via the `peft` library
|
| 65 |
+
- **Custom dataset**: 3,000+ curated prompts focused on simplified teaching, multi-step thinking, and staying loyal to retrieved data.
|
| 66 |
+
- **Hosted via**: Hugging Face Inference Endpoints (GPU-backed)
|
| 67 |
+
|
| 68 |
+
## How It Works
|
| 69 |
+
|
| 70 |
+
Frontend ➝ Flask API ➝ Hugging Face Model ➝ Response ➝ KnowBetter Logic (to clean output)
|
| 71 |
+
|
| 72 |
+
Built to run inside a React + Flask stack with CORS enabled and token-secured backend access to Hugging Face.
|
| 73 |
+
|
| 74 |
+
## Model Creator
|
| 75 |
+
|
| 76 |
+
**Creator**: Micah Miles
|
| 77 |
+
**GitHub/Contact**: redmint-him
|
| 78 |
+
**Team**: Redmint
|
| 79 |
+
**Project**: Study Buddy AI
|
| 80 |
+
|
| 81 |
+
## License
|
| 82 |
+
|
| 83 |
+
This model is licensed under the **Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0)**.
|
| 84 |
+
|
| 85 |
+
You are free to:
|
| 86 |
+
- Use the model for **personal or educational purposes**
|
| 87 |
+
- Modify, remix, or build upon it
|
| 88 |
+
|
| 89 |
+
**You may not**:
|
| 90 |
+
- Sell, sublicense, or use the model or its outputs for any commercial purposes
|
| 91 |
+
|
| 92 |
+
© 2025 Micah Miles
|
| 93 |
+
|
| 94 |
+
## NOTICE
|
| 95 |
+
|
| 96 |
+
This model is licensed for **non-commercial use only**.
|
| 97 |
+
|
| 98 |
+
For commercial licensing or partnership inquiries, contact: micahmiles21@gmail.com
|
| 99 |
+
|
| 100 |
+
---
|
| 101 |
+
|
| 102 |
+
"IF YOU'RE READING THIS IT'S NOT TOO LATE."
|
| 103 |
+
|
| 104 |
+
"If man can, I can, You can, We can."
|
| 105 |
+
|
| 106 |
+
- MICAH MILES.
|