Skip to content

Commit aff0f14

Browse files
committed
update description
1 parent 3978e18 commit aff0f14

2 files changed

Lines changed: 34 additions & 6 deletions

File tree

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ pip install pyenvector==1.3.0a1
2828
3. Run Benchmark
2929

3030
```bash
31-
# Run Benchmark
31+
# Run Benchmark (VectorDBBench built-in dataset)
3232
./scripts/run_benchmark.sh --index-type FLAT --config-file envector_openai_config.yml
3333
```
3434

@@ -154,7 +154,7 @@ For the ANN benchmark, we provide two datasets via HuggingFace:
154154
- `FASHION512D200K`
155155
- `FOOD512D75K`
156156

157-
Also, we provide centroids and tree metadata for the corresponding embedding model used in the ANN benchmark:
157+
Also, we provide centroids for the corresponding embedding model used in the ANN benchmark:
158158
- GAS Centroids: [cryptolab-playground/gas-centroids](https://huggingface.co/datasets/cryptolab-playground/gas-centroids)
159159

160160
To prepare dataset, run the following command as example:
@@ -254,6 +254,35 @@ follows conventions of VectorDBBench,
254254
see details in [VectorDBBench Options](https://github.com/zilliztech/VectorDBBench?tab=readme-ov-file#custom-dataset-for-performance-case).
255255
For example, if you have a custom directory for dataset, set `DATASET_LOCAL_DIR`.
256256

257+
### enVector VectorDBBench Config File Options
258+
259+
You can file the customized config files in `vectordb_bench/config-files` to use CLI options in more convinient way.
260+
261+
```yaml
262+
# FLAT
263+
envectorflat:
264+
index_name: test_index
265+
uri: localhost:50050
266+
eval_mode: mm
267+
case_type: Performance1536D500K
268+
db_label: Performance1536D500K-FLAT
269+
k: 10
270+
drop_old: true
271+
load: true
272+
273+
# IVF-FLAT with trained k-means centroids
274+
envectorivfflat:
275+
...
276+
nlist: 256
277+
nprobe: 6
278+
train_centroids: true
279+
centroids_path: centroids/performance1536d500k/centroids_256.npy
280+
281+
# GAS: enVector-customized ANN
282+
envectorivfgas:
283+
...
284+
```
285+
257286
258287
## ❓ Troubleshooting
259288

scripts/prepare_dataset.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def get_args():
4444
"--centroids-dir",
4545
type=str,
4646
default="./centroids",
47-
help="Directory to save the centroids and tree info.",
47+
help="Directory to save the centroids.",
4848
)
4949
return parser.parse_args()
5050

@@ -92,7 +92,7 @@ def prepare_neighbors(
9292

9393

9494
def download_centroids(embedding_model: str, dataset_dir: str) -> None:
95-
"""Download pre-computed centroids and tree info for GAS VCT index."""
95+
"""Download pre-computed centroids and for IVF_GAS index."""
9696

9797
if embedding_model != "embeddinggemma-300m":
9898
raise ValueError(f"Centroids for {embedding_model} currently not available.")
@@ -103,8 +103,7 @@ def download_centroids(embedding_model: str, dataset_dir: str) -> None:
103103
# download
104104
os.makedirs(os.path.join(dataset_dir, embedding_model), exist_ok=True)
105105
wget.download(f"{dataset_link}/centroids.npy", out=os.path.join(dataset_dir, embedding_model, "centroids.npy"))
106-
wget.download(f"{dataset_link}/tree_info.pkl", out=os.path.join(dataset_dir, embedding_model, "tree_info.pkl"))
107-
print(f"\nDownloaded centroids and tree info to {os.path.join(dataset_dir, embedding_model)}")
106+
print(f"\nDownloaded centroids to {os.path.join(dataset_dir, embedding_model)}")
108107

109108

110109
if __name__ == "__main__":

0 commit comments

Comments
 (0)