Method save

vicinity/vicinity.py:167–202

Save a Vicinity instance in a fast format. The Vicinity fast format stores the words and vectors of a Vicinity instance separately in a JSON and numpy format, respectively. :param folder: The path to which to save the JSON file. The vectors are saved separately. Th

(
        self,
        folder: PathLike,
        overwrite: bool = False,
    )

        return out

    def save(
        self,
        folder: PathLike,
        overwrite: bool = False,
    ) -> None:
        """
        Save a Vicinity instance in a fast format.

        The Vicinity fast format stores the words and vectors of a Vicinity instance
        separately in a JSON and numpy format, respectively.

        :param folder: The path to which to save the JSON file. The vectors are saved separately. The JSON contains a path to the numpy file.
        :param overwrite: Whether to overwrite the JSON and numpy files if they already exist.
        :raises ValueError: If the path is not a directory.
        :raises JSONEncodeError: If the items are not JSON-serializable. ``save()`` and ``load()``
            only support item types that orjson can encode (e.g. strings, numbers, dicts).
            Use ``Vicinity[str]`` or another serializable type if you need persistence.
        """
        path = Path(folder)
        path.mkdir(parents=True, exist_ok=overwrite)

        if not path.is_dir():
            raise ValueError(f"Path {path} should be a directory.")

        items_dict = {"items": self.items, "metadata": self.metadata, "backend_type": self.backend.backend_type.value}
        try:
            with open(path / "data.json", "wb") as file_handle:
                file_handle.write(orjson.dumps(items_dict))
        except JSONEncodeError as e:
            raise JSONEncodeError(f"Items could not be encoded to JSON because they are not serializable: {e}")

        self.backend.save(path)
        if self.vector_store is not None:
            store_path = path / "store"
            store_path.mkdir(exist_ok=overwrite)
            self.vector_store.save(store_path)

    @classmethod
    def load(cls, filename: PathLike) -> Vicinity[Any]: