Skip to content

Référence pour hub_sdk/hub_client.py

Note

Ce fichier est disponible à l'adresse https://github.com/ultralytics/ hub-sdk/blob/main/ hub_sdk/ hub_client .py. Si tu repères un problème, aide à le corriger en contribuant à une Pull Request 🛠️. Merci 🙏 !



hub_sdk.hub_client.HUBClient

Bases : Auth

Une classe client pour interagir avec un service HUB , étendant les capacités d'authentification.

Attributs :

Nom Type Description
authenticated bool

Indique si le client est authentifié.

api_key str

La clé API pour l'authentification.

id_token str

Le jeton d'identité pour l'authentification.

Code source dans hub_sdk/hub_client.py
class HUBClient(Auth):
    """
    A client class for interacting with a HUB service, extending authentication capabilities.

    Attributes:
        authenticated (bool): Indicates whether the client is authenticated.
        api_key (str): The API key for authentication.
        id_token (str): The identity token for authentication.
    """

    def __init__(self, credentials: Optional[Dict] = None):
        """
        Initializes the HUBClient instance.

        Args:
            credentials (dict, optional): A dictionary containing authentication credentials.
                            If None, the client will attempt to retrieve the API key
                            from the environment variable "HUB_API_KEY".
        """
        super().__init__()
        self.authenticated = False
        if not credentials:
            self.api_key = os.environ.get("HUB_API_KEY")  # Safely retrieve the API key from an environment variable.
            credentials = {"api_key": self.api_key}

        self.login(**credentials)

    def login(self, api_key=None, id_token=None, email=None, password=None):
        """
        Logs in the client using provided authentication credentials.

        Args:
            api_key (str, optional): The API key for authentication.
            id_token (str, optional): The identity token for authentication.
            email (str, optional): User's email.
            password (str, optional): User's password.
        """
        self.api_key = api_key
        self.id_token = id_token
        if (
            (self.api_key or self.id_token)
            and self.authenticate()
            or not self.api_key
            and not self.id_token
            and email
            and password
            and self.authorize(email, password)
        ):
            self.authenticated = True

    @require_authentication
    def model(self, model_id: Optional[str] = None) -> Models:
        """
        Returns an instance of the Models class for interacting with models.

        Args:
            model_id (str, optional): The identifier of the model. If provided,
                returns an instance associated with the specified model_id.

        Returns:
            (Models): An instance of the Models class.
        """
        return Models(model_id, self.get_auth_header())

    @require_authentication
    def dataset(self, dataset_id: str = None) -> DatasetList:
        """
        Returns an instance of the Datasets class for interacting with datasets.

        Args:
            dataset_id (str, optional): The identifier of the dataset. If provided,
                returns an instance associated with the specified dataset_id.

        Returns:
            (Datasets): An instance of the Datasets class.
        """
        raise Exception("Coming Soon")

    @require_authentication
    def team(self, arg):
        """Returns an instance of the Teams class for interacting with teams."""
        raise Exception("Coming Soon")

    @require_authentication
    def project(self, project_id: Optional[str] = None) -> Projects:
        """
        Returns an instance of the Projects class for interacting with Projects.

        Args:
            project_id (str, optional): The identifier of the project. If provided,
                returns an instance associated with the specified project_id.

        Returns:
            (Projects): An instance of the Projects class.
        """
        raise Exception("Coming Soon")

    @require_authentication
    def user(self, user_id: Optional[str] = None) -> Users:
        """
        Returns an instance of the Users class for interacting with Projects.

        Args:
            user_id (str, optional): The identifier of the user. If provided,
                returns an instance associated with the specified user_id.

        Returns:
            (Users): An instance of the Projects class.
        """
        return Users(user_id, self.get_auth_header())

    @require_authentication
    def model_list(self, page_size: Optional[int] = None, public: Optional[bool] = None) -> ModelList:
        """
        Returns a ModelList instance for interacting with a list of models.

        Args:
            page_size (int, optional): The number of models per page.
            public (bool, optional): Pass true to retrieve list of Public models list.

        Returns:
            (ModelList): An instance of the ModelList class.
        """
        return ModelList(page_size, public, self.get_auth_header())

    @require_authentication
    def project_list(self, page_size: Optional[int] = None, public: Optional[bool] = None) -> ProjectList:
        """
        Returns a ProjectList instance for interacting with a list of projects.

        Args:
            page_size (int, optional): The number of projects per page.
            public (bool, optional): Pass true to retrieve list of Public models list.

        Returns:
            (ProjectList): An instance of the ProjectList class.
        """
        raise Exception("Coming Soon")

    @require_authentication
    def dataset_list(self, page_size: Optional[int] = None, public: Optional[bool] = None) -> DatasetList:
        """
        Returns a DatasetList instance for interacting with a list of datasets.

        Args:
            page_size (int, optional): The number of datasets per page.
            public (bool, optional): Pass true to retrieve list of Public dataset list.

        Returns:
            (DatasetList): An instance of the DatasetList class.
        """
        raise Exception("Coming Soon")

    @require_authentication
    def team_list(self, page_size=None, public=None):
        """Fetches a list of team members with optional pagination."""
        raise Exception("Coming Soon")

__init__(credentials=None)

Initialise l'instance de HUBClient.

Paramètres :

Nom Type Description DĂ©faut
credentials dict

Un dictionnaire contenant les informations d'authentification. Si elle est nulle, le client tentera de récupérer la clé de l'API à partir de la variable d'environnement "HUB_API_KEY".

None
Code source dans hub_sdk/hub_client.py
def __init__(self, credentials: Optional[Dict] = None):
    """
    Initializes the HUBClient instance.

    Args:
        credentials (dict, optional): A dictionary containing authentication credentials.
                        If None, the client will attempt to retrieve the API key
                        from the environment variable "HUB_API_KEY".
    """
    super().__init__()
    self.authenticated = False
    if not credentials:
        self.api_key = os.environ.get("HUB_API_KEY")  # Safely retrieve the API key from an environment variable.
        credentials = {"api_key": self.api_key}

    self.login(**credentials)

dataset(dataset_id=None)

Renvoie une instance de la classe Datasets pour interagir avec les ensembles de données.

Paramètres :

Nom Type Description DĂ©faut
dataset_id str

L'identifiant de l'ensemble de données. S'il est fourni, renvoie une instance associée à l'identifiant du jeu de données spécifié.

None

Retourne :

Type Description
Datasets

Une instance de la classe Datasets.

Code source dans hub_sdk/hub_client.py
@require_authentication
def dataset(self, dataset_id: str = None) -> DatasetList:
    """
    Returns an instance of the Datasets class for interacting with datasets.

    Args:
        dataset_id (str, optional): The identifier of the dataset. If provided,
            returns an instance associated with the specified dataset_id.

    Returns:
        (Datasets): An instance of the Datasets class.
    """
    raise Exception("Coming Soon")

dataset_list(page_size=None, public=None)

Renvoie une instance de DatasetList pour interagir avec une liste de jeux de données.

Paramètres :

Nom Type Description DĂ©faut
page_size int

Le nombre d'ensembles de données par page.

None
public bool

Passe true pour récupérer la liste des jeux de données publics.

None

Retourne :

Type Description
DatasetList

Une instance de la classe DatasetList.

Code source dans hub_sdk/hub_client.py
@require_authentication
def dataset_list(self, page_size: Optional[int] = None, public: Optional[bool] = None) -> DatasetList:
    """
    Returns a DatasetList instance for interacting with a list of datasets.

    Args:
        page_size (int, optional): The number of datasets per page.
        public (bool, optional): Pass true to retrieve list of Public dataset list.

    Returns:
        (DatasetList): An instance of the DatasetList class.
    """
    raise Exception("Coming Soon")

login(api_key=None, id_token=None, email=None, password=None)

Connecte le client Ă  l'aide des informations d'authentification fournies.

Paramètres :

Nom Type Description DĂ©faut
api_key str

La clé API pour l'authentification.

None
id_token str

Le jeton d'identité pour l'authentification.

None
email str

Courriel de l'utilisateur.

None
password str

Mot de passe de l'utilisateur.

None
Code source dans hub_sdk/hub_client.py
def login(self, api_key=None, id_token=None, email=None, password=None):
    """
    Logs in the client using provided authentication credentials.

    Args:
        api_key (str, optional): The API key for authentication.
        id_token (str, optional): The identity token for authentication.
        email (str, optional): User's email.
        password (str, optional): User's password.
    """
    self.api_key = api_key
    self.id_token = id_token
    if (
        (self.api_key or self.id_token)
        and self.authenticate()
        or not self.api_key
        and not self.id_token
        and email
        and password
        and self.authorize(email, password)
    ):
        self.authenticated = True

model(model_id=None)

Renvoie une instance de la classe Modèles pour interagir avec les modèles.

Paramètres :

Nom Type Description DĂ©faut
model_id str

L'identifiant du modèle. S'il est fourni, renvoie une instance associée à l'identifiant de modèle spécifié.

None

Retourne :

Type Description
Models

Une instance de la classe Modèles.

Code source dans hub_sdk/hub_client.py
@require_authentication
def model(self, model_id: Optional[str] = None) -> Models:
    """
    Returns an instance of the Models class for interacting with models.

    Args:
        model_id (str, optional): The identifier of the model. If provided,
            returns an instance associated with the specified model_id.

    Returns:
        (Models): An instance of the Models class.
    """
    return Models(model_id, self.get_auth_header())

model_list(page_size=None, public=None)

Renvoie une instance de ModelList pour interagir avec une liste de modèles.

Paramètres :

Nom Type Description DĂ©faut
page_size int

Le nombre de modèles par page.

None
public bool

Passe true pour récupérer la liste des modèles publics.

None

Retourne :

Type Description
ModelList

Une instance de la classe ModelList.

Code source dans hub_sdk/hub_client.py
@require_authentication
def model_list(self, page_size: Optional[int] = None, public: Optional[bool] = None) -> ModelList:
    """
    Returns a ModelList instance for interacting with a list of models.

    Args:
        page_size (int, optional): The number of models per page.
        public (bool, optional): Pass true to retrieve list of Public models list.

    Returns:
        (ModelList): An instance of the ModelList class.
    """
    return ModelList(page_size, public, self.get_auth_header())

project(project_id=None)

Renvoie une instance de la classe Projets pour interagir avec les projets.

Paramètres :

Nom Type Description DĂ©faut
project_id str

L'identifiant du projet. S'il est fourni, renvoie une instance associée à l'identifiant de projet spécifié.

None

Retourne :

Type Description
Projects

Une instance de la classe Projets.

Code source dans hub_sdk/hub_client.py
@require_authentication
def project(self, project_id: Optional[str] = None) -> Projects:
    """
    Returns an instance of the Projects class for interacting with Projects.

    Args:
        project_id (str, optional): The identifier of the project. If provided,
            returns an instance associated with the specified project_id.

    Returns:
        (Projects): An instance of the Projects class.
    """
    raise Exception("Coming Soon")

project_list(page_size=None, public=None)

Renvoie une instance de liste de projets pour interagir avec une liste de projets.

Paramètres :

Nom Type Description DĂ©faut
page_size int

Le nombre de projets par page.

None
public bool

Passe true pour récupérer la liste des modèles publics.

None

Retourne :

Type Description
ProjectList

Une instance de la classe ProjectList.

Code source dans hub_sdk/hub_client.py
@require_authentication
def project_list(self, page_size: Optional[int] = None, public: Optional[bool] = None) -> ProjectList:
    """
    Returns a ProjectList instance for interacting with a list of projects.

    Args:
        page_size (int, optional): The number of projects per page.
        public (bool, optional): Pass true to retrieve list of Public models list.

    Returns:
        (ProjectList): An instance of the ProjectList class.
    """
    raise Exception("Coming Soon")

team(arg)

Renvoie une instance de la classe Équipes pour interagir avec les équipes.

Code source dans hub_sdk/hub_client.py
@require_authentication
def team(self, arg):
    """Returns an instance of the Teams class for interacting with teams."""
    raise Exception("Coming Soon")

team_list(page_size=None, public=None)

Récupère une liste des membres de l'équipe avec une pagination optionnelle.

Code source dans hub_sdk/hub_client.py
@require_authentication
def team_list(self, page_size=None, public=None):
    """Fetches a list of team members with optional pagination."""
    raise Exception("Coming Soon")

user(user_id=None)

Renvoie une instance de la classe Utilisateurs pour interagir avec les projets.

Paramètres :

Nom Type Description DĂ©faut
user_id str

L'identifiant de l'utilisateur. S'il est fourni, renvoie une instance associée à l'identifiant spécifié.

None

Retourne :

Type Description
Users

Une instance de la classe Projets.

Code source dans hub_sdk/hub_client.py
@require_authentication
def user(self, user_id: Optional[str] = None) -> Users:
    """
    Returns an instance of the Users class for interacting with Projects.

    Args:
        user_id (str, optional): The identifier of the user. If provided,
            returns an instance associated with the specified user_id.

    Returns:
        (Users): An instance of the Projects class.
    """
    return Users(user_id, self.get_auth_header())



hub_sdk.hub_client.require_authentication(func)

Une fonction décoratrice pour s'assurer que la méthode enveloppée ne peut être exécutée que si le client est authentifié.

Paramètres :

Nom Type Description DĂ©faut
func callable

La méthode à envelopper.

requis

Retourne :

Type Description
callable

La méthode enveloppée.

Code source dans hub_sdk/hub_client.py
def require_authentication(func) -> callable:
    """
    A decorator function to ensure that the wrapped method can only be executed if the client is authenticated.

    Args:
        func (callable): The method to be wrapped.

    Returns:
        (callable): The wrapped method.
    """

    def wrapper(self, *args, **kwargs):
        """Decorator to ensure a method is called only if the user is authenticated."""
        if not self.authenticated and not kwargs.get("public"):
            raise PermissionError("Access Denied: Authentication required.")
        return func(self, *args, **kwargs)

    return wrapper