diff --git a/README.md b/README.md index beda23ae..bb79a7da 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,16 @@ poetry install Run the benchmark: ```bash +$ poetry shell +$ python run.py --help + Usage: run.py [OPTIONS] - Example: python3 -m run --engines *-m-16-* --datasets glove-* + Examples: + + python3 run.py --engines "qdrant-rps-m-*-ef-*" --datasets "dbpedia-openai-100K-1536-angular" # Qdrant RPS mode + + python3 run.py --engines "*-m-*-ef-*" --datasets "glove-*" # All engines and their configs for glove datasets Options: --engines TEXT [default: *] diff --git a/run.py b/run.py index 518fbab6..5f112955 100644 --- a/run.py +++ b/run.py @@ -26,8 +26,11 @@ def run( skip_configure: Optional[bool] = False, ): """ - Example: - python3 run.py --engines "*-m-16-*" --engines "qdrant-*" --datasets "glove-*" + Examples: + + python3 run.py --engines "qdrant-rps-m-*-ef-*" --datasets "dbpedia-openai-100K-1536-angular" # Qdrant RPS mode + + python3 run.py --engines "*-m-*-ef-*" --datasets "glove-*" # All engines and their configs for glove datasets """ all_engines = read_engine_configs() all_datasets = read_dataset_config()