Skip to content

Improve README docs and examples #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 30, 2025
Merged

Improve README docs and examples #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: *]
Expand Down
7 changes: 5 additions & 2 deletions run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
Loading