vicinity 0.2.0__tar.gz → 0.3.0__tar.gz

{vicinity-0.2.0 → vicinity-0.3.0}/Makefile

@@ -9,7 +9,7 @@ install: venv
 	uv run pre-commit install
 
 install-no-pre-commit:
-	uv pip install ".[dev,hnsw,pynndescent,annoy,faiss]"
+	uv pip install ".[dev,hnsw,pynndescent,annoy,faiss,usearch]"
 
 install-base:
 	uv sync --extra dev

vicinity-0.3.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.1
+Name: vicinity
+Version: 0.3.0
+Summary: Lightweight Nearest Neighbors with Flexible Backends
+Author-email: Stéphan Tulkens <stephantul@gmail.com>, Thomas van Dongen <thomas123@live.nl>
+License: MIT License
+        
+        Copyright (c) 2024 The Minish Lab
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/MinishLab
+Project-URL: Bug Reports, https://github.com/MinishLab/vicinity/issues
+Project-URL: Source, https://github.com/MinishLab/vicinity
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: orjson
+Requires-Dist: tqdm
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-coverage; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Provides-Extra: hnsw
+Requires-Dist: hnswlib; extra == "hnsw"
+Provides-Extra: pynndescent
+Requires-Dist: pynndescent>=0.5.10; extra == "pynndescent"
+Requires-Dist: numba>=0.59.0; extra == "pynndescent"
+Requires-Dist: llvmlite>=0.42.0; extra == "pynndescent"
+Requires-Dist: numpy>=1.24.0; extra == "pynndescent"
+Provides-Extra: annoy
+Requires-Dist: annoy; extra == "annoy"
+Provides-Extra: faiss
+Requires-Dist: faiss-cpu; extra == "faiss"
+Provides-Extra: usearch
+Requires-Dist: usearch; extra == "usearch"
+Provides-Extra: all
+Requires-Dist: hnswlib; extra == "all"
+Requires-Dist: pynndescent>=0.5.10; extra == "all"
+Requires-Dist: numba>=0.59.0; extra == "all"
+Requires-Dist: llvmlite>=0.42.0; extra == "all"
+Requires-Dist: numpy>=1.24.0; extra == "all"
+Requires-Dist: annoy; extra == "all"
+Requires-Dist: faiss-cpu; extra == "all"
+Requires-Dist: usearch; extra == "all"
+
+<div align="center">
+
+# Vicinity: Lightweight Nearest Neighbors
+
+</div>
+
+
+<div align="center">
+  <h2>
+    <a href="https://pypi.org/project/vicinity/"><img src="https://img.shields.io/pypi/v/vicinity?color=%23007ec6&label=pypi%20package" alt="Package version"></a>
+    <a href="https://pypi.org/project/vicinity/"><img src="https://img.shields.io/pypi/pyversions/vicinity" alt="Supported Python versions"></a>
+    <a href="https://pepy.tech/project/vicinity">
+    <img src="https://static.pepy.tech/badge/vicinity" alt="Downloads">
+    </a>
+    <a href="https://app.codecov.io/gh/MinishLab/vicinity">
+    <img src="https://codecov.io/gh/MinishLab/vicinity/graph/badge.svg?token=0MQ2945OZL" alt="Codecov">
+    </a>
+    <a href="https://github.com/MinishLab/vicinity/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License - MIT"></a>
+  </h2>
+
+[Quickstart](#quickstart) •
+[Main Features](#main-features) •
+[Supported Backends](#supported-backends) •
+[Installation](#installation)
+
+</div>
+
+
+Vicinity is a light-weight, low-dependency vector store. It provides a simple and intuitive interface for nearest neighbor search, with support for different backends and evaluation.
+
+There are many nearest neighbors packages and methods out there. However, we found it difficult to compare them. Every package has its own interface, quirks, and limitations, and learning a new package can be time-consuming. In addition to that, how do you effectively evaluate different packages? How do you know which one is the best for your use case?
+
+
+ This is where Vicinity comes in. Instead of learning a new interface for each new package or backend, Vicinity provides a unified interface for all backends. This allows you to easily experiment with different indexing methods and distance metrics and choose the best one for your use case. Vicinity also provides a simple way to evaluate the performance of different backends, allowing you to measure the queries per second and recall.
+
+## Quickstart
+
+Install the package with:
+```bash
+pip install vicinity
+```
+Optinally, [install any of the supported backends](#installation), or simply install all of them with:
+```bash
+pip install vicinity[all]
+```
+
+
+The following code snippet demonstrates how to use Vicinity for nearest neighbor search:
+```python
+import numpy as np
+from vicinity import Vicinity
+from vicinity.datatypes import Backend, Metric
+
+# Create some dummy data
+items = ["triforce", "master sword", "hylian shield", "boomerang", "hookshot"]
+vectors = np.random.rand(len(items), 128)
+
+# Initialize the Vicinity instance (using the basic backend and cosine metric)
+vicinity = Vicinity.from_vectors_and_items(vectors=vectors, items=items, backend_type=Backend.BASIC, metric=Metric.COSINE)
+
+# Create a query vector
+query_vector = np.random.rand(128)
+
+# Query for nearest neighbors with a top-k search
+results = vicinity.query([query_vector], k=3)
+
+# Query for nearest neighbors with a threshold search
+results = vicinity.query_threshold([query_vector], threshold=0.9)
+```
+
+Saving and loading a vector store:
+```python
+vicinity.save('my_vector_store')
+vicinity = Vicinity.load('my_vector_store')
+```
+
+Evaluating a backend:
+```python
+# Use the first 1000 vectors as query vectors
+query_vectors = vectors[:1000]
+
+# Evaluate the Vicinity instance by measuring the queries per second and recall
+qps, recall = vicinity.evaluate(
+    full_vectors=vectors,
+    query_vectors=query_vectors,
+)
+```
+
+## Main Features
+Vicinity provides the following features:
+- Lightweight: Minimal dependencies and fast performance.
+- Flexible Backend Support: Use different backends for vector storage and search.
+- Serialization: Save and load vector stores for persistence.
+- Evaluation: Easily evaluate the performance of different backends.
+- Easy to Use: Simple and intuitive API.
+
+## Supported Backends
+The following backends are supported:
+- `BASIC`: A simple (exact matching) flat index for vector storage and search.
+- [HNSW](https://github.com/nmslib/hnswlib): Hierarchical Navigable Small World Graph (HNSW) for ANN search using hnswlib.
+- [USEARCH](https://github.com/unum-cloud/usearch): ANN search using Usearch. This uses a highly optimized version of the HNSW algorithm.
+- [ANNOY](https://github.com/spotify/annoy): "Approximate Nearest Neighbors Oh Yeah" for approximate nearest neighbor search.
+- [PYNNDescent](https://github.com/lmcinnes/pynndescent): ANN search using PyNNDescent.
+- [FAISS](https://github.com/facebookresearch/faiss): All FAISS indexes are supported:
+  - `flat`: Exact search.
+  - `ivf`: Inverted file search.
+  - `hnsw`: Hierarchical Navigable Small World Graph.
+  - `lsh`: Locality Sensitive Hashing.
+  - `scalar`: Scalar quantizer.
+  - `pq`: Product Quantizer.
+  - `ivf_scalar`: Inverted file search with scalar quantizer.
+  - `ivfpq`: Inverted file search with product quantizer.
+  - `ivfpqr`: Inverted file search with product quantizer and refinement.
+
+
+
+
+NOTE: the ANN backends do not support dynamic deletion. To delete items, you need to recreate the index. Insertion is supported in the following backends: `FAISS`, `HNSW`, and `Usearch`. The `BASIC` backend supports both insertion and deletion.
+
+### Backend Parameters
+
+
+| Backend         | Parameter           | Description                                                                                   | Default Value       |
+|-----------------|---------------------|-----------------------------------------------------------------------------------------------|---------------------|
+| **Annoy**       | `metric`            | Similarity metric to use (`dot`, `euclidean`, `cosine`).                                      | `"cosine"`          |
+|                 | `trees`             | Number of trees to use for indexing.                                                          | `100`               |
+|                 | `length`            | Optional length of the dataset.                                                               | `None`              |
+| **FAISS**       | `metric`            | Similarity metric to use (`cosine`, `l2`).                                                    | `"cosine"`          |
+|                 | `index_type`        | Type of FAISS index (`flat`, `ivf`, `hnsw`, `lsh`, `scalar`, `pq`, `ivf_scalar`, `ivfpq`, `ivfpqr`). | `"hnsw"`           |
+|                 | `nlist`             | Number of cells for IVF indexes.                                                              | `100`               |
+|                 | `m`                 | Number of subquantizers for PQ and HNSW indexes.                                              | `8`                 |
+|                 | `nbits`             | Number of bits for LSH and PQ indexes.                                                        | `8`                 |
+|                 | `refine_nbits`      | Number of bits for the refinement stage in IVFPQR indexes.                                    | `8`                 |
+| **HNSW**        | `metric`            | Similarity space to use (`cosine`, `l2`).                                                     | `"cosine"`          |
+|                 | `ef_construction`   | Size of the dynamic list during index construction.                                           | `200`               |
+|                 | `m`                 | Number of connections per layer.                                                              | `16`                |
+| **PyNNDescent** | `metric`            | Similarity metric to use (`cosine`, `euclidean`, `manhattan`).                                | `"cosine"`          |
+|                 | `n_neighbors`       | Number of neighbors to use for search.                                                        | `15`                |
+| **Usearch**     | `metric`            | Similarity metric to use (`cos`, `ip`, `l2sq`, `hamming`, `tanimoto`).                        | `"cos"`             |
+|                 | `connectivity`      | Number of connections per node in the graph.                                                  | `16`                |
+|                 | `expansion_add`     | Number of candidates considered during graph construction.                                    | `128`               |
+|                 | `expansion_search`  | Number of candidates considered during search.                                                | `64`                |
+
+
+## Installation
+The following installation options are available:
+```bash
+# Install the base package
+pip install vicinity
+
+# Install all backends
+pip install vicinity[all]
+
+# Install specific backends
+pip install vicinity[annoy]
+pip install vicinity[faiss]
+pip install vicinity[hnsw]
+pip install vicinity[pynndescent]
+pip install vicinity[usearch]
+```
+
+## License
+
+MIT

vicinity-0.3.0/README.md

@@ -0,0 +1,164 @@
+<div align="center">
+
+# Vicinity: Lightweight Nearest Neighbors
+
+</div>
+
+
+<div align="center">
+  <h2>
+    <a href="https://pypi.org/project/vicinity/"><img src="https://img.shields.io/pypi/v/vicinity?color=%23007ec6&label=pypi%20package" alt="Package version"></a>
+    <a href="https://pypi.org/project/vicinity/"><img src="https://img.shields.io/pypi/pyversions/vicinity" alt="Supported Python versions"></a>
+    <a href="https://pepy.tech/project/vicinity">
+    <img src="https://static.pepy.tech/badge/vicinity" alt="Downloads">
+    </a>
+    <a href="https://app.codecov.io/gh/MinishLab/vicinity">
+    <img src="https://codecov.io/gh/MinishLab/vicinity/graph/badge.svg?token=0MQ2945OZL" alt="Codecov">
+    </a>
+    <a href="https://github.com/MinishLab/vicinity/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License - MIT"></a>
+  </h2>
+
+[Quickstart](#quickstart) •
+[Main Features](#main-features) •
+[Supported Backends](#supported-backends) •
+[Installation](#installation)
+
+</div>
+
+
+Vicinity is a light-weight, low-dependency vector store. It provides a simple and intuitive interface for nearest neighbor search, with support for different backends and evaluation.
+
+There are many nearest neighbors packages and methods out there. However, we found it difficult to compare them. Every package has its own interface, quirks, and limitations, and learning a new package can be time-consuming. In addition to that, how do you effectively evaluate different packages? How do you know which one is the best for your use case?
+
+
+ This is where Vicinity comes in. Instead of learning a new interface for each new package or backend, Vicinity provides a unified interface for all backends. This allows you to easily experiment with different indexing methods and distance metrics and choose the best one for your use case. Vicinity also provides a simple way to evaluate the performance of different backends, allowing you to measure the queries per second and recall.
+
+## Quickstart
+
+Install the package with:
+```bash
+pip install vicinity
+```
+Optinally, [install any of the supported backends](#installation), or simply install all of them with:
+```bash
+pip install vicinity[all]
+```
+
+
+The following code snippet demonstrates how to use Vicinity for nearest neighbor search:
+```python
+import numpy as np
+from vicinity import Vicinity
+from vicinity.datatypes import Backend, Metric
+
+# Create some dummy data
+items = ["triforce", "master sword", "hylian shield", "boomerang", "hookshot"]
+vectors = np.random.rand(len(items), 128)
+
+# Initialize the Vicinity instance (using the basic backend and cosine metric)
+vicinity = Vicinity.from_vectors_and_items(vectors=vectors, items=items, backend_type=Backend.BASIC, metric=Metric.COSINE)
+
+# Create a query vector
+query_vector = np.random.rand(128)
+
+# Query for nearest neighbors with a top-k search
+results = vicinity.query([query_vector], k=3)
+
+# Query for nearest neighbors with a threshold search
+results = vicinity.query_threshold([query_vector], threshold=0.9)
+```
+
+Saving and loading a vector store:
+```python
+vicinity.save('my_vector_store')
+vicinity = Vicinity.load('my_vector_store')
+```
+
+Evaluating a backend:
+```python
+# Use the first 1000 vectors as query vectors
+query_vectors = vectors[:1000]
+
+# Evaluate the Vicinity instance by measuring the queries per second and recall
+qps, recall = vicinity.evaluate(
+    full_vectors=vectors,
+    query_vectors=query_vectors,
+)
+```
+
+## Main Features
+Vicinity provides the following features:
+- Lightweight: Minimal dependencies and fast performance.
+- Flexible Backend Support: Use different backends for vector storage and search.
+- Serialization: Save and load vector stores for persistence.
+- Evaluation: Easily evaluate the performance of different backends.
+- Easy to Use: Simple and intuitive API.
+
+## Supported Backends
+The following backends are supported:
+- `BASIC`: A simple (exact matching) flat index for vector storage and search.
+- [HNSW](https://github.com/nmslib/hnswlib): Hierarchical Navigable Small World Graph (HNSW) for ANN search using hnswlib.
+- [USEARCH](https://github.com/unum-cloud/usearch): ANN search using Usearch. This uses a highly optimized version of the HNSW algorithm.
+- [ANNOY](https://github.com/spotify/annoy): "Approximate Nearest Neighbors Oh Yeah" for approximate nearest neighbor search.
+- [PYNNDescent](https://github.com/lmcinnes/pynndescent): ANN search using PyNNDescent.
+- [FAISS](https://github.com/facebookresearch/faiss): All FAISS indexes are supported:
+  - `flat`: Exact search.
+  - `ivf`: Inverted file search.
+  - `hnsw`: Hierarchical Navigable Small World Graph.
+  - `lsh`: Locality Sensitive Hashing.
+  - `scalar`: Scalar quantizer.
+  - `pq`: Product Quantizer.
+  - `ivf_scalar`: Inverted file search with scalar quantizer.
+  - `ivfpq`: Inverted file search with product quantizer.
+  - `ivfpqr`: Inverted file search with product quantizer and refinement.
+
+
+
+
+NOTE: the ANN backends do not support dynamic deletion. To delete items, you need to recreate the index. Insertion is supported in the following backends: `FAISS`, `HNSW`, and `Usearch`. The `BASIC` backend supports both insertion and deletion.
+
+### Backend Parameters
+
+
+| Backend         | Parameter           | Description                                                                                   | Default Value       |
+|-----------------|---------------------|-----------------------------------------------------------------------------------------------|---------------------|
+| **Annoy**       | `metric`            | Similarity metric to use (`dot`, `euclidean`, `cosine`).                                      | `"cosine"`          |
+|                 | `trees`             | Number of trees to use for indexing.                                                          | `100`               |
+|                 | `length`            | Optional length of the dataset.                                                               | `None`              |
+| **FAISS**       | `metric`            | Similarity metric to use (`cosine`, `l2`).                                                    | `"cosine"`          |
+|                 | `index_type`        | Type of FAISS index (`flat`, `ivf`, `hnsw`, `lsh`, `scalar`, `pq`, `ivf_scalar`, `ivfpq`, `ivfpqr`). | `"hnsw"`           |
+|                 | `nlist`             | Number of cells for IVF indexes.                                                              | `100`               |
+|                 | `m`                 | Number of subquantizers for PQ and HNSW indexes.                                              | `8`                 |
+|                 | `nbits`             | Number of bits for LSH and PQ indexes.                                                        | `8`                 |
+|                 | `refine_nbits`      | Number of bits for the refinement stage in IVFPQR indexes.                                    | `8`                 |
+| **HNSW**        | `metric`            | Similarity space to use (`cosine`, `l2`).                                                     | `"cosine"`          |
+|                 | `ef_construction`   | Size of the dynamic list during index construction.                                           | `200`               |
+|                 | `m`                 | Number of connections per layer.                                                              | `16`                |
+| **PyNNDescent** | `metric`            | Similarity metric to use (`cosine`, `euclidean`, `manhattan`).                                | `"cosine"`          |
+|                 | `n_neighbors`       | Number of neighbors to use for search.                                                        | `15`                |
+| **Usearch**     | `metric`            | Similarity metric to use (`cos`, `ip`, `l2sq`, `hamming`, `tanimoto`).                        | `"cos"`             |
+|                 | `connectivity`      | Number of connections per node in the graph.                                                  | `16`                |
+|                 | `expansion_add`     | Number of candidates considered during graph construction.                                    | `128`               |
+|                 | `expansion_search`  | Number of candidates considered during search.                                                | `64`                |
+
+
+## Installation
+The following installation options are available:
+```bash
+# Install the base package
+pip install vicinity
+
+# Install all backends
+pip install vicinity[all]
+
+# Install specific backends
+pip install vicinity[annoy]
+pip install vicinity[faiss]
+pip install vicinity[hnsw]
+pip install vicinity[pynndescent]
+pip install vicinity[usearch]
+```
+
+## License
+
+MIT

{vicinity-0.2.0 → vicinity-0.3.0}/pyproject.toml

@@ -51,6 +51,17 @@ pynndescent = [
 ]
 annoy = ["annoy"]
 faiss = ["faiss-cpu"]
+usearch = ["usearch"]
+all = [
+    "hnswlib",
+    "pynndescent>=0.5.10",
+    "numba>=0.59.0",
+    "llvmlite>=0.42.0",
+    "numpy>=1.24.0",
+    "annoy",
+    "faiss-cpu",
+    "usearch"
+]
 
 [project.urls]
 "Homepage" = "https://github.com/MinishLab"

{vicinity-0.2.0 → vicinity-0.3.0}/tests/conftest.py

@@ -34,8 +34,10 @@ BACKEND_PARAMS = [(Backend.FAISS, index_type) for index_type in _faiss_index_typ
     (Backend.HNSW, None),
     (Backend.ANNOY, None),
     (Backend.PYNNDESCENT, None),
+    (Backend.USEARCH, None),
 ]
 
+
 # Create human-readable ids for each backend type
 BACKEND_IDS = [f"{backend.name}-{index_type}" if index_type else backend.name for backend, index_type in BACKEND_PARAMS]
 

{vicinity-0.2.0 → vicinity-0.3.0}/tests/test_vicinity.py

@@ -100,15 +100,8 @@ def test_vicinity_delete(vicinity_instance: Vicinity, items: list[str], vectors:
     :param items: List of item names.
     :param vectors: Array of vectors corresponding to items.
     """
-    if vicinity_instance.backend.backend_type in {Backend.ANNOY, Backend.PYNNDESCENT}:
-        # Skip delete for Annoy and Pynndescent backend
-        return
-
-    elif vicinity_instance.backend.backend_type == Backend.FAISS and vicinity_instance.backend.arguments.index_type in {
-        "hnsw",
-        "ivfpqr",
-    }:
-        # Skip delete test for FAISS index types that do not support deletion
+    if vicinity_instance.backend.backend_type != Backend.BASIC:
+        # Skip delete for non-basic backends
         return
 
     # Get the vector corresponding to "item2"
@@ -163,6 +156,9 @@ def test_vicinity_delete_nonexistent(vicinity_instance: Vicinity) -> None:
     :param vicinity_instance: A Vicinity instance.
     :raises ValueError: If deleting items that do not exist.
     """
+    if vicinity_instance.backend.backend_type != Backend.BASIC:
+        # Skip delete for non-basic backends
+        return
     with pytest.raises(ValueError):
         vicinity_instance.delete(["item10002"])
 
@@ -193,3 +189,54 @@ def test_vicinity_insert_wrong_dimension(vicinity_instance: Vicinity) -> None:
 
     with pytest.raises(ValueError):
         vicinity_instance.insert(new_item, new_vector)
+
+
+def test_vicinity_delete_and_query(vicinity_instance: Vicinity, items: list[str], vectors: np.ndarray) -> None:
+    """
+    Test Vicinity's delete and query methods together to ensure that indices are correctly handled after deletions.
+
+    :param vicinity_instance: A Vicinity instance.
+    :param items: List of item names.
+    :param vectors: Array of vectors corresponding to items.
+    """
+    if vicinity_instance.backend.backend_type != Backend.BASIC:
+        # Skip delete for non-basic backends
+        return
+
+    # Delete some items from the Vicinity instance
+    items_to_delete = ["item2", "item4", "item6"]
+    vicinity_instance.delete(items_to_delete)
+
+    # Ensure the items are no longer in the items list
+    for item in items_to_delete:
+        assert item not in vicinity_instance.items
+
+    # Query using a vector of an item that wasn't deleted
+    item3_index = items.index("item3")
+    item3_vector = vectors[item3_index]
+
+    results = vicinity_instance.query(item3_vector, k=10)
+    returned_items = [item for item, _ in results[0]]
+
+    # Check that the queried item is in the results
+    assert "item3" in returned_items
+
+
+def test_vicinity_evaluate(vicinity_instance: Vicinity, vectors: np.ndarray) -> None:
+    """
+    Test the evaluate method of the Vicinity instance.
+
+    :param vicinity_instance: A Vicinity instance.
+    :param vectors: The full dataset vectors used to build the index.
+    """
+    query_vectors = vectors[:10]
+    qps, recall = vicinity_instance.evaluate(vectors, query_vectors)
+
+    # Ensure the QPS and recall values are within valid ranges
+    assert qps > 0
+    assert 0 <= recall <= 1
+
+    # Test with an unsupported metric
+    vicinity_instance.backend.arguments.metric = "manhattan"
+    with pytest.raises(ValueError):
+        vicinity_instance.evaluate(vectors, query_vectors)