study-buddy / README.md
prajvalitha's picture
Update README.md
7a7f65f verified
|
Raw
History Blame Contribute Delete
1.22 kB

A newer version of the Gradio SDK is available: 6.20.0

Upgrade
metadata
title: Study Buddy
emoji: πŸ“š
colorFrom: blue
colorTo: purple
sdk: gradio
sdk_version: 5.34.2
python_version: '3.11'
app_file: app.py
pinned: false

Study Buddy πŸ“š

AI-powered study assistant for B.Tech CSE students.

Overview

Study Buddy is an AI-powered learning assistant designed for B.Tech CSE students. It helps students learn concepts, generate revision notes, practice quizzes, and export study material as PDFs.

Features

  • Generate detailed study notes
  • Create quick revision notes
  • Generate AI-powered multiple-choice quizzes
  • Download notes as PDF
  • Track study history

AI Used

This project uses:

  • Hugging Face Inference API
  • Meta Llama 3.1 8B Instruct Model

Technologies Used

  • Python
  • Gradio
  • Hugging Face Hub
  • FPDF2
  • PyPDF

How to Run Locally

  1. Clone the repository
git clone <your-repository-link>
cd study-buddy
  1. Install dependencies
pip install -r requirements.txt
  1. Create a .env file
HF_TOKEN=your_huggingface_token
  1. Run the application
python app.py
  1. Open the local URL displayed in the terminal.

Deployment

The application is deployed on Hugging Face Spaces.

Author

S.Prajvalitha