Repository navigation
Installation
Anjana Tiha edited this page Mar 28, 2026
·
3 revisions
Run the full stack with no Python setup required.
# 1. Clone the repo
git clone https://github.com/anjanatiha/Retrieval-Augmented-Generation-RAG-Agent.git
cd Retrieval-Augmented-Generation-RAG-Agent
# 2. Pull models (one-time, ~2.3 GB)
docker compose run --rm ollama ollama pull hf.co/CompendiumLabs/bge-base-en-v1.5-gguf
docker compose run --rm ollama ollama pull hf.co/bartowski/Llama-3.2-3B-Instruct-GGUF
# 3. Start
docker compose upOpen http://localhost:8501.
NVIDIA GPU:
docker compose -f docker-compose.yml -f docker-compose.gpu.yml up| Requirement | Version | Notes |
|---|---|---|
| Python | 3.11 | Exactly 3.11 — other versions are not tested |
| Ollama | Latest | Required to run local LLM and embedding models |
| RAM | 8 GB minimum | 16 GB recommended for comfortable performance |
| Disk | ~5 GB | For models and ChromaDB vector store |
Download and install Ollama from ollama.com/download.
Verify the installation:
ollama --versionRAG Agent uses two models: one for embeddings and one for language generation and reranking.
# Embedding model (BGE base English, ~270 MB)
ollama pull hf.co/CompendiumLabs/bge-base-en-v1.5-gguf
# Language model (LLaMA 3.2 3B Instruct, ~2 GB)
ollama pull hf.co/bartowski/Llama-3.2-3B-Instruct-GGUFThis step only needs to be done once. Models are cached locally by Ollama.
git clone https://github.com/anjanatiha/Retrieval-Augmented-Generation-RAG-Agent.git
cd Retrieval-Augmented-Generation-RAG-Agent
# Create a Python 3.11 virtual environment
python3.11 -m venv rag_env_311
# Activate the virtual environment
source rag_env_311/bin/activate # macOS / Linux
rag_env_311\Scripts\activate # Windows
# Install all dependencies
pip install -r requirements.txtImportant: Always activate the virtual environment (
source rag_env_311/bin/activate) before running any command. The system Python will not have the required packages.
Optional — development and evaluation tools:
# Pre-commit hooks (auto-lint before every commit)
pip install -e ".[dev]"
pre-commit install
# RAGAS evaluation
pip install -e ".[eval]"In a separate terminal window, start the Ollama server:
ollama serveLeave this terminal open while using RAG Agent.
# Web UI (recommended)
streamlit run app.py
# Terminal chatbot
python main.py
# Agent mode
python main.py --agent
# Benchmark evaluation
python main.py --benchmark
# RAGAS LLM-as-judge evaluation (requires: pip install -e ".[eval]")
python main.py --ragasOpen http://localhost:8501 for the web UI.
If everything is set up correctly:
- The Streamlit UI loads without errors at
http://localhost:8501 - The sidebar shows "0 chunks indexed" (no documents yet)
- Uploading a file or pasting a URL triggers indexing with no error messages
- Quick Start — add your first document and ask a question
- Supported File Types — what you can upload
- Troubleshooting — if something goes wrong