Skip to content

Commit bcf95dc

Browse files
committed
feat: add VectorChord support to README πŸ“–βœ¨
Updated installation instructions and added command line usage for VectorChord (vchordrq) to enhance user experience. πŸš€
1 parent 8471644 commit bcf95dc

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ All the database client supported
4141
| pinecone | `pip install vectordb-bench[pinecone]` |
4242
| weaviate | `pip install vectordb-bench[weaviate]` |
4343
| elastic, aliyun_elasticsearch| `pip install vectordb-bench[elastic]` |
44-
| pgvector, pgvectorscale, pgdiskann, alloydb | `pip install vectordb-bench[pgvector]` |
44+
| pgvector, pgvectorscale, pgdiskann, alloydb, vectorchord | `pip install vectordb-bench[pgvector]` |
4545
| pgvecto.rs | `pip install vectordb-bench[pgvecto_rs]` |
4646
| redis | `pip install vectordb-bench[redis]` |
4747
| memorydb | `pip install vectordb-bench[memorydb]` |
@@ -86,6 +86,7 @@ Options:
8686
Commands:
8787
pgvectorhnsw
8888
pgvectorivfflat
89+
vectorchordrq
8990
test
9091
weaviate
9192
```
@@ -179,6 +180,34 @@ Options:
179180
--help Show this message and exit.
180181
```
181182

183+
### Run VectorChord (vchordrq) from command line
184+
185+
VectorChord is a PostgreSQL extension for scalable vector similarity search using IVF + RaBitQ indexing.
186+
It is fully compatible with pgvector data types and provides faster queries and index builds.
187+
188+
```shell
189+
vectordbbench vectorchordrq \
190+
--user-name postgres --password '<password>' \
191+
--host localhost --port 5432 --db-name vectordb \
192+
--case-type Performance1536D50K \
193+
--lists 1000 --probes 10 --epsilon 1.9 \
194+
--spherical-centroids --build-threads 8 \
195+
--max-parallel-workers 15
196+
```
197+
198+
Key VectorChord-specific options:
199+
| Option | Description |
200+
|--------|-------------|
201+
| `--lists` | Number of IVF lists for vchordrq index |
202+
| `--probes` | Number of probes during search (default: 10) |
203+
| `--epsilon` | Reranking precision factor, 0.0-4.0 (default: 1.9) |
204+
| `--residual-quantization` | Enable residual quantization |
205+
| `--spherical-centroids` | L2-normalize centroids (recommended for cosine/IP) |
206+
| `--build-threads` | Number of threads for index building (1-255) |
207+
| `--degree-of-parallelism` | Degree of parallelism for index build (1-256) |
208+
| `--max-parallel-workers` | Sets max_parallel_workers & max_parallel_maintenance_workers |
209+
| `--max-scan-tuples` | Max tuples to scan before stopping (-1 for unlimited) |
210+
182211
### Run awsopensearch from command line
183212

184213
```shell
@@ -756,7 +785,7 @@ Now we can only run one task at the same time.
756785
### Code Structure
757786
![image](https://github.com/zilliztech/VectorDBBench/assets/105927039/8c06512e-5419-4381-b084-9c93aed59639)
758787
### Client
759-
Our client module is designed with flexibility and extensibility in mind, aiming to integrate APIs from different systems seamlessly. As of now, it supports Milvus, Zilliz Cloud, Elastic Search, Pinecone, Qdrant Cloud, Weaviate Cloud, PgVector, Redis, Chroma, CockroachDB, etc. Stay tuned for more options, as we are consistently working on extending our reach to other systems.
788+
Our client module is designed with flexibility and extensibility in mind, aiming to integrate APIs from different systems seamlessly. As of now, it supports Milvus, Zilliz Cloud, Elastic Search, Pinecone, Qdrant Cloud, Weaviate Cloud, PgVector, VectorChord, Redis, Chroma, CockroachDB, etc. Stay tuned for more options, as we are consistently working on extending our reach to other systems.
760789
### Benchmark Cases
761790
We've developed lots of comprehensive benchmark cases to test vector databases' various capabilities, each designed to give you a different piece of the puzzle. These cases are categorized into four main types:
762791
#### Capacity Case

0 commit comments

Comments
Β (0)