Method load_from_hub

vicinity/vicinity.py:314–326

Load a Vicinity instance from the Hugging Face Hub. :param repo_id: The repository ID on the Hugging Face Hub. :param token: Optional authentication token for private repositories. :param **kwargs: Additional arguments passed to Dataset.load_from_hub(). :ret

(cls: type[Vicinity[Any]], repo_id: str, token: str | None = None, **kwargs: Any)

    @classmethod
    def load_from_hub(cls: type[Vicinity[Any]], repo_id: str, token: str | None = None, **kwargs: Any) -> Vicinity[Any]:
        """
        Load a Vicinity instance from the Hugging Face Hub.

        :param repo_id: The repository ID on the Hugging Face Hub.
        :param token: Optional authentication token for private repositories.
        :param **kwargs: Additional arguments passed to Dataset.load_from_hub().
        :return: A Vicinity instance.
        """
        from vicinity.integrations.huggingface import load_from_hub

        items, vector_store, backend, config = load_from_hub(repo_id=repo_id, token=token)
        return Vicinity(items, backend, metadata=config["metadata"], vector_store=vector_store)

    def evaluate(
        self,