vicinity 0.3.0__tar.gz → 0.3.1__tar.gz

{vicinity-0.3.0 → vicinity-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vicinity
-Version: 0.3.0
+Version: 0.3.1
 Summary: Lightweight Nearest Neighbors with Flexible Backends
 Author-email: Stéphan Tulkens <stephantul@gmail.com>, Thomas van Dongen <thomas123@live.nl>
 License: MIT License
@@ -127,8 +127,7 @@ 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
+from vicinity import Vicinity, Backend, Metric
 
 # Create some dummy data
 items = ["triforce", "master sword", "hylian shield", "boomerang", "hookshot"]

{vicinity-0.3.0 → vicinity-0.3.1}/README.md

@@ -48,8 +48,7 @@ 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
+from vicinity import Vicinity, Backend, Metric
 
 # Create some dummy data
 items = ["triforce", "master sword", "hylian shield", "boomerang", "hookshot"]

{vicinity-0.3.0 → vicinity-0.3.1}/uv.lock

@@ -1087,7 +1087,7 @@ wheels = [
 
 [[package]]
 name = "vicinity"
-version = "0.2.0"
+version = "0.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "numpy" },
@@ -1096,6 +1096,16 @@ dependencies = [
 ]
 
 [package.optional-dependencies]
+all = [
+    { name = "annoy" },
+    { name = "faiss-cpu" },
+    { name = "hnswlib" },
+    { name = "llvmlite" },
+    { name = "numba" },
+    { name = "numpy" },
+    { name = "pynndescent" },
+    { name = "usearch" },
+]
 annoy = [
     { name = "annoy" },
 ]
@@ -1127,24 +1137,32 @@ usearch = [
 
 [package.metadata]
 requires-dist = [
+    { name = "annoy", marker = "extra == 'all'" },
     { name = "annoy", marker = "extra == 'annoy'" },
     { name = "black", marker = "extra == 'dev'" },
+    { name = "faiss-cpu", marker = "extra == 'all'" },
     { name = "faiss-cpu", marker = "extra == 'faiss'" },
+    { name = "hnswlib", marker = "extra == 'all'" },
     { name = "hnswlib", marker = "extra == 'hnsw'" },
     { name = "ipython", marker = "extra == 'dev'" },
+    { name = "llvmlite", marker = "extra == 'all'", specifier = ">=0.42.0" },
     { name = "llvmlite", marker = "extra == 'pynndescent'", specifier = ">=0.42.0" },
     { name = "mypy", marker = "extra == 'dev'" },
+    { name = "numba", marker = "extra == 'all'", specifier = ">=0.59.0" },
     { name = "numba", marker = "extra == 'pynndescent'", specifier = ">=0.59.0" },
     { name = "numpy" },
+    { name = "numpy", marker = "extra == 'all'", specifier = ">=1.24.0" },
     { name = "numpy", marker = "extra == 'pynndescent'", specifier = ">=1.24.0" },
     { name = "orjson" },
     { name = "pre-commit", marker = "extra == 'dev'" },
+    { name = "pynndescent", marker = "extra == 'all'", specifier = ">=0.5.10" },
     { name = "pynndescent", marker = "extra == 'pynndescent'", specifier = ">=0.5.10" },
     { name = "pytest", marker = "extra == 'dev'" },
     { name = "pytest-coverage", marker = "extra == 'dev'" },
     { name = "ruff", marker = "extra == 'dev'" },
     { name = "setuptools", marker = "extra == 'dev'" },
     { name = "tqdm" },
+    { name = "usearch", marker = "extra == 'all'" },
     { name = "usearch", marker = "extra == 'usearch'" },
 ]
 

{vicinity-0.3.0 → vicinity-0.3.1}/vicinity/backends/basic.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Literal
+from typing import Any, Literal, Union
 
 import numpy as np
 from numpy import typing as npt
@@ -15,7 +15,7 @@ from vicinity.utils import Metric, normalize, normalize_or_copy
 
 @dataclass
 class BasicArgs(BaseArgs):
-    metric: Literal["cosine", "euclidean"] = "cosine"
+    metric: str = "cosine"
 
 
 class BasicBackend(AbstractBackend[BasicArgs], ABC):
@@ -66,15 +66,20 @@ class BasicBackend(AbstractBackend[BasicArgs], ABC):
         raise NotImplementedError()
 
     @classmethod
-    def from_vectors(cls, vectors: npt.NDArray, **kwargs: Any) -> BasicBackend:
+    def from_vectors(cls, vectors: npt.NDArray, metric: Union[str, Metric] = "cosine", **kwargs: Any) -> BasicBackend:
         """Create a new instance from vectors."""
-        arguments = BasicArgs(**kwargs)
-        if arguments.metric == "cosine":
+        metric_enum = Metric.from_string(metric)
+        if metric_enum not in cls.supported_metrics:
+            raise ValueError(f"Metric '{metric_enum.value}' is not supported by BasicBackend.")
+
+        metric = metric_enum.value
+        arguments = BasicArgs(metric=metric)
+        if metric == "cosine":
             return CosineBasicBackend(vectors, arguments)
-        elif arguments.metric == "euclidean":
+        elif metric == "euclidean":
             return EuclideanBasicBackend(vectors, arguments)
         else:
-            raise ValueError(f"Unsupported metric: {arguments.metric}")
+            raise ValueError(f"Unsupported metric: {metric}")
 
     @classmethod
     def load(cls, folder: Path) -> BasicBackend:

{vicinity-0.3.0 → vicinity-0.3.1}/vicinity/version.py

@@ -1,2 +1,2 @@
-__version_triple__ = (0, 3, 0)
+__version_triple__ = (0, 3, 1)
 __version__ = ".".join(map(str, __version_triple__))

{vicinity-0.3.0 → vicinity-0.3.1}/vicinity.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vicinity
-Version: 0.3.0
+Version: 0.3.1
 Summary: Lightweight Nearest Neighbors with Flexible Backends
 Author-email: Stéphan Tulkens <stephantul@gmail.com>, Thomas van Dongen <thomas123@live.nl>
 License: MIT License
@@ -127,8 +127,7 @@ 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
+from vicinity import Vicinity, Backend, Metric
 
 # Create some dummy data
 items = ["triforce", "master sword", "hylian shield", "boomerang", "hookshot"]