Spaces:
Paused
Paused
|
Download README.md from MBG0903/KLE_MVP_Session: direct link, hf CLI and curl.
- Browser
- Download file 2.16 kB
-
https://huggingface.co/spaces/MBG0903/KLE_MVP_Session/resolve/main/README.md
- Command line
-
hf download hf://spaces/MBG0903/KLE_MVP_Session/README.md
-
curl -L -o README.md https://huggingface.co/spaces/MBG0903/KLE_MVP_Session/resolve/main/README.md
2.16 kB
| title: KLE Smart Study Companion | |
| emoji: π | |
| colorFrom: blue | |
| colorTo: indigo | |
| sdk: docker | |
| app_port: 7860 | |
| pinned: false | |
| # π KLE Smart Study Companion | |
| An AI-powered Minimum Viable Product designed to help college students plan, understand and revise their studies more effectively. | |
| ## π MVP Objective | |
| Students often face four common challenges: | |
| - They do not know how to organise their study schedule. | |
| - They forget study deadlines. | |
| - Some textbook concepts are difficult to understand. | |
| - They do not know which questions or concepts deserve more attention before an examination. | |
| The KLE Smart Study Companion demonstrates how Artificial Intelligence can help address these problems through one simple application. | |
| ## β¨ Features | |
| ### π Smart Study Planner | |
| Students enter: | |
| - Subject | |
| - Topics or chapters | |
| - Study start date | |
| - Examination date | |
| - Available study hours | |
| The application automatically creates a personalised study schedule. | |
| ### β° Study Reminders | |
| Students can track upcoming study activities and identify tasks that are: | |
| - Upcoming | |
| - Due tomorrow | |
| - Due today | |
| - Overdue | |
| - Completed | |
| The MVP displays reminders inside the application. | |
| Future versions could integrate: | |
| - Email reminders | |
| - WhatsApp notifications | |
| - Mobile notifications | |
| - Google Calendar | |
| ### π§ Simple Topic Explanation | |
| Students can paste: | |
| - Class notes | |
| - Chapters | |
| - Difficult concepts | |
| - Study material | |
| AI can then: | |
| - Summarise the material | |
| - Explain it for beginners | |
| - Extract revision points | |
| - Explain concepts using examples | |
| ### β Potential Exam Q&A | |
| The application analyses study material and generates potential questions and answers to help students identify concepts that deserve extra revision attention. | |
| ## π€ AI Model | |
| The MVP currently uses: | |
| `google/flan-t5-small` | |
| The model runs locally inside the Hugging Face Space. | |
| The model can later be replaced by a more powerful language model for production use. | |
| ## π Technology Stack | |
| - Python | |
| - Streamlit | |
| - Hugging Face Spaces | |
| - Hugging Face Transformers | |
| - FLAN-T5 | |
| - Pandas | |
| - PyTorch | |
| ## βΆοΈ Running Locally | |
| Install the dependencies: | |
| ```bash | |
| pip install -r requirements.txt |