Function get_backend_class

vicinity/backends/__init__.py:22–63

Get the requested backend and ensure its dependencies are installed.

(backend: Backend | str)

def get_backend_class(backend: Backend | str) -> type[AbstractBackend]:
    """Get the requested backend and ensure its dependencies are installed."""
    backend = Backend(backend)

    if backend == Backend.BASIC:
        return BasicBackend

    elif backend == Backend.HNSW:
        _require("hnswlib", backend, "hnsw")
        from vicinity.backends.hnsw import HNSWBackend

        return HNSWBackend

    elif backend == Backend.ANNOY:
        _require("annoy", backend, "annoy")
        from vicinity.backends.annoy import AnnoyBackend

        return AnnoyBackend

    elif backend == Backend.PYNNDESCENT:
        _require("pynndescent", backend, "pynndescent")
        from vicinity.backends.pynndescent import PyNNDescentBackend

        return PyNNDescentBackend

    elif backend == Backend.FAISS:
        _require("faiss", backend, "faiss")
        from vicinity.backends.faiss import FaissBackend

        return FaissBackend

    elif backend == Backend.USEARCH:
        _require("usearch", backend, "usearch")
        from vicinity.backends.usearch import UsearchBackend

        return UsearchBackend

    elif backend == Backend.VOYAGER:
        _require("voyager", backend, "voyager")
        from vicinity.backends.voyager import VoyagerBackend

        return VoyagerBackend


__all__ = ["get_backend_class", "AbstractBackend", "BasicVectorStore"]