@@ -84,14 +84,14 @@ docker pull filipe958/vector-db-benchmark:latest
8484# Run with help
8585docker run --rm filipe958/vector-db-benchmark:latest run.py --help
8686
87- # Basic Redis benchmark with local Redis
88- docker run --rm --network=host filipe958/vector-db-benchmark:latest \
89- run.py --host localhost --engines redis --dataset random-100 --experiment redis-default-simple
90-
91- # With results output (mount current directory)
87+ # Basic Redis benchmark with local Redis (recommended)
9288docker run --rm -v $( pwd) /results:/app/results --network=host \
9389 filipe958/vector-db-benchmark:latest \
94- run.py --host localhost --engines redis --dataset random-100 --experiment redis-default-simple
90+ run.py --host localhost --engines redis-default-simple --dataset random-100
91+
92+ # Without results output
93+ docker run --rm --network=host filipe958/vector-db-benchmark:latest \
94+ run.py --host localhost --engines redis-default-simple --dataset random-100
9595```
9696
9797### Using with Redis
@@ -103,11 +103,12 @@ For testing with Redis, start a Redis container first:
103103docker run -d --name redis-test -p 6379:6379 redis:8.2-rc1-bookworm
104104
105105# Run benchmark against Redis
106- docker run --rm --network=host filipe958/vector-db-benchmark:latest \
107- run.py --host localhost --engines redis --dataset random-100 --experiment redis-default-simple
106+ docker run --rm -v $( pwd) /results:/app/results --network=host \
107+ filipe958/vector-db-benchmark:latest \
108+ run.py --host localhost --engines redis-default-simple --dataset random-100
108109
109110# Or use the convenience script
110- ./docker-run.sh -H localhost -e redis -d random-100 -x redis-default-simple
111+ ./docker-run.sh -H localhost -e redis-default-simple -d random-100
111112
112113# Clean up Redis container when done
113114docker stop redis-test && docker rm redis-test
@@ -149,20 +150,18 @@ poetry install
149150Run the benchmark:
150151
151152``` bash
152- Usage: run.py [OPTIONS]
153-
154- Example: python3 -m run --engines * -m-16-* --datasets glove-*
155-
156- Options:
157- --engines TEXT [default: * ]
158- --datasets TEXT [default: * ]
159- --host TEXT [default: localhost]
160- --skip-upload / --no-skip-upload
161- [default: no-skip-upload]
162- --install-completion Install completion for the current shell.
163- --show-completion Show completion for the current shell, to
164- copy it or customize the installation.
165- --help Show this message and exit.
153+ # Basic usage examples
154+ python run.py --engines redis-default-simple --dataset random-100
155+ python run.py --engines redis-default-simple --dataset glove-25-angular
156+ python run.py --engines " *-m-16-*" --dataset " glove-*"
157+
158+ # Docker usage (recommended)
159+ docker run --rm -v $( pwd) /results:/app/results --network=host \
160+ filipe958/vector-db-benchmark:latest \
161+ run.py --host localhost --engines redis-default-simple --dataset random-100
162+
163+ # Get help
164+ python run.py --help
166165```
167166
168167Command allows you to specify wildcards for engines and datasets.
0 commit comments