RAG-101

Quick guide to run this project.

Prerequisites

• Python 3.10+
• pip
• uv - if you want to solely use uv

1) Clone and open the project

git clone <your-repo-url>

2) Create and activate a virtual environment

Windows (PowerShell)

python -m venv .venv
.venv\Scripts\Activate.ps1

macOS/Linux

python -m venv .venv
source .venv/bin/activate

3) Install dependencies

Option A: Using pip

pip install -r requirements.txt

Option B: Using uv

uv pip install -r requirements.txt

4) Configure environment variables

Create a .env file at the root level of the project (same level as this README.md) and add:

OPENAI_API_KEY=your_openai_api_key_here

5) Run the project

There are a total of 5 jupyter-notebooks, run each individually in the sequence of there naming.

Approach Diagram

There is a picture in notes to understand the approach. Example reference:

notes/rag_notes.png

If the filename differs, open the image in the docs/ folder.