Makefile

# =============================================================================
# Production RAG Answering API
# =============================================================================
# Build, run, and manage the RAG answering system in Docker containers.
# =============================================================================

.PHONY: build up down notebook prepare-data index query evaluate test lint format gpu-check logs clean help

# Default target
.DEFAULT_GOAL := help

# ---------------------------------------------------------------------------
# Docker
# ---------------------------------------------------------------------------

## Build all Docker images
build:
	docker compose build

## Start all services (FastAPI, Qdrant, Phoenix, Notebook)
up:
	docker compose up -d

## Stop all services
down:
	docker compose down

## View logs for all services
logs:
	docker compose logs -f

## Remove all containers, volumes, and images
clean:
	docker compose down -v --rmi local

# ---------------------------------------------------------------------------
# Notebook
# ---------------------------------------------------------------------------

## Open JupyterLab (starts if not running)
notebook:
	@echo "Starting JupyterLab..."
	@docker compose up -d notebook
	@echo "JupyterLab is available at: http://localhost:8888"

# ---------------------------------------------------------------------------
# Data & Indexing
# ---------------------------------------------------------------------------

## Download and prepare SciFact data
prepare-data:
	docker compose exec app python -m scripts.prepare_data

## Build embeddings and index documents into Qdrant
index:
	docker compose exec app python -m scripts.index_corpus

# ---------------------------------------------------------------------------
# Query & Evaluate
# ---------------------------------------------------------------------------

## Run a sample query against the API
query:
	docker compose exec app python -m scripts.run_query

## Run answering evaluation on SciFact subset
evaluate:
	docker compose exec app python -m scripts.evaluate_answers

# ---------------------------------------------------------------------------
# Testing & Quality
# ---------------------------------------------------------------------------

## Run pytest test suite
test:
	docker compose exec app pytest tests/ -v --tb=short

## Run Ruff linting
lint:
	docker compose exec app ruff check src/ tests/ scripts/

## Format codebase with Ruff
format:
	docker compose exec app ruff format src/ tests/ scripts/

# ---------------------------------------------------------------------------
# GPU
# ---------------------------------------------------------------------------

## Verify GPU access inside Docker container
gpu-check:
	@echo "=== nvidia-smi ==="
	docker compose exec app nvidia-smi
	@echo ""
	@echo "=== PyTorch CUDA Check ==="
	docker compose exec app python -c "import torch; print('PyTorch version:', torch.__version__); print('CUDA available:', torch.cuda.is_available()); print('GPU:', torch.cuda.get_device_name(0) if torch.cuda.is_available() else 'N/A'); print('VRAM:', f\"{torch.cuda.get_device_properties(0).total_memory / 1024**3:.1f} GB\" if torch.cuda.is_available() else 'N/A')"

# ---------------------------------------------------------------------------
# Help
# ---------------------------------------------------------------------------

## Show this help message
help:
	@echo "Production RAG Answering API — Available Commands"
	@echo "================================================="
	@echo ""
	@echo "Docker:"
	@echo "  make build          Build all Docker images"
	@echo "  make up             Start all services"
	@echo "  make down           Stop all services"
	@echo "  make logs           View service logs"
	@echo "  make clean          Remove containers, volumes, images"
	@echo ""
	@echo "Notebook:"
	@echo "  make notebook       Open JupyterLab"
	@echo ""
	@echo "Data & Indexing:"
	@echo "  make prepare-data   Download and prepare SciFact data"
	@echo "  make index          Build embeddings and index into Qdrant"
	@echo ""
	@echo "Query & Evaluate:"
	@echo "  make query          Run a sample query"
	@echo "  make evaluate       Run answering evaluation"
	@echo ""
	@echo "Testing & Quality:"
	@echo "  make test           Run pytest"
	@echo "  make lint           Run Ruff linting"
	@echo "  make format         Format code with Ruff"
	@echo ""
	@echo "GPU:"
	@echo "  make gpu-check      Verify GPU access inside Docker"