Study Buddy LLM

Overview

Study Buddy LLM is an intelligent assistant designed to aid students by facilitating interactive sessions with videos and articles. Using Retrieval-Augmented Generation (RAG) techniques, this tool provides concise and accurate responses, streamlining the review and study process for students.

Installation

Prerequisites

Ensure you have Poetry and Python installed on your system.

Steps

1. Clone Repository:

   git clone https://github.com/bruna-calistrate/study-buddy-llm.git
   

2. Install Poetry:

   pip install poetry
   

3. Install dependencies:

   poetry install
   

4. Enter virtual environment:

   poetry shell
   

5. Run the streamlit server:

   task run
   

Environment Variables

To run this project you will need a Google Gemini API Key.

Usage

Once the Streamlit server is running, open your browser and navigate to the provided local address to start using Study Buddy LLM. Interact with the interface to chat with videos and articles, enhancing your study sessions.

Acknowledgments

Inspired by apify/chat-with-a-website .

For further questions or issues, please open an issue on the GitHub repository.