Skip to content

Commit 1ae9ca7

Browse files
authored
Improve README docs and examples (#217)
1 parent ce8fe71 commit 1ae9ca7

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,16 @@ poetry install
4646
Run the benchmark:
4747

4848
```bash
49+
$ poetry shell
50+
$ python run.py --help
51+
4952
Usage: run.py [OPTIONS]
5053

51-
Example: python3 -m run --engines *-m-16-* --datasets glove-*
54+
Examples:
55+
56+
python3 run.py --engines "qdrant-rps-m-*-ef-*" --datasets "dbpedia-openai-100K-1536-angular" # Qdrant RPS mode
57+
58+
python3 run.py --engines "*-m-*-ef-*" --datasets "glove-*" # All engines and their configs for glove datasets
5259

5360
Options:
5461
--engines TEXT [default: *]

run.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,11 @@ def run(
2626
skip_configure: Optional[bool] = False,
2727
):
2828
"""
29-
Example:
30-
python3 run.py --engines "*-m-16-*" --engines "qdrant-*" --datasets "glove-*"
29+
Examples:
30+
31+
python3 run.py --engines "qdrant-rps-m-*-ef-*" --datasets "dbpedia-openai-100K-1536-angular" # Qdrant RPS mode
32+
33+
python3 run.py --engines "*-m-*-ef-*" --datasets "glove-*" # All engines and their configs for glove datasets
3134
"""
3235
all_engines = read_engine_configs()
3336
all_datasets = read_dataset_config()

0 commit comments

Comments
 (0)