This tool allows you to benchmark and compare the performance of vector databases with current support for Milvus and others planned.
- Clone the repository:
git clone https://github.com/yourusername/vdb-bench.git
cd vdb-bench- Build and run the Docker container:
docker-compose up -d- Clone the repository:
git clone https://github.com/yourusername/vdb-bench.git
cd vdb-bench- Install the package:
pip3 install ./The docker-compose.yml file will configure a 3-container instance of Milvus database.
- Milvus Database
- Minio Object Storage
- etcd
The docker-compose.yml file uses /mnt/vdb as the root directory for the required docker volumes. You can modify the compose file for your environment or ensure that your target storage is mounted at this location.
For testing more than one storage solution, there are two methods:
- Create a set of containers for each storage solution with modified docker-compose.yml files pointing to different root directories. Each set of containers will also need a different port to listen on. You may need to limit how many instances you can run depending on the available memory in your system
- Bring down the containers, copy the /mnt/vdb data to another location, change the mount point to point to the new locaiton. Bring the containers back up. This is simpler as the database connection isn't changing but you need to manually reconfigure the storage to change the system under test.
cd ./vd-bench
docker compose up # with docker-compose-v2. v1 uses docker-compose upUse the -d option to detach from the containers after starting them. Without this option you will be attached to the log output of the set of containers and ctrl+c will stop the containers.
If you have connection problems with a proxy I recommend this link: https://medium.com/@SrvZ/docker-proxy-and-my-struggles-a4fd6de21861
The benchmark process consists of three main steps:
- Loading vectors into the database
- Monitoring and compacting the database
- Running the benchmark queries
Use the load_vdb.py script to generate and load 10 million vectors into your vector database: (this process can take up to 8 hours)
python load_vdb.py --config configs/10m.yamlFor testing, I recommend using a smaller data by passing the num_vectors option:
python load_vdb.py --config configs/10m.yaml --collection-name mlps_500k_10shards_1536dim_uniform --num-vectors 500000Key parameters:
- --collection-name: Name of the collection to create
- --dimension: Vector dimension
- --num-vectors: Number of vectors to generate
- --chunk-size: Number of vectors to generate in each chunk (for memory management)
- --distribution: Distribution for vector generation (uniform, normal)
- --batch-size: Batch size for insertion
Example configuration file (configs/10m.yaml):
database:
host: 127.0.0.1
port: 19530
database: milvus
max_receive_message_length: 514_983_574
max_send_message_length: 514_983_574
dataset:
collection_name: mlps_10m_10shards_1536dim_uniform
num_vectors: 10_000_000
dimension: 1536
distribution: uniform
batch_size: 1000
num_shards: 10
vector_dtype: FLOAT_VECTOR
index:
index_type: DISKANN
metric_type: COSINE
index_params:
M: 64
ef_construction: 200
workflow:
compact: TrueThe compact_and_watch.py script monitors the database and performs compaction. You should only need this if the load process exits out while waiting. The load script will do compaction and will wait for it to complete.
python compact_and_watch.py --config configs/10m.yaml --interval 5This step is automatically performed at the end of the loading process if you set compact: true in your configuration.
Finally, run the benchmark using the simple_bench.py script:
python simple_bench.py --host 127.0.0.1 --collection <collection_name> --processes <N> --batch-size <batch_size> --runtime <length of benchmark run in seconds>Milvus (currently implemented)
Contributions are welcome! Please feel free to submit a Pull Request.