Skip to content

Turn static PDFs into interactive study sessions. Chat with documents and generate AI quizzes to test your knowledge. Built with LangChain, Streamlit, and RAG.

Notifications You must be signed in to change notification settings

Muhamad-Shahan/StudyGenius-AI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŽ“ StudyGenius AI

Python Streamlit LangChain Hugging Face

StudyGenius is an intelligent, RAG-powered study assistant designed to transform static PDF documents into interactive learning sessions. Unlike standard PDF chat tools, StudyGenius features an active "Exam Simulator" mode that generates quizzes to test user retention.


πŸš€ Key Features

1. πŸ’¬ Context-Aware Chat

Chat with your document naturally. The AI uses Retrieval-Augmented Generation (RAG) to pull answers strictly from your uploaded PDF, ensuring accuracy and reducing hallucinations.

2. πŸ“ Exam Simulator (Quiz Mode)

Struggling to prepare for a test? Click one button, and the "Professor AI" agent will:

  • Analyze your document's key concepts.
  • Generate a 3-question Multiple Choice Quiz.
  • Provide the correct answers for self-assessment.

3. 🧠 Neural Search (FAISS)

Uses high-performance vector embeddings (all-MiniLM-L6-v2) to semantic search through hundreds of pages in milliseconds.


πŸ› οΈ Tech Stack

  • Frontend: Streamlit (Custom Dark Mode Theme)
  • Orchestration: LangChain (LCEL Architecture)
  • LLM: HuggingFaceH4/zephyr-7b-beta (via Hugging Face Inference API)
  • Vector Database: FAISS (Facebook AI Similarity Search)
  • Embeddings: Sentence-Transformers

βš™οΈ Installation & Local Setup

If you want to run this project on your own machine:

  1. Clone the Repository

    git clone [https://github.com/Muhammad-Shahan/StudyGenius-AI.git](https://github.com/Muhammad-Shahan/StudyGenius-AI.git)
    cd StudyGenius-AI
  2. Install Dependencies

    pip install -r requirements.txt
  3. Run the App

    streamlit run app.py

πŸ” Configuration

This app follows a BYOK (Bring Your Own Key) security model.

  1. Obtain a free API Token from Hugging Face.
  2. Enter it in the sidebar when prompted.
  3. Note: Your key is never stored; it is used only for the active session.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.


Built by [Muhammad Shahan]

About

Turn static PDFs into interactive study sessions. Chat with documents and generate AI quizzes to test your knowledge. Built with LangChain, Streamlit, and RAG.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages