CourseMate AI 🎓

Your Intelligent RAG-powered Research & Study Partner

CourseMate AI is a state-of-the-art Retrieval-Augmented Generation (RAG) application designed to turn static textbooks and research papers into interactive conversation partners. Unlike standard AI, CourseMate AI reads your specific documents to provide answers that are grounded, accurate, and cited.

🚀 Key Features

• Instant PDF Interaction: Upload any book or research paper directly through the web interface.
• On-the-Fly Indexing: Automatically handles chunking and embedding upon upload—no manual database scripts required.
• Smart Context Retrieval: Combines MMR (Maximal Marginal Relevance) for diverse context and Multi-Query Retrieval to handle complex student questions.
• Privacy First: Embeddings are generated locally on your CPU using sentence-transformers—your data stays yours.
• Turbo-Charged Responses: Powered by Groq LPU technology, delivering Llama-3 responses in milliseconds.

🛠️ Tech Stack

• UI Framework: Streamlit
• Orchestration: LangChain
• Inference Engine: Groq Cloud (Llama 3.3 70B)
• Vector Database: ChromaDB
• Embeddings: HuggingFace (all-MiniLM-L6-v2)

📁 Project Structure

CourseMate AI/
├── app.py              # Main Streamlit Web Application
├── .env                # API Keys (GROQ_API_KEY)
├── requirements.txt    # Project dependencies
└── README.md           # Project documentation

⚙️ Setup Instructions

• 1. Clone the repository

git clone [https://github.com/your-username/CourseMate-AI.git](https://github.com/your-username/CourseMate-AI.git)
cd "CourseMate AI"

• 2. Create a Virtual Environment

python -m venv .venv

On Windows:

.\.venv\Scripts\activate

On Mac/Linux:

source .venv/bin/activate

• 3. Install Dependencies

pip install -r requirements.txt

• 4. Configure Environment Variables

• Create a .env file in the root directory and add your Groq API Key:

Code snippet GROQ_API_KEY=your_groq_api_key_here

🖥️ Usage

Simply launch the web server from your terminal:

streamlit run app.py Upload: Use the sidebar to upload your PDF textbook or research paper.

Process: Click "Process Document" to index the text into the temporary vector store.

Chat: Ask questions like "Explain the methodology used in this paper" or "Summarize the core findings."

Verify: Expand the "Show Sources" section to see exactly which parts of the book the AI referenced.

📝 License

Distributed under the MIT License. Created by Zaryab Ahmad Khan.