@@ -108,10 +108,22 @@ Configuration is in `.clang-format` with these key rules:
108108- Reference alignment: ` int & ref ` (middle)
109109
110110### Python Code
111+ ** ALWAYS activate the Python environment in ` .venv ` and use tools from that environment:**
111112``` bash
112- flake8 --max-line-length=120 * .py
113+ # Activate virtual environment
114+ source .venv/bin/activate
115+
116+ # Use flake8 from the virtual environment
117+ flake8 * .py
118+
119+ # Use pyright from the virtual environment
120+ pyright
113121```
114122
123+ Configuration files:
124+ - ` .flake8 ` : flake8 settings (max-line-length=125, excludes examples/tools)
125+ - ` pyrightconfig.json ` : pyright type checking configuration
126+
115127### Pre-commit Hooks
116128Run before committing:
117129``` bash
@@ -150,6 +162,7 @@ Add `ggml-ci` to commit message to trigger heavy CI workloads on the custom CI i
150162- ** ` include/ ` ** : Public API headers, primarily ` include/llama.h `
151163- ** ` ggml/ ` ** : Core tensor library (submodule with custom GGML framework)
152164- ** ` examples/ ` ** : 30+ example applications and tools
165+ - ** ` tools/ ` ** : Additional development and utility tools (server benchmarks, tests)
153166- ** ` tests/ ` ** : Comprehensive test suite with CTest integration
154167- ** ` docs/ ` ** : Detailed documentation (build guides, API docs, etc.)
155168- ** ` scripts/ ` ** : Utility scripts for CI, data processing, and automation
@@ -212,6 +225,7 @@ Primary tools:
212225- CMake 3.14+ (install via system package manager)
213226- Modern C++ compiler with C++17 support
214227- Git (for submodule management)
228+ - Python 3.9+ with virtual environment (` .venv ` is provided)
215229
216230### Optional but Recommended
217231- ccache: ` apt install ccache ` or ` brew install ccache `
0 commit comments