Method load

vicinity/vicinity.py:205–234

Load a Vicinity instance in fast format. As described above, the fast format stores the words and vectors of the Vicinity instance separately and is drastically faster than loading from .txt files. :param filename: The filename to load. :return: A V

(cls, filename: PathLike)

    @classmethod
    def load(cls, filename: PathLike) -> Vicinity[Any]:
        """
        Load a Vicinity instance in fast format.

        As described above, the fast format stores the words and vectors of the
        Vicinity instance separately and is drastically faster than loading from
        .txt files.

        :param filename: The filename to load.
        :return: A Vicinity instance.
        """
        folder_path = Path(filename)

        with open(folder_path / "data.json", "rb") as file_handle:
            data: dict[str, Any] = orjson.loads(file_handle.read())
        items: Sequence[Any] = data["items"]

        metadata: dict[str, Any] = data["metadata"]
        backend_type = Backend(data["backend_type"])

        backend_cls: type[AbstractBackend] = get_backend_class(backend_type)
        backend = backend_cls.load(folder_path)
        if Path(folder_path / "store").exists():
            vector_store = BasicVectorStore.load(folder_path / "store")
        else:
            vector_store = None

        instance = cls(items, backend, metadata=metadata, vector_store=vector_store)

        return instance

    def insert(self, tokens: Sequence[T], vectors: npt.NDArray) -> None:
        """