Skip to content

Commit e19f59b

Browse files
committed
docs(README): add benchmarks section with configuration details
- Introduced a new section for benchmarks in the README. - Provided instructions to run and configure benchmarks. - Included details on dataset sizes, embedding dimensions, distance metrics, and database modes.
1 parent 80a8c80 commit e19f59b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,21 @@ mypy sqlite_vec_client/
197197
ruff check . && ruff format . && mypy sqlite_vec_client/ && pytest
198198
```
199199

200+
### Benchmarks
201+
202+
**Run benchmarks:**
203+
```bash
204+
python -m benchmarks
205+
```
206+
207+
**Configure benchmarks:**
208+
Edit [benchmarks/config.yaml](benchmarks/config.yaml) to customize:
209+
- Dataset sizes (default: 100, 1000, 10000, 50000)
210+
- Embedding dimension (default: 384)
211+
- Distance metric (default: cosine)
212+
- Database modes (file, memory)
213+
- Similarity search iterations and top-k values
214+
200215
## Documentation
201216

202217
- [CONTRIBUTING.md](CONTRIBUTING.md) - Contribution guidelines
@@ -205,6 +220,8 @@ ruff check . && ruff format . && mypy sqlite_vec_client/ && pytest
205220
- [Examples](examples/) - Usage examples
206221
- [basic_usage.py](examples/basic_usage.py) - Basic CRUD operations
207222
- [logging_example.py](examples/logging_example.py) - Logging configuration
223+
- [batch_operations.py](examples/batch_operations.py) - Bulk operations
224+
- [Benchmarks](benchmarks/) - Performance benchmarks
208225

209226
## Contributing
210227

0 commit comments

Comments
 (0)