AI-Study-Assistant / Read Me.txt
umerforsure's picture
πŸš€ Initial commit
c577877
# πŸ“š AI Study Assistant (Powered by Microsoft Phi-3)
Welcome to the **AI Study Assistant** β€” your personalized academic learning tool, built to help students understand complex course material with clarity, precision, and speed.
### πŸš€ What it does
- βœ… **Upload Study Material**: PDF, DOCX, TXT, or PPTX
- πŸ€– **Ask Questions**: About any concept in the uploaded files
- 🧠 **AI-Powered Reasoning**: Uses Microsoft’s Phi-3 (128k) to provide deep, structured, academic responses
- πŸ“Š **Retrieval-Augmented Generation**: Combines vector-based document search with LLMs
- πŸ“˜ **Context-Based Answers**: Doesn’t hallucinate β€” only uses what’s in your file
- ✨ **Auto-Summary**: Large answers are summarized into a short academic recap
---
### πŸŽ“ Who it's for
- Students revising for exams
- Professionals needing quick insights from documents
- Educators building tutoring tools
- Anyone learning from dense academic material
---
### πŸ›  How it works
1. **Upload** one or more lecture files (PDF, Word, PPT, TXT)
2. Ask a question like:
- *"Define supervised learning"*
- *"Explain the difference between classification and regression"*
3. The AI will:
- Extract your document
- Find the most relevant parts
- Think deeply using a powerful LLM
- Give a clean, well-structured, academic answer
---
### 🧠 Under the hood
| Component | Description |
|------------------|----------------------------------------------------------|
| **LLM** | `microsoft/phi-3-mini-128k-instruct` (4-bit CPU mode) |
| **Vector Search** | FAISS + HuggingFace MiniLM Embeddings |
| **Framework** | Gradio Interface via Hugging Face Spaces |
| **Auto Summary** | DistilBART summarization for long answers |
---
### πŸ”’ Privacy
This app does **not** store or log any of your uploaded files or questions. All processing happens in memory and is discarded after your session.
---
### πŸ’¬ Example Prompts
> - "List all types of memory in operating systems"
> - "What does this document say about reinforcement learning?"
> - "Explain deadlock prevention based on the slides"
---
### πŸ’‘ Inspiration
Built to replicate how a personal AI tutor should behave: focused, accurate, context-aware, and reliable β€” not a chatbot, but a **study partner**.
---
### πŸ§‘β€πŸ’» Built by
> Designed & developed by a student β€” for students β€” using only open-source models.
---
### πŸ“Ž Tags
`#Education` `#AI` `#Phi3` `#StudentTools` `#NLP` `#Gradio` `#DocumentQA` `#OpenSource`