Skip to content

MdParwez/Studymate-AI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 

Repository files navigation

📚 StudyMate AI — RAG-based PDF Study Assistant

StudyMate AI is an interactive Retrieval-Augmented Generation (RAG) application built with Streamlit.
It allows students and researchers to upload PDFs, ask questions, get summaries, generate quizzes, and explore content interactively using Groq’s Gemma2-9B-IT LLM and ChromaDB.


🚀 Features

  • 📂 Upload one or multiple PDFs( Magic Fast Uploading with Batch Processing and Parallel File Processing)
  • 🔍 Semantic search using embeddings
  • 💡 Summarization & quiz generation from PDFs
  • 🧠 RAG-based conversational Q&A
  • Fast response using Groq API
  • 🎯 Supports sentence-transformers for embeddings
  • 🖥 Clean Streamlit frontend

📌 Workflow

1️⃣ Uploading the File

The user uploads one or more documents (PDF/TXT). Step 1 - Uploading Files


2️⃣ Successful Upload & Home Screen

After upload, a confirmation is displayed, and the user sees the home interface. Step 2 - Successful Upload


3️⃣ Q&A from the Document

Ask any question from the uploaded document, and get AI-generated answers. Step 3 - Q&A


4️⃣ Summarization with Key Notes

Get a concise summary along with important bullet points. Step 4 - Summarization


5️⃣ Quiz Generation

Generate quizzes from the uploaded content for self-assessment. Step 5 - Quiz


🖼 System Flowchart

Below is the complete workflow architecture:

Flowchart


🛠 Tech Stack

Component Technology
Frontend Streamlit
Language Model Groq - Gemma2-9B-IT
Vector Database ChromaDB
Embeddings Sentence-Transformers (HuggingFace)
PDF Parsing PyMuPDF
Environment Config python-dotenv

🧩 RAG Concept:

RAG (Retrieval-Augmented Generation) is a technique where the LLM retrieves relevant information from a vector store before generating a response.

Why use RAG here?

  • Keeps answers accurate to the uploaded PDFs
  • Reduces hallucinations from the LLM
  • Allows working with large documents without exceeding token limits

📊 Project Flow


---

## 📥 Installation

1. **Clone the repository**

```bash
git clone https://github.com/yourusername/studymate-ai.git
cd studymate-ai
  1. Create virtual environment
python -m venv .venv
source .venv/bin/activate  # (Linux/Mac)
.venv\Scripts\activate     # (Windows)
  1. Install dependencies
pip install -r requirements.txt
  1. Set environment variables Create a .env file:
GROQ_API_KEY=your_groq_api_key
EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2

▶️ Usage

Run the Streamlit app:

streamlit run app.py

About

AI app that will help you to study better

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages