CLAUDE.md

1# Project Configuration
2 
3## Project Overview
4- Project name: RAGlens
5- Goal: Implement different RAG techniques and evaluate results using curated evaluation datasets
6 
7## Project Structure
8- Package manager: `uv`; add dependencies via `uv add` or `uv pip install`
9- Codebase location: `src/` folder
10- Unit tests location: `tests/` folder; execute with `pytest`
11- Specifications and LLM indexes: `memory/` folder
12 
13## Code Style Rules
14- Avoid code duplication; reuse existing functions/methods where possible
15- Minimize wrappers for classes/methods; use them only when necessary; prefer library classes/methods
16- Follow PEP 8 Python Style Guide
17- Apply clean code principles; organize code in modules for separated functionality that can evolve
18- Use descriptive variable names (e.g., `question` instead of `q`; `answers_count` instead of `cnt`)
19- Never print keys or secrets (e.g., API keys, authorization secrets) to logs or console
20- Configuration values as single source of truth; avoid function argument defaults for config values
21- Create new classes/functions in matching modules; create new modules if none exist
22- Always use `parse_model_id` from `src/raglens/utils.py` to split provider/model identifiers, as model names may contain '/' characters
23 
24## Project Specification
25- Use `memory/` folder for implementation specs and LLM indexes as reference for tasks
26- Update `memory/` after changes
27- Maintain minimal architecture changes in `memory/` for LLM guidance; full documentation in `docs/`
28 
29### LLM Indexes
30- Location: `memory/llms/` (mirrors `src/` structure)
31- Scope: One `llms.txt` per folder
32- Purpose: Lightweight index of modules/source files (not full documentation)
33- Format per `llms.txt`:
34  - First line: `# Location: <src path>`
35  - Headers: `##` (e.g., `## Modules:`, `## Source files:`)
36  - List modules only if folder contains modules/submodules
37  - Bullet points: `*` for items
38- Access: Open `memory/llms/<scope>/llms.txt` (e.g., `memory/llms/core/llms.txt` or `memory/llms/llms.txt` for repo-level)
39