Hugging Face's logo

Hub Python Library documentation

Client HfApi

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v2.4.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Client HfApi

Voici la documentation de la classe HfApi, qui sert d’interface Python pour l’API du Hugging Face Hub.

Toutes les méthodes de HfApi sont également accessibles directement depuis la racine du package. Les deux approches sont détaillées ci-dessous.

L’utilisation de la méthode racine est plus simple, mais la classe HfApi offre davantage de flexibilité. En particulier, vous pouvez passer un jeton qui sera réutilisé dans tous les appels HTTP. Cela diffère de hf auth login ou de login(), car le jeton n’est pas persisté sur la machine. Il est également possible de fournir un point de terminaison différent ou de configurer un agent utilisateur personnalisé.

from huggingface_hub import HfApi, list_models

# Use root method
models = list_models()

# Or configure a HfApi client
hf_api = HfApi(
    endpoint="https://huggingface.co", # Can be a Private Hub endpoint.
    token="hf_xxx", # Token is not persisted on the machine.
)
models = hf_api.list_models()

HfApi

classe huggingface_hub.HfApi

< >

( endpoint: str | None = Nonetoken: str | bool | None = Nonelibrary_name: str | None = Nonelibrary_version: str | None = Noneuser_agent: dict | str | None = Noneheaders: dict[str, str] | None = None )

Paramètres

  • endpoint (str, facultatif) — Endpoint du Hub. Par défaut, https://huggingface.co.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • library_name (str, facultatif) — Le nom de la bibliothèque qui effectue la requête HTTP. Sera ajouté à l’en-tête user-agent. Exemple : "transformers".
  • library_version (str, facultatif) — La version de la bibliothèque qui effectue la requête HTTP. Sera ajoutée à l’en-tête user-agent. Exemple : "4.24.0".
  • user_agent (str, dict, facultatif) — Les informations de l’agent utilisateur, sous forme de dictionnaire ou de chaîne de caractères unique. Elles seront complétées par des informations sur les paquets installés.
  • headers (dict, facultatif) — En-têtes supplémentaires à envoyer avec chaque requête. Exemple : {"X-My-Header": "value"}. Les en-têtes passés ici prennent le pas sur les en-têtes par défaut.

Client pour interagir avec le Hugging Face Hub via HTTP.

Le client est initialisé avec certains paramètres de haut niveau utilisés dans toutes les requêtes envoyées au Hub (endpoint HF, authentification, agents utilisateur…). L’utilisation du client HfApi est préférable mais non obligatoire, car toutes ses méthodes publiques sont exposées directement à la racine de huggingface_hub.

accept_access_request

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — L'identifiant du dépôt pour lequel accepter la demande d'accès.
  • user (str, facultatif) — Le nom d'utilisateur de l'utilisateur dont la demande d'accès doit être acceptée. Il faut fournir exactement l'un des paramètres user ou request_id.
  • request_id (str, facultatif) — L’identifiant de la demande d’accès à accepter (voir AccessRequest). Obligatoire lorsque le dépôt est configuré pour ne pas partager les noms d’utilisateur des demandeurs. Il faut fournir exactement l’un des deux : user ou request_id.
  • repo_type (str, facultatif) — Le type de dépôt pour lequel accepter la demande d’accès. Doit être l’un des éléments suivants : model, dataset ou space. La valeur par défaut est model.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 si le dépôt n'est pas gated.
  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.
  • HfHubHTTPError — HTTP 404 si l'utilisateur n'existe pas sur le Hub.
  • HfHubHTTPError — HTTP 404 si la demande d’accès de l’utilisateur ne peut pas être trouvée.
  • HfHubHTTPError — HTTP 404 si la demande d'accès de l'utilisateur figure déjà dans la liste des demandes acceptées.

Accepter une demande d'accès d'un utilisateur pour un dépôt gated donné.

Une fois la demande acceptée, l’utilisateur pourra télécharger n’importe quel fichier du dépôt et accéder à l’onglet communauté. Si le mode d’approbation est automatique, vous n’avez pas à accepter les demandes manuellement. Une demande acceptée peut être annulée ou rejetée à tout moment à l’aide de cancel_access_request() et reject_access_request().

Pour plus d'informations sur les dépôts à accès restreint, consultez https://huggingface.co/docs/hub/models-gated.

add_collection_item

< >

( collection_slug: stritem_id: stritem_type: CollectionItemType_Tnote: str | None = Noneexists_ok: bool = Falsetoken: bool | str | None = None )

Paramètres

  • collection_slug (str) — Slug de la collection à mettre à jour. Exemple : "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_id (str) — Identifiant de l’élément à ajouter à la collection. Utilisez le repo_id pour les dépôts/espaces/jeux de données, l’identifiant de l’article pour les papiers, le slug d’une autre collection (par ex. "moonshotai/kimi-k2") ou un identifiant de bucket (par ex. "namespace/bucket-name").
  • item_type (str) — Type de l'élément à ajouter. Peut être l'un des éléments suivants : "model", "dataset", "space", "paper", "collection" ou "bucket".
  • note (str, facultatif) — Une note à joindre à l'élément de la collection. La taille maximale d'une note est de 500 caractères.
  • exists_ok (bool, facultatif) — Si True, ne lève pas d'erreur si l'élément existe déjà.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.
  • HfHubHTTPError — HTTP 404 si l’élément que vous essayez d’ajouter à la collection n’existe pas sur le Hub.
  • HfHubHTTPError — HTTP 409 si l'élément que vous essayez d'ajouter à la collection est déjà présent dans la collection (et exists_ok=False)

Ajouter un élément à une collection sur le Hub.

Retourne : Collection

Exemple :

>>> from huggingface_hub import add_collection_item
>>> collection = add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="pierre-loic/climate-news-articles",
...     item_type="dataset"
... )
>>> collection.items[-1].item_id
"pierre-loic/climate-news-articles"
# ^item got added to the collection on last position

# Add item with a note
>>> add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="datasets/climate_fever",
...     item_type="dataset",
...     note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet."
... )
(...)

add_space_secret

< >

( repo_id: strkey: strvalue: strdescription: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — ID du dépôt à mettre à jour. Exemple : "bigcode/in-the-stack".
  • key (str) — Clé secrète. Exemple : "GITHUB_API_KEY"
  • value (str) — Valeur secrète. Exemple : "your_github_api_key".
  • description (str, facultatif) — Description du secret. Exemple : "Github API key to access the Github API".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Ajoute ou met à jour un secret dans un Space.

Les secrets permettent de définir des clés ou des jetons secrets pour un Space sans les coder en dur. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

add_space_variable

< >

( repo_id: strkey: strvalue: strdescription: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — ID du dépôt à mettre à jour. Exemple : "bigcode/in-the-stack".
  • key (str) — Clé de la variable. Exemple : "MODEL_REPO_ID"
  • value (str) — Valeur de la variable. Exemple : "the_model_repo_id".
  • description (str) — Description de la variable. Exemple : "Model Repo ID of the implemented model".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Ajoute ou met à jour une variable dans un Space.

Les variables permettent de définir des variables d’environnement pour un Space sans les coder en dur. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

auth_check

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = Nonewrite: bool = False )

Paramètres

  • repo_id (str) — Le dépôt à vérifier pour l'accès. Le format doit être "user/repo_name". Exemple : "user/my-cool-model".
  • repo_type (str, facultatif) — Le type du dépôt. Doit être l’un des éléments suivants : "model", "dataset" ou "space". Si non spécifié, la valeur par défaut est "model".
  • token (Union[bool, str, None], facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.
  • write (bool, facultatif) — Si True, vérifie si l'utilisateur a la permission d'écrire du contenu sur le dépôt. Si False (par défaut), ne vérifie que l'accès en lecture.

Lève

RepositoryNotFoundError ou GatedRepoError

  • RepositoryNotFoundError — Lévé si le dépôt n’existe pas, est privé ou si l’utilisateur n’y a pas accès. Cela peut se produire si le repo_id ou le repo_type est incorrect, ou si le dépôt est privé mais que l’utilisateur n’est pas authentifié.

  • GatedRepoError — Lévé si le dépôt existe mais est protégé et que l'utilisateur n'est pas autorisé à y accéder.

Vérifiez si le jeton utilisateur fourni a accès à un dépôt spécifique sur le Hugging Face Hub.

Cette méthode vérifie si l'utilisateur, authentifié via le jeton fourni, a accès au dépôt spécifié. Si le dépôt n'est pas trouvé ou si l'utilisateur ne dispose pas des autorisations requises pour y accéder, la méthode lève une exception appropriée.

Exemple :

Vérifier si l'utilisateur a accès à un dépôt :

>>> from huggingface_hub import auth_check
>>> from huggingface_hub.utils import GatedRepoError, RepositoryNotFoundError

try:
    auth_check("user/my-cool-model")
except GatedRepoError:
    # Handle gated repository error
    print("You do not have permission to access this gated repository.")
except RepositoryNotFoundError:
    # Handle repository not found error
    print("The repository was not found or you do not have access.")

Dans cet exemple :

  • Si l'utilisateur a accès, la méthode s'exécute avec succès.
  • Si le dépôt est protégé ou n'existe pas, des exceptions appropriées sont levées, permettant à l'utilisateur de les gérer en conséquence.

batch_bucket_files

< >

( bucket_id: stradd: list[tuple[str | Path | bytes, str]] | None = Nonecopy: list[tuple[str, str, str, str]] | None = Nonedelete: list[str] | None = Nonetoken: str | bool | None = None )

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • add (list de tuple, facultatif) — Fichiers à téléverser. Chaque élément est un (source, destination) tuple où source est un chemin vers un fichier local (str ou Path) ou du contenu brut bytes, et destination est le chemin dans le bucket.
  • copy (list de tuple, facultatif) — Fichiers à copier par hachage xet. Chaque élément est un (source_repo_type, source_repo_id, xet_hash, destination) tupple où :
    • source_repo_type est le type du dépôt source : "model", "dataset", "space" ou "bucket".
    • source_repo_id est l'identifiant du dépôt ou du bucket source (par exemple "username/my-model").
    • xet_hash est le hachage xet du fichier à copier.
    • destination est le chemin de destination dans le bucket. Il s'agit d'une opération côté serveur — aucune donnée n'est téléchargée ni réenvoyée.
  • delete (list de str, facultatif) — Chemin des fichiers à supprimer du bucket.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

BucketBatchError

  • BucketBatchError — Si le serveur signale que certaines opérations ont échoué. L’erreur est levée une fois que toutes les opérations ont été envoyées, de sorte que les autres opérations du lot ont été appliquées.

Ajouter, copier et/ou supprimer des fichiers dans un bucket.

Il s’agit d’une opération non transactionnelle. En cas d’erreur, certains fichiers peuvent avoir été téléversés, copiés ou supprimés, tandis que d’autres non.

Exemple :

>>> from huggingface_hub import batch_bucket_files

# Upload files
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[
...         ("./model.safetensors", "models/model.safetensors"),
...         (b'{{"key": "value"}}', "config.json"),
...     ],
... )

# Copy xet files from another bucket or repo (server-side, no data transfer)
>>> batch_bucket_files(
...     "username/my-bucket",
...     copy=[
...         ("bucket", "username/source-bucket", "<xethash_1>", "models/model.safetensors"),
...         ("model", "username/my-model", "<xethash_2>", "models/config.safetensors"),
...     ],
... )

# Delete files
>>> batch_bucket_files("username/my-bucket", delete=["old-model.bin"])

# Upload and delete in one batch
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[("./new.txt", "new.txt")],
...     delete=["old.txt"],
... )

bucket_info

< >

( bucket_id: strtoken: bool | str | None = None ) → BucketInfo

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

BucketInfo

Les informations du seau.

Lève

BucketNotFoundError ou or

  • BucketNotFoundError — Si le bucket ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas,
  • or — car il est défini sur private et que vous n’y avez pas accès.

Obtenir des informations sur un bucket spécifique sur le Hub.

Exemple :

>>> from huggingface_hub import bucket_info
>>> info = bucket_info(bucket_id="Wauplin/first-bucket")
>>> info.id
'Wauplin/first-bucket'
>>> info.private
False
>>> info.created_at
datetime.datetime(2026, 2, 6, 17, 37, 57, tzinfo=datetime.timezone.utc)
>>> info.size
551879671
>>> info.total_files
12

cancel_access_request

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — L’identifiant du dépôt pour lequel annuler la demande d’accès.
  • user (str, facultatif) — Le nom d'utilisateur de l'utilisateur dont la demande d'accès doit être annulée. Il faut fournir exactement l'un des paramètres user ou request_id.
  • request_id (str, facultatif) — L’identifiant de la demande d’accès à annuler (voir AccessRequest). Obligatoire lorsque le dépôt est configuré pour ne pas partager les noms d’utilisateur des demandeurs. Il faut fournir exactement l’un des deux : user ou request_id.
  • repo_type (str, facultatif) — Le type de dépôt pour lequel annuler la demande d’accès. Doit être l’un des éléments suivants : model, dataset ou space. Valeur par défaut : model.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 si le dépôt n'est pas gated.
  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.
  • HfHubHTTPError — HTTP 404 si l'utilisateur n'existe pas sur le Hub.
  • HfHubHTTPError — HTTP 404 si la demande d’accès de l’utilisateur ne peut pas être trouvée.
  • HfHubHTTPError — HTTP 404 si la demande d'accès de l'utilisateur est déjà dans la liste des demandes en attente.

Annuler une demande d'accès d'un utilisateur pour un dépôt gated donné.

Une demande annulée retourne dans la liste des demandes en attente et l'utilisateur perd l'accès au dépôt.

Pour plus d'informations sur les dépôts à accès restreint, consultez https://huggingface.co/docs/hub/models-gated.

cancel_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • job_id (str) — ID du Job.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job est exécuté. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Annuler un Job de calcul sur l’infrastructure Hugging Face.

change_discussion_status

< >

( repo_id: strdiscussion_num: intnew_status: Literal['open', 'closed']token: bool | str | None = Nonecomment: str | None = Nonerepo_type: str | None = None ) → DiscussionStatusChange

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • discussion_num (int) — Le numéro de la Discussion ou de la Pull Request. Doit être un entier strictement positif.
  • new_status (str) — Le nouveau statut de la discussion, soit "open" soit "closed".
  • comment (str, facultatif) — Commentaire facultatif à publier avec la modification de statut.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

DiscussionStatusChange

l'événement de changement d'état

Ferme ou rouvre une Discussion ou une Pull Request.

Exemples :

>>> HfApi().change_discussion_status(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     new_status="closed"
... )
# DiscussionStatusChange(id='deadbeef0000000', type='status-change', ...)

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

discussion

< >

( repo_id: strdiscussion_num: intcomment: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • discussion_num (int) — Le numéro de la Discussion ou de la Pull Request. Doit être un entier strictement positif.
  • comment (str) — The content of the comment to create. Comments support markdown formatting.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Commentaire de discussion

le commentaire nouvellement créé

Crée un nouveau commentaire sur la Discussion donnée.

Exemples :


>>> comment = """
... Hello @otheruser!
...
... # This is a title
...
... **This is bold**, *this is italic* and ~this is strikethrough~
... And [this](http://url) is a link
... """

>>> HfApi().comment_discussion(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     comment=comment
... )
# DiscussionComment(id='deadbeef0000000', type='comment', ...)

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

copy_files

< >

( source: strdestination: strtoken: str | bool | None = None )

Paramètres

  • source (str) — Source location as an hf:// URI. Can be a bucket path (e.g. "hf://buckets/my-bucket/path/to/file") or a repo path (e.g. "hf://username/my-model/weights.bin", "hf://datasets/username/my-dataset/data/").
  • destination (str) — Destination location as an hf:// URI pointing to a bucket (e.g. "hf://buckets/my-bucket/target/path") or a repository (e.g. "hf://username/my-model/target/path").
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

ValueError

  • ValueError — Si les URI source/destination sont invalides ou en cas de copie d'un bucket vers un dépôt.

Copier des fichiers entre des emplacements sur le Hub.

Copier des fichiers depuis un bucket ou un dépôt (modèle, jeu de données, espace) vers un bucket ou un autre dépôt. Les fichiers individuels et les dossiers entiers sont pris en charge.

Lors de la copie de dossiers, un / final dans le chemin source utilise une sémantique de type rsync : copier le contenu du dossier dans la destination, sans imbriquer le dossier source lui-même. Sans / final, le dossier source est imbriqué dans la destination (comme avec cp -r).

Lors de la copie d’un dépôt vers un bucket, les fichiers .gitattributes sont automatiquement exclus, car il s’agit de métadonnées spécifiques à git et sans pertinence dans le contexte d’un bucket.

Les copies de dépôt à dépôt utilisent CommitOperationCopy en interne et créent un commit sur le dépôt de destination. Les copies de bucket à dépôt ne sont pas prises en charge.

Les copies côté serveur ne fonctionnent que dans la même zone de stockage.

Exemple :

>>> from huggingface_hub import copy_files

# Copy a single file between buckets
>>> copy_files("hf://buckets/my-bucket/data.bin", "hf://buckets/other-bucket/data.bin")

# Copy a folder into another bucket (nests: backup/models/...)
>>> copy_files("hf://buckets/my-bucket/models", "hf://buckets/other-bucket/backup/")

# Copy folder contents (trailing /): files go directly into backup/
>>> copy_files("hf://buckets/my-bucket/models/", "hf://buckets/other-bucket/backup/")

# Copy a file from a model repo to a bucket
>>> copy_files("hf://username/my-model/model.safetensors", "hf://buckets/my-bucket/")

# Copy an entire dataset to a bucket
>>> copy_files("hf://datasets/username/my-dataset/", "hf://buckets/my-bucket/datasets/")

# Copy files between repositories
>>> copy_files("hf://username/source-model/", "hf://username/dest-model/")

# Copy a file from one repo to another
>>> copy_files("hf://username/source-model/config.json", "hf://username/dest-model/config.json")

create_branch

< >

( repo_id: strbranch: strrevision: str | None = Nonetoken: bool | str | None = Nonerepo_type: str | None = Noneexist_ok: bool = False )

Paramètres

  • repo_id (str) — Le dépôt dans lequel la branche sera créée. Exemple : "user/my-cool-model".
  • branch (str) — Le nom de la branche à créer.
  • revision (str, facultatif) — La révision git à partir de laquelle créer la branche. Il peut s’agir du nom d’une branche ou de l’OID/SHA d’un commit, sous forme de chaîne hexadécimale. Par défaut, la tête de la branche "main".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors de la création d’une branche sur un dataset ou un space, None ou "model" lors de l’ajout d’une étiquette à un modèle. La valeur par défaut est None.
  • exist_ok (bool, facultatif, par défaut False) — Si True, ne lève pas d'erreur si la branche existe déjà.

Lève

RepositoryNotFoundError ou BadRequestError ou HfHubHTTPError

  • RepositoryNotFoundError — Si le dépôt n’est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • BadRequestError — Si la référence d'une branche est invalide. Ex. : refs/pr/5 ou ‘refs/foo/bar’.
  • HfHubHTTPError — Si la branche existe déjà dans le dépôt (erreur 409) et que exist_ok est défini sur False.

Créez une nouvelle branche pour un dépôt sur le Hub, à partir de la révision spécifiée (par défaut, main). Pour trouver une révision adaptée à vos besoins, vous pouvez utiliser list_repo_refs() ou list_repo_commits().

create_bucket

< >

( bucket_id: strprivate: bool | None = Nonevisibility: Literal['public', 'private'] | None = Noneresource_group_id: str | None = Noneregion: REPO_REGIONS | None = Noneexist_ok: bool = Falsetoken: bool | str | None = None ) → BucketUrl

Paramètres

  • bucket_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de bucket séparés par un /. Si aucun espace de noms n’est fourni, le bucket sera créé dans l’espace de noms de l’utilisateur actuel.
  • private (bool, facultatif) — Indique s'il faut rendre le bucket privé. Si None (par défaut), le bucket sera public sauf si le réglage par défaut de l'organisation est privé. Ne peut pas être passé en même temps que visibility.
  • visibility (Literal["public", "private"], facultatif) — Visibilité du bucket. Peut être "public" ou "private". Si None (par défaut), le bucket sera public sauf si le défaut de l’organisation est privé.
  • resource_group_id (str, facultatif) — Groupe de ressources dans lequel créer le bucket. Les groupes de ressources ne sont disponibles que pour les organisations Enterprise Hub et permettent de définir quels membres de l’organisation peuvent accéder à la ressource. L’identifiant d’un groupe de ressources peut être trouvé dans l’URL de la page de la ressource sur le Hub (p. ex. "66670e5163145ca562cb1988"). Pour en savoir plus sur les groupes de ressources, consultez https://huggingface.co/docs/hub/en/security-resource-groups.
  • region (Literal["us", "eu"], facultatif) — Région cloud dans laquelle créer le bucket. Peut être "us" ou "eu". Si non spécifié, le bucket sera créé dans la région par défaut. Nécessite un abonnement Team ou supérieur.
  • exist_ok (bool, facultatif, par défaut False) — Si True, ne lève pas d'erreur si le bucket existe déjà.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

BucketUrl

URL du nouvellement créé contenant des attributs tels que endpoint, namespace et bucket_id.

Créez un bucket sur le Hub.

Exemple :

>>> from huggingface_hub import create_bucket

>>> url = create_bucket(bucket_id="my-bucket")
>>> url.bucket_id
'user/my-bucket'
>>> url.url
'https://huggingface.co/buckets/user/my-bucket'
>>> url.uri.to_uri()
'hf://buckets/user/my-bucket'

>>> create_bucket(bucket_id="my-bucket", private=True, exist_ok=True)
BucketUrl(...)

>>> create_bucket(bucket_id="my-bucket", region="us")
BucketUrl(...)

create_collection

< >

( title: strnamespace: str | None = Nonedescription: str | None = Noneprivate: bool = Falseresource_group_id: str | None = Noneexists_ok: bool = Falsetoken: bool | str | None = None )

Paramètres

  • title (str) — Titre de la collection à créer. Exemple : "Recent models".
  • namespace (str, facultatif) — Espace de noms de la collection à créer (nom d'utilisateur ou organisation). Par défaut, le nom du propriétaire est utilisé.
  • description (str, facultatif) — Description de la collection à créer. La taille maximale d'une description est de 150 caractères.
  • private (bool, facultatif) — Indique si la collection doit être privée ou non. La valeur par défaut est False (c’est-à-dire collection publique).
  • resource_group_id (str, facultatif) — Affecte la collection à un groupe de ressources de l’organisation propriétaire. Valable uniquement pour les collections appartenant à une organisation. L’identifiant du groupe de ressources est une chaîne hexadécimale de 24 caractères.
  • exists_ok (bool, facultatif) — Si True, ne lève pas d'erreur si la collection existe déjà.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Créez une nouvelle Collection sur le Hub.

Retourne : Collection

Exemple :

>>> from huggingface_hub import create_collection
>>> collection = create_collection(
...     title="ICCV 2023",
...     description="Portfolio of models, papers and demos I presented at ICCV 2023",
... )
>>> collection.slug
"username/iccv-2023-64f9a55bb3115b4f513ec026"

create_commit

< >

( repo_id: stroperations: Iterable[CommitOperation]commit_message: strcommit_description: str | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Nonenum_threads: int = 5parent_commit: str | None = Nonerun_as_future: bool = False_hot_reload: bool | None = None ) → CommitInfo or Future

Paramètres

  • repo_id (str) — Le dépôt dans lequel le commit sera créé, par exemple : "username/custom_transformers"
  • operations (Iterable de ~hf_api.CommitOperation) — Un itérable d'opérations à inclure dans le commit, soit :
    • ~hf_api.CommitOperationAdd pour téléverser un fichier
    • ~hf_api.CommitOperationDelete pour supprimer un fichier
    • ~hf_api.CommitOperationCopy pour copier un fichier

    Les objets d'opération seront modifiés pour inclure des informations relatives à l'envoi. Ne réutilisez pas les mêmes objets pour plusieurs commits.

  • commit_message (str) — Le résumé (première ligne) du commit qui sera créé.
  • commit_description (str, facultatif) — La description du commit qui sera créé
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset", "space" ou "kernel" lors d’un dépôt dans un dépôt de jeu de données, d’espace ou de noyau, None ou "model" lors d’un dépôt dans un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • create_pr (boolean, facultatif) — Indique s'il faut ou non créer une Pull Request avec cet engagement. La valeur par défaut est False. Si revision n'est pas défini, la PR est ouverte contre la branche "main". Si revision est défini et correspond à une branche, la PR est ouverte contre cette branche. Si revision est défini et n'est pas le nom d'une branche (par exemple : un oid d'engagement), une RevisionNotFoundError est renvoyée par le serveur.
  • num_threads (int, facultatif) — Nombre de threads simultanés pour le téléversement des fichiers. Valeur par défaut : 5. Le définir à 2 signifie qu’au maximum 2 fichiers seront téléversés simultanément.
  • parent_commit (str, facultatif) — L’OID / SHA du commit parent, sous forme de chaîne hexadécimale. Les abréviations (7 premiers caractères) sont également prises en charge. Si spécifié et que create_pr est False, le commit échouera si revision ne pointe pas vers parent_commit. Si spécifié et que create_pr est True, la pull request sera créée à partir de parent_commit. Spécifier parent_commit garantit que le dépôt n’a pas été modifié avant l’engagement des modifications, ce qui peut être particulièrement utile si le dépôt est mis à jour / commité simultanément.
  • run_as_future (bool, facultatif) — Indique s'il faut exécuter cette méthode en arrière-plan. Les tâches en arrière-plan sont exécutées séquentiellement sans bloquer le thread principal. Passer run_as_future=True renverra un objet Future. La valeur par défaut est False.

Retourne

CommitInfo ou Future

Instance de CommitInfo contenant des informations sur le nouvel engagement créé (hash de l'engagement, url de l'engagement, url de la PR, message de l'engagement,…). Si run_as_future=True est passé, renvoie un objet Future qui contiendra le résultat lors de son exécution.

Lève

ValueError ou RepositoryNotFoundError

  • ValueError — Si le message de commit est vide.
  • ValueError — Si le commit parent n'est pas un OID de commit valide.
  • ValueError — Si un fichier README.md avec une section de métadonnées invalide est commité. Dans ce cas, le commit échouera tôt, avant de tenter de téléverser un fichier.
  • ValueError — Si create_pr est True et que la révision n'est ni None ni "main".
  • RepositoryNotFoundError — Si le dépôt n’est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.

Crée un commit dans le dépôt indiqué, en supprimant et en téléversant les fichiers au besoin.

La liste d'entrée de CommitOperation sera modifiée pendant le processus de commit. Ne réutilisez pas les mêmes objets pour plusieurs commits.

create_commit suppose que le dépôt existe déjà sur le Hub. En cas d’erreur Client 404, vérifiez que vous êtes authentifié, que votre jeton dispose des autorisations requises et que repo_id et repo_type sont correctement définis. Si le dépôt n’existe pas, créez-le d’abord à l’aide de create_repo().

create_commit est limité à 25 k fichiers LFS et à une charge utile de 1 Go pour les fichiers réguliers.

create_discussion

< >

( repo_id: strtitle: strtoken: bool | str | None = Nonedescription: str | None = Nonerepo_type: str | None = Nonepull_request: bool = False )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • title (str) — Le titre de la discussion. Il peut contenir jusqu’à 200 caractères, et doit en contenir au moins 3. Les espaces en début et en fin de chaîne seront supprimés.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • description (str, facultatif) — Description facultative pour la Pull Request. Valeur par défaut : "Discussion opened with the huggingface_hub Python library"
  • pull_request (bool, facultatif) — Indique s'il faut créer une Pull Request ou une discussion. Si True, crée une Pull Request. Si False, crée une discussion. La valeur par défaut est False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.

Crée une Discussion ou une Pull Request.

Les Pull Requests créées de manière programmatique seront au statut "draft".

La création d'une Pull Request avec des modifications peut également être effectuée en une seule fois avec HfApi.create_commit().

Retourne : DiscussionWithDetails

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

create_inference_endpoint

< >

( name: strrepository: strframework: straccelerator: strinstance_size: strinstance_type: strregion: strvendor: straccount_id: str | None = Noneprivate_link_account_id: str | None = Noneprivate_link_region: str | None = Nonemin_replica: int = 1max_replica: int = 1scaling_metric: InferenceEndpointScalingMetric | None = Nonescaling_threshold: float | None = Nonescale_to_zero_timeout: int | None = Nonerevision: str | None = Nonetask: str | None = Nonecustom_image: dict | None = Nonecontainer_registry_username: str | None = Nonecontainer_registry_password: str | None = Nonecontainer_command: list[str] | None = Nonecontainer_args: list[str] | None = Noneenv: dict[str, str] | None = Nonesecrets: dict[str, str] | None = Nonetype: InferenceEndpointType | str = <InferenceEndpointType.AUTHENTICATED: 'authenticated'>domain: str | None = Nonepath: str | None = Nonecache_http_responses: bool | None = Nonetags: list[str] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Paramètres

  • name (str) — Le nom unique de la nouvelle Inference Endpoint.
  • repository (str) — Le nom du dépôt de modèle associé à l'Inference Endpoint (par exemple "gpt2").
  • framework (str) — Le framework d'apprentissage automatique utilisé pour le modèle (par exemple "custom").
  • accelerator (str) — L'accélérateur matériel à utiliser pour l'inférence (par exemple "cpu").
  • instance_size (str) — La taille ou le type d’instance à utiliser pour l’hébergement du modèle (par ex. "x4").
  • instance_type (str) — Le type d’instance cloud sur lequel l’Inference Endpoint sera déployé (par ex. "intel-icl").
  • region (str) — La région cloud dans laquelle le point de terminaison d'inférence sera créé (par exemple "us-east-1").
  • vendor (str) — Le fournisseur cloud ou le fournisseur chez lequel l’Inference Endpoint sera hébergé (par ex. "aws").
  • account_id (str, facultatif) — Obsolète et ignoré. Utilisez private_link_account_id et private_link_region pour configurer AWS PrivateLink.
  • private_link_account_id (str, facultatif) — L’identifiant du compte AWS autorisé à accéder au point de terminaison d’inférence via AWS PrivateLink. Nécessite private_link_region.
  • private_link_region (str, facultatif) — La région AWS du point d’entrée PrivateLink ("us-east-1" ou "eu-west-1"), où l’endpoint VPC de private_link_account_id se connectera. Indépendant de la region et du vendor de calcul.
  • min_replica (int, facultatif) — Le nombre minimal de répliques (instances) à maintenir en cours d’exécution pour le point de terminaison d’inférence. Pour activer le passage à zéro, définissez cette valeur sur 0 et ajustez scale_to_zero_timeout en conséquence. Valeur par défaut : 1.
  • max_replica (int, facultatif) — Nombre maximal de répliques (instances) vers lequel mettre à l'échelle l'Inference Endpoint. Valeur par défaut : 1.
  • scaling_metric (str ou InferenceEndpointScalingMetric , facultatif) — La référence de la métrique de mise à l’échelle. Soit « pendingRequests », soit « hardwareUsage » lorsqu’elle est fournie. Valeur par défaut : None (ce qui signifie : laisser le service HF Endpoints spécifier la métrique).
  • scaling_threshold (float, facultatif) — Seuil de la métrique de mise à l'échelle utilisé pour déclencher une augmentation de la capacité. Ignoré si la métrique de mise à l'échelle n'est pas fournie. Valeur par défaut : None (ce qui signifie : laisser le service HF Endpoints définir le seuil).
  • scale_to_zero_timeout (int, facultatif) — Durée en minutes avant qu’un point de terminaison inactif soit réduit à zéro, ou aucune réduction à zéro si défini sur None et que min_replica n’est pas 0. Valeur par défaut : None.
  • revision (str, facultatif) — La révision spécifique du modèle à déployer sur l’Inference Endpoint (par exemple "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, facultatif) — La tâche sur laquelle déployer le modèle (par ex. "text-classification").
  • custom_image (dict, facultatif) — L’image conteneur à exécuter. Soit un dictionnaire indexé par variante d’image (par ex. {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, également sGLang, tgi, tei, llamacpp, hfServe, …), qui est transmis tel quel, soit un dictionnaire plat décrivant un conteneur personnalisé (par ex. {"url": ..., "port": ...}), qui est envoyé sous la forme {"custom": ...} (voir les exemples). Par défaut, l’image gérée par Hugging Face est utilisée.
  • container_registry_username (str, facultatif) — Nom d’utilisateur utilisé pour s’authentifier auprès du registre hébergeant une image de conteneur personnalisée.
  • container_registry_password (str, facultatif) — Mot de passe utilisé pour s’authentifier auprès du registre hébergeant une image de conteneur personnalisée. Nécessite container_registry_username. Omis de la charge utile de l’API lorsqu’il n’est pas fourni.
  • container_command (list[str], facultatif) — Remplace la commande d’entrée du conteneur (correspond à model.command dans la charge utile de l’API). Fonctionne avec les images d’ingénierie gérées (par exemple vLLM, SGLang) et les images personnalisées.
  • container_args (list[str], facultatif) — Arguments ajoutés à l’entrypoint du conteneur (correspond à model.args dans la charge utile de l’API). Fonctionne avec les images d’engine gérées (par exemple vLLM, SGLang) et les images personnalisées.
  • env (dict[str, str], facultatif) — Variables d’environnement non confidentielles à injecter dans l’environnement du conteneur.
  • secrets (dict[str, str], facultatif) — Valeurs secrètes à injecter dans l'environnement du conteneur.
  • type ([`InferenceEndpointType], *optional*) -- The type of the Inference Endpoint, which can be “authenticated”(default),“public”or“private”`.
  • domain (str, facultatif) — Le domaine personnalisé pour le déploiement de l'Inference Endpoint. S'il est configuré, l'Inference Endpoint sera accessible à ce domaine (par exemple "my-new-domain.cool-website.woof").
  • path (str, facultatif) — Le chemin personnalisé vers le modèle déployé, doit commencer par / (par ex. "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, facultatif) — Indique s'il faut mettre en cache les réponses HTTP de l'Inference Endpoint. La valeur par défaut est False.
  • tags (list[str], facultatif) — Une liste de tags à associer à l'Inference Endpoint.
  • namespace (str, facultatif) — L’espace de noms dans lequel le point de terminaison d’inférence sera créé. Par défaut, l’espace de noms de l’utilisateur actuel est utilisé.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

InferenceEndpoint

informations sur le point d'inférence mis à jour.

Créer un nouveau point de terminaison d'inférence.

Les valeurs de accelerator, instance_size, instance_type, region et vendor sont interdépendantes ; utilisez list_inference_endpoints_hardware() pour lister les combinaisons valides.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "my-endpoint-name",
...     repository="gpt2",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint
InferenceEndpoint(name='my-endpoint-name', status="pending",...)

# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
"..."
# Start an Inference Endpoint running Zephyr-7b-beta on TGI
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "aws-zephyr-7b-beta-0486",
...     repository="HuggingFaceH4/zephyr-7b-beta",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="gpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x1",
...     instance_type="nvidia-a10g",
...     env={
...           "MAX_BATCH_PREFILL_TOKENS": "2048",
...           "MAX_INPUT_LENGTH": "1024",
...           "MAX_TOTAL_TOKENS": "1512",
...           "MODEL_ID": "/repository"
...         },
...     custom_image={
...         "healthRoute": "/health",
...         "url": "ghcr.io/huggingface/text-generation-inference:1.1.0",
...     },
...    secrets={"MY_SECRET_KEY": "secret_value"},
...    tags=["dev", "text-generation"],
... )
# Start an Inference Endpoint running ProsusAI/finbert while scaling to zero in 15 minutes
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "finbert-classifier",
...     repository="ProsusAI/finbert",
...     framework="pytorch",
...     task="text-classification",
...     min_replica=0,
...     scale_to_zero_timeout=15,
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint.wait(timeout=300)
# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
TextClassificationOutputElement(label='positive', score=0.8983615040779114)

create_inference_endpoint_from_catalog

< >

( repo_id: str | None = Nonerecipe_id: str | None = Nonename: str | None = Noneaccelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = Nonegguf_file: str | None = Nonetoken: bool | str | None = Nonenamespace: str | None = None ) → InferenceEndpoint

Paramètres

  • repo_id (str, facultatif) — L’identifiant du modèle dans le catalogue à déployer en tant qu’Inference Endpoint. Mutuellement exclusif avec recipe_id.
  • recipe_id (str, facultatif) — L’identifiant de la recette du catalogue à déployer (voir InferenceCatalogRecipe). Mutuellement exclusif avec repo_id.
  • name (str, facultatif) — Le nom unique de la nouvelle Inference Endpoint. S'il n'est pas fourni, un nom aléatoire sera généré.
  • accelerator (str, facultatif) — L'accélérateur matériel à utiliser pour l'inférence. Les valeurs possibles incluent "cpu", "gpu" et "neuron". S'il n'est pas fourni, le serveur utilisera une valeur par défaut appropriée au modèle. Valable uniquement avec repo_id.
  • gguf_file (str, facultatif) — Le fichier GGUF à déployer, pour les modèles qui ont une recette par quantification (par ex. "Qwen2.5-Coder-32B-Instruct-Q4_K_M.gguf"). Valable uniquement avec repo_id.
  • token (bool ou str, facultatif) — Un jeton d'accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l'authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication).
  • namespace (str, facultatif) — L’espace de noms dans lequel le point de terminaison d’inférence sera créé. Par défaut, l’espace de noms de l’utilisateur actuel est utilisé.

Retourne

InferenceEndpoint

informations sur le nouveau point de terminaison d'inférence.

Créez un nouveau point de terminaison d'inférence à partir du catalogue d'inférence Hugging Face.

L'objectif du catalogue d'inférence est de fournir une liste de modèles sélectionnés, optimisés pour l'inférence et dont les configurations par défaut ont été testées. Consultez https://huggingface.co/proxy/endpoints.huggingface.co/catalog pour obtenir la liste des modèles disponibles dans le catalogue.

Chaque modèle du catalogue est déployé via une recette : une combinaison de matériel et de moteur testée pour ce modèle. Passez repo_id pour déployer la recette par défaut d’un modèle, éventuellement restreinte avec accelerator et gguf_file, ou passez recipe_id pour déployer une recette exacte listée par list_inference_catalog().

create_inference_endpoint_from_catalog est expérimental. Son API est susceptible d’évoluer à l’avenir. Merci de nous faire part de vos retours si vous avez des suggestions ou des demandes.

create_pull_request

< >

( repo_id: strtitle: strtoken: bool | str | None = Nonedescription: str | None = Nonerepo_type: str | None = None )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • title (str) — Le titre de la discussion. Il peut contenir jusqu’à 200 caractères, et doit en contenir au moins 3. Les espaces en début et en fin de chaîne seront supprimés.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • description (str, facultatif) — Description facultative pour la Pull Request. Valeur par défaut : "Discussion opened with the huggingface_hub Python library"
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.

Crée une Pull Request. Les Pull Requests créées de manière programmatique seront au statut "draft".

La création d'une Pull Request avec des modifications peut également être effectuée en une seule fois avec HfApi.create_commit() ;

Ceci est un wrapper autour de HfApi.create_discussion().

Retourne : DiscussionWithDetails

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

create_repo

< >

( repo_id: strtoken: str | bool | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonerepo_type: str | None = Noneexist_ok: bool = Falseresource_group_id: str | None = Noneregion: REPO_REGIONS | None = Nonespace_sdk: str | None = Nonespace_hardware: SpaceHardware | None = Nonespace_sleep_time: int | None = Nonespace_secrets: list[dict[str, str]] | None = Nonespace_variables: list[dict[str, str]] | None = Nonespace_volumes: list[Volume] | None = Nonespace_template: str | None = None ) → RepoUrl

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • private (bool, facultatif) — Indique s'il faut rendre le dépôt privé. Si None (par défaut), le dépôt sera public sauf si le paramètre par défaut de l'organisation est privé. Cette valeur est ignorée si le dépôt existe déjà. Ne peut pas être transmis avec visibility.
  • visibility (Literal["public", "private", "protected"], facultatif) — Visibilité du dépôt. Peut être "public" ou "private", ou "protected" pour les Spaces. Si None (par défaut), le dépôt sera public sauf si le défaut de l’organisation est privé. Cette valeur est ignorée si le dépôt existe déjà.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • exist_ok (bool, facultatif, par défaut False) — Si True, ne lève pas d'erreur si le dépôt existe déjà.
  • resource_group_id (str, facultatif) — Groupe de ressources dans lequel créer le dépôt. Les groupes de ressources ne sont disponibles que pour les organisations Enterprise du Hub et permettent de définir quels membres de l’organisation peuvent accéder à la ressource. L’identifiant d’un groupe de ressources peut être trouvé dans l’URL de la page de la ressource sur le Hub (par exemple "66670e5163145ca562cb1988"). Pour en savoir plus sur les groupes de ressources, consultez https://huggingface.co/docs/hub/en/security-resource-groups.
  • region (Literal["us", "eu"], facultatif) — Région cloud dans laquelle créer le dépôt. Peut être "us" ou "eu". Si non spécifié, le dépôt sera créé dans la région par défaut. Nécessite un abonnement Team ou supérieur.
  • space_sdk (str, facultatif) — Choix du SDK à utiliser si repo_type est « space ». Peut être « streamlit », « gradio », « docker » ou « static ». Les Spaces "static" sont gratuits pour tous. Les autres SDKs s’exécutent sur du calcul : sur le matériel gratuit cpu-basic, ils nécessitent un abonnement (PRO pour les utilisateurs, Team ou Enterprise pour les organisations), tandis que le matériel payant ne requiert que la facturation (un moyen de paiement et des crédits prépayés).
  • space_hardware (SpaceHardware ou str, facultatif) — Choix du matériel si repo_type est “space”. Consultez SpaceHardware pour la liste complète.
  • space_sleep_time (int, facultatif) — Nombre de secondes d’inactivité à attendre avant qu’un Space ne passe en veille. Définissez la valeur sur -1 si vous ne souhaitez pas que votre Space passe en veille (comportement par défaut pour le matériel mis à niveau). Pour le matériel gratuit, vous ne pouvez pas configurer la durée de veille (la valeur est fixée à 48 heures d’inactivité). Voir https://huggingface.co/docs/hub/spaces-gpus#sleep-time pour plus de détails.
  • space_secrets (list[dict[str, str]], facultatif) — Une liste de clés secrètes à définir dans votre Space. Chaque élément est de la forme {"key": ..., "value": ..., "description": ...} où description est facultatif. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets.
  • space_variables (list[dict[str, str]], facultatif) — Une liste de variables d’environnement publiques à définir dans votre Space. Chaque élément est de la forme {"key": ..., "value": ..., "description": ...} où description est facultatif. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.
  • space_volumes (list[Volume], facultatif) — Une liste d’objets Volume à monter dans le Space lors de sa création. Chaque volume possède un type ("bucket", "model", "dataset" ou "space"), un source (identifiant du dépôt ou du bucket), un mount_path (chemin à l’intérieur du conteneur) ainsi que les champs facultatifs revision, read_only et path. Applicable uniquement si repo_type est « space ».
  • space_template (str, facultatif) — Crée le nouvel espace à partir d’un modèle officiel. Peut être l’identifiant du dépôt du modèle (p. ex. "SpacesExamples/jupyterlab") ou son nom court (p. ex. "JupyterLab"). Utilisez HfApi.list_space_templates() pour lister les modèles disponibles. Applicable uniquement si repo_type est « space ». Si le modèle est recommandé comme privé et que la visibilité n’est pas explicitement définie, l’espace est créé en privé.

Retourne

RepoUrl

URL du dépôt nouvellement créé. La valeur est une sous-classe de str contenant des attributs tels que endpoint, repo_type et repo_id.

Créez un dépôt vide sur le HuggingFace Hub.

create_scheduled_job

< >

( image: strcommand: list[str]schedule: strsuspend: bool | None = Noneconcurrency: bool | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • image (str) — L’image Docker à utiliser. Exemples : "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Exemple avec une image d’un Space : "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — La commande à exécuter. Exemple : ["echo", "hello"].
  • schedule (str) — L’un des éléments suivants : “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, ou une expression d’horaire CRON (par exemple, ‘0 9 * * 1’ pour 9 h chaque lundi).
  • suspend (bool, facultatif) — Si True, le Job planifié est suspendu (mis en pause). Valeur par défaut : False.
  • concurrency (bool, facultatif) — Si True, plusieurs instances de ce Job peuvent s’exécuter simultanément. Valeur par défaut : False.
  • env (dict[str, Any], facultatif) — Définit les variables d’environnement pour le Job.
  • secrets (dict[str, Any], facultatif) — Définit les variables d’environnement secrètes pour le Job.
  • flavor (str, facultatif) — Flavor pour le matériel. Consultez JobHardware pour les valeurs possibles. Valeur par défaut : "cpu-basic".
  • timeout (Union[int, float, str], facultatif) — Durée maximale du Job : int avec s (secondes, par défaut), m (minutes), h (heures) ou d (jours). Exemple : 300 ou "5m" pour 5 minutes.
  • attempts (int, facultatif) — Nombre maximal de tentatives pour chaque exécution, y compris la tentative initiale. Valeur par défaut : 1.
  • name (str, facultatif) — Un nom pour le Job planifié. Stocké en tant que libellé name. Ne peut pas être transmis conjointement avec une clé name dans labels. Les noms n’ont pas à être uniques. Par défaut, un nom est dérivé de l’image et de la commande (avec un suffixe de hachage court).
  • labels (dict[str, str], facultatif) — Étiquettes à associer au travail (paires clé-valeur).
  • volumes (list[Volume], facultatif) — Buckets ou dépôts Hugging Face à monter en tant que volumes dans le conteneur du job. Chaque volume est un Volume avec type ("bucket", "model", "dataset" ou "space"), source (par ex. "username/my-bucket") et mount_path (par ex. "/data").
  • expose (list[int], facultatif) — Ports de conteneur à exposer via le proxy des jobs. Chaque port listé est accessible sur le domaine public des jobs (par ex. https://<job_id>--8000.hf.jobs). L’accès nécessite toujours un jeton HF avec un accès en lecture à l’espace de noms du job. Utilisez expose_public pour un accès non authentifié.
  • expose_public (list[int], facultatif) — Ports à exposer via le proxy des Jobs sans authentification. Ils n’ont pas besoin d’être listés dans expose.
  • resource_group_id (str, facultatif) — L’identifiant du groupe de ressources dans lequel créer le Job planifié. Utilisé pour contrôler l’accès aux ressources au sein d’une organisation et pour les fonctionnalités d’attribution des coûts et de limites de dépenses. S’il n’est pas fourni, le Job planifié est créé en dehors de tout groupe de ressources.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job sera créé. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Créez des Jobs de calcul planifiés sur l’infrastructure Hugging Face.

Exemple :

Créez votre premier Job planifié :

>>> from huggingface_hub import create_scheduled_job
>>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly")

Utiliser une expression d’horloge CRON :

>>> from huggingface_hub import create_scheduled_job
>>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('this runs every 5min')"], schedule="*/5 * * * *")

Créer un Job GPU planifié :

>>> from huggingface_hub import create_scheduled_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> create_scheduled_job(image=image, command=command, flavor="a10g-small", schedule="@hourly")

create_scheduled_uv_job

< >

( script: strscript_args: list[str] | None = Noneschedule: strsuspend: bool | None = Noneconcurrency: bool | None = Nonedependencies: list[str] | None = Nonepython: str | None = Noneimage: str | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • script (str) — Chemin ou URL du script UV, ou une commande.
  • script_args (list[str], facultatif) — Arguments à passer au script ou à la commande.
  • schedule (str) — L’un des éléments suivants : “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, ou une expression d’horaire CRON (par exemple, ‘0 9 * * 1’ pour 9 h chaque lundi).
  • suspend (bool, facultatif) — Si True, le Job planifié est suspendu (mis en pause). Valeur par défaut : False.
  • concurrency (bool, facultatif) — Si True, plusieurs instances de ce Job peuvent s’exécuter simultanément. Valeur par défaut : False.
  • dependencies (list[str], facultatif) — Dépendances à utiliser pour exécuter le script UV.
  • python (str, facultatif) — Utiliser une version spécifique de Python. La valeur par défaut est 3.12.
  • image (str, facultatif, par défaut “ghcr.io/astral-sh/uv —python3.12-bookworm”) : Utiliser une image Docker personnalisée avec uv installé.
  • env (dict[str, Any], facultatif) — Définit les variables d’environnement pour le Job.
  • secrets (dict[str, Any], facultatif) — Définit les variables d’environnement secrètes pour le Job.
  • flavor (str, facultatif) — Flavor pour le matériel. Consultez JobHardware pour les valeurs possibles. Valeur par défaut : "cpu-basic".
  • timeout (Union[int, float, str], facultatif) — Durée maximale du Job : int avec s (secondes, par défaut), m (minutes), h (heures) ou d (jours). Exemple : 300 ou "5m" pour 5 minutes.
  • attempts (int, facultatif) — Nombre maximal de tentatives pour chaque exécution, y compris la tentative initiale. Valeur par défaut : 1.
  • name (str, facultatif) — Un nom pour le Job planifié. Stocké en tant que libellé name. Ne peut pas être transmis conjointement avec une clé name dans labels. Les noms n'ont pas besoin d'être uniques. Par défaut, un nom est dérivé du script et de ses arguments (avec un suffixe de hachage court).
  • labels (dict[str, str], facultatif) — Étiquettes à associer au travail (paires clé-valeur).
  • volumes (list[Volume], facultatif) — Buckets ou dépôts Hugging Face à monter en tant que volumes dans le conteneur du job. Chaque volume est un Volume avec type ("bucket", "model", "dataset" ou "space"), source (par ex. "username/my-bucket") et mount_path (par ex. "/data").
  • expose (list[int], facultatif) — Ports de conteneur à exposer via le proxy des jobs. Chaque port listé est accessible sur le domaine public des jobs (par ex. https://<job_id>--8000.hf.jobs). L’accès nécessite toujours un jeton HF avec un accès en lecture à l’espace de noms du job. Utilisez expose_public pour un accès non authentifié.
  • expose_public (list[int], facultatif) — Ports à exposer via le proxy des Jobs sans authentification. Ils n’ont pas besoin d’être listés dans expose.
  • resource_group_id (str, facultatif) — L’identifiant du groupe de ressources dans lequel créer le Job planifié. Utilisé pour contrôler l’accès aux ressources au sein d’une organisation et pour les fonctionnalités d’attribution des coûts et de limites de dépenses. S’il n’est pas fourni, le Job planifié est créé en dehors de tout groupe de ressources.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job sera créé. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Exécuter un Job de script UV sur l’infrastructure Hugging Face.

Contrairement à hf jobs uv run, cette méthode ignore la table optionnelle [tool.hf-jobs] qu'un script UV peut contenir dans son en-tête PEP 723 (voir le guide des Jobs) : la configuration de lancement doit être transmise explicitement ici.

Exemple :

Planifier un script à partir d'une URL :

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")

Planifier un script local :

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")

Planifier une commande :

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "lighteval"
>>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small", schedule="@weekly")

create_tag

< >

( repo_id: strtag: strtag_message: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonerepo_type: str | None = Noneexist_ok: bool = False )

Paramètres

  • repo_id (str) — Le dépôt dans lequel un commit sera étiqueté. Exemple : "user/my-cool-model".
  • tag (str) — Le nom de la balise à créer.
  • tag_message (str, facultatif) — La description de la balise à créer.
  • revision (str, facultatif) — La révision git à étiqueter. Il peut s’agir du nom d’une branche ou de l’OID/SHA d’un commit, sous forme de chaîne hexadécimale. Les abréviations (7 premiers caractères) sont également prises en charge. Par défaut, la tête de la branche "main".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" pour étiqueter un jeu de données ou un espace, None ou "model" pour étiqueter un modèle. La valeur par défaut est None.
  • exist_ok (bool, facultatif, par défaut False) — Si True, ne lève pas d'erreur si le tag existe déjà.

Lève

RepositoryNotFoundError ou RevisionNotFoundError ou HfHubHTTPError

  • RepositoryNotFoundError — Si le dépôt n’est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • RevisionNotFoundError — Si la révision n’est pas trouvée (erreur 404) dans le dépôt.
  • HfHubHTTPError — Si la branche existe déjà dans le dépôt (erreur 409) et que exist_ok est défini sur False.

Étiqueter un commit donné d'un dépôt sur le Hub.

create_webhook

< >

( url: str | None = Nonejob_id: str | None = Nonewatched: list[dict | WebhookWatchedItem]domains: list[constants.WEBHOOK_DOMAIN_T] | None = Nonesecret: str | None = Nonesecrets: dict[str, str] | None = Nonetoken: bool | str | None = None ) → WebhookInfo

Paramètres

  • url (str) — URL à laquelle envoyer la charge utile.
  • job_id (str) — ID du Job source à déclencher avec la charge utile du webhook dans la variable d’environnement WEBHOOK_PAYLOAD. Des variables d’environnement supplémentaires sont disponibles pour plus de commodité : WEBHOOK_REPO_ID, WEBHOOK_REPO_TYPE et WEBHOOK_SECRET.
  • watched (list[WebhookWatchedItem]) — Liste de WebhookWatchedItem à surveiller par le webhook. Il peut s’agir d’utilisateurs, d’organisations, de modèles, de jeux de données, d’espaces ou de buckets. Les éléments surveillés peuvent également être fournis sous forme de dictionnaires simples.
  • domains (list[Literal["repo", "discussion"]], optionnel) — Liste des domaines à surveiller. Peut être « repo », « discussion » ou les deux. Par défaut, les deux.
  • secret (str, optionnel) — Un secret pour signer la charge utile.
  • secrets (dict[str, str], optionnel) — Variables d’environnement secrètes pour le Job déclenché par le webhook (par ex. {"HF_TOKEN": "hf_***"}). Valable uniquement avec job_id. Les secrets du Job source ne sont pas copiés vers le webhook, il faut donc les passer ici.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

WebhookInfo

Informations sur le webhook nouvellement créé.

Créer un nouveau webhook.

Le webhook peut soit envoyer une charge utile à une URL, soit déclencher l’exécution d’un Job sur l’infrastructure Hugging Face. Cette fonction doit être appelée avec url ou job_id, mais pas les deux.

Exemple :

Créer un webhook qui envoie une charge utile vers une URL

>>> from huggingface_hub import create_webhook
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

Exécuter un Job puis créer un webhook qui déclenche ce Job

>>> from huggingface_hub import create_webhook, run_job
>>> job = run_job(
...     image="ubuntu",
...     command=["bash", "-c", r"echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD"],
... )
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     job_id=job.id,
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url=None,
    job=JobSpec(
        docker_image='ubuntu',
        space_id=None,
        command=['bash', '-c', 'echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD'],
        arguments=[],
        environment={},
        secrets=[],
        flavor='cpu-basic',
        timeout=None,
        tags=None,
        arch=None
    ),
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

dataset_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandDatasetProperty_T] | None = Nonetoken: bool | str | None = None ) → hf_api.DatasetInfo

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • revision (str, facultatif) — La révision du dépôt de données à partir duquel obtenir les informations.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.
  • files_metadata (bool, facultatif) — Indique s'il faut ou non récupérer les métadonnées des fichiers du dépôt (taille, métadonnées LFS, etc.). La valeur par défaut est False.
  • expand (list[ExpandDatasetProperty_T], facultatif) — Liste des propriétés à retourner dans la réponse. Lorsqu’il est utilisé, seules les propriétés de la liste seront retournées. Ce paramètre ne peut pas être utilisé si files_metadata est passé. Les valeurs possibles sont "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage" et "resourceGroup".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

hf_api.DatasetInfo

Les informations du dépôt de jeu de données.

Obtenir des informations sur un jeu de données spécifique sur huggingface.co.

Le jeu de données peut être privé si vous passez un jeton acceptable.

Lève les erreurs suivantes :

  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError Si la révision à télécharger n'est pas trouvée.

delete_branch

< >

( repo_id: strbranch: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Paramètres

  • repo_id (str) — Le dépôt dans lequel une branche sera supprimée. Exemple : "user/my-cool-model".
  • branch (str) — Le nom de la branche à supprimer.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors de la création d’une branche sur un dataset ou un space, None ou "model" lors de l’ajout d’une étiquette à un modèle. La valeur par défaut est None.

Lève

RepositoryNotFoundError ou HfHubHTTPError

  • RepositoryNotFoundError — Si le dépôt n’est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • HfHubHTTPError — Lors de la tentative de suppression d'une branche protégée. Ex. : main ne peut pas être supprimée.
  • HfHubHTTPError — Lors de la tentative de suppression d'une branche qui n'existe pas.

Supprimer une branche d’un dépôt sur le Hub.

delete_bucket

< >

( bucket_id: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • missing_ok (bool, facultatif, par défaut False) — Si True, ne lève pas d'erreur si le bucket n'existe pas.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

BucketNotFoundError

  • BucketNotFoundError — Si le bucket ne peut pas être trouvé et que missing_ok est défini sur False (par défaut).

Supprimer un bucket du Hub.

Exemple :

>>> from huggingface_hub import delete_bucket
>>> delete_bucket(bucket_id="Wauplin/first-bucket")
>>> delete_bucket(bucket_id="Wauplin/first-bucket", missing_ok=True)

delete_collection

< >

( collection_slug: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Paramètres

  • collection_slug (str) — Slug de la collection à supprimer. Exemple : "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • missing_ok (bool, facultatif) — Si True, ne lève pas d'erreur si la collection n'existe pas.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Supprimer une collection sur le Hub.

Exemple :

>>> from huggingface_hub import delete_collection
>>> collection = delete_collection("username/useless-collection-64f9a55bb3115b4f513ec026", missing_ok=True)

Cette action est irréversible. Une collection supprimée ne peut pas être restaurée.

delete_collection_item

< >

( collection_slug: stritem_object_id: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Paramètres

  • collection_slug (str) — Slug de la collection à mettre à jour. Exemple : "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — ID de l'élément dans la collection. Il ne s'agit pas de l'ID de l'élément sur le Hub (repo_id ou paper id). Il doit être récupéré depuis un objet CollectionItem. Exemple : collection.items[0].item_object_id.
  • missing_ok (bool, facultatif) — Si True, ne lève pas d'erreur si l'élément n'existe pas.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Supprimer un élément d'une collection.

Exemple :

>>> from huggingface_hub import get_collection, delete_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Delete item based on its ID
>>> delete_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
... )

delete_file

< >

( path_in_repo: strrepo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Paramètres

  • path_in_repo (str) — Chemin de fichier relatif dans le dépôt, par exemple : "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — Le dépôt d'où le fichier sera supprimé, par exemple : "username/custom_transformers"
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si le fichier se trouve dans un dataset ou un space, None ou "model" s’il se trouve dans un model. La valeur par défaut est None.
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • commit_message (str, facultatif) — Le résumé / titre / première ligne du commit généré. Par défaut, f"Delete {path_in_repo} with huggingface_hub".
  • commit_description (str, facultatif) — La description du commit généré
  • create_pr (boolean, facultatif) — Indique s'il faut ou non créer une Pull Request avec cet engagement. La valeur par défaut est False. Si revision n'est pas défini, la PR est ouverte contre la branche "main". Si revision est défini et correspond à une branche, la PR est ouverte contre cette branche. Si revision est défini et n'est pas le nom d'une branche (par exemple : un oid d'engagement), une RevisionNotFoundError est renvoyée par le serveur.
  • parent_commit (str, facultatif) — L’OID / SHA du commit parent, sous forme de chaîne hexadécimale. Les abréviations (7 premiers caractères) sont également prises en charge. Si spécifié et que create_pr est False, le commit échouera si revision ne pointe pas vers parent_commit. Si spécifié et que create_pr est True, la pull request sera créée à partir de parent_commit. Spécifier parent_commit garantit que le dépôt n’a pas été modifié avant l’engagement des modifications, ce qui peut être particulièrement utile si le dépôt est mis à jour / commité simultanément.

Supprime un fichier dans le dépôt indiqué.

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError Si la révision à télécharger n'est pas trouvée.
  • EntryNotFoundError Si le fichier à télécharger ne peut pas être trouvé.

delete_files

< >

( repo_id: strdelete_patterns: list[str]token: bool | str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Paramètres

  • repo_id (str) — Le dépôt à partir duquel le dossier sera supprimé, par exemple : "username/custom_transformers"
  • delete_patterns (list[str]) — Liste de fichiers ou de dossiers à supprimer. Chaque chaîne peut être un chemin de fichier, un chemin de dossier ou un motif générique. Les motifs sont des Wildcards standard (motifs globbing) documentés ici. La correspondance des motifs est basée sur fnmatch. Notez que fnmatch fait correspondre * à travers les limites de chemin, contrairement au globbing traditionnel des shells Unix. Par exemple, ["file.txt", "folder/", "data/*.parquet"]
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False. au jeton stocké.
  • repo_type (str, facultatif) — Type du dépôt dont supprimer les fichiers. Peut être "model", "dataset" ou "space". La valeur par défaut est "model".
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • commit_message (str, facultatif) — Le résumé (première ligne) du commit généré. Par défaut, f"Delete files using huggingface_hub".
  • commit_description (str, facultatif) — La description du commit généré.
  • create_pr (boolean, facultatif) — Indique s'il faut ou non créer une Pull Request avec cet engagement. La valeur par défaut est False. Si revision n'est pas défini, la PR est ouverte contre la branche "main". Si revision est défini et correspond à une branche, la PR est ouverte contre cette branche. Si revision est défini et n'est pas le nom d'une branche (par exemple : un oid d'engagement), une RevisionNotFoundError est renvoyée par le serveur.
  • parent_commit (str, facultatif) — L’OID / SHA du commit parent, sous forme de chaîne hexadécimale. Les abréviations (7 premiers caractères) sont également prises en charge. Si spécifié et que create_pr est False, le commit échouera si revision ne pointe pas vers parent_commit. Si spécifié et que create_pr est True, la pull request sera créée à partir de parent_commit. Spécifier parent_commit garantit que le dépôt n’a pas été modifié avant l’engagement des modifications, ce qui peut être particulièrement utile si le dépôt est mis à jour / commité simultanément.

Supprimer des fichiers d’un dépôt sur le Hub.

Si un chemin de dossier est fourni, l'intégralité du dossier est supprimée, ainsi que tous les fichiers qu'il contenait.

delete_folder

< >

( path_in_repo: strrepo_id: strtoken: bool | str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Paramètres

  • path_in_repo (str) — Chemin de dossier relatif dans le dépôt, par exemple : "checkpoints/1fec34a".
  • repo_id (str) — Le dépôt à partir duquel le dossier sera supprimé, par exemple : "username/custom_transformers"
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False. au jeton stocké.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si le dossier se trouve dans un dataset ou un space, None ou "model" s’il se trouve dans un model. La valeur par défaut est None.
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • commit_message (str, facultatif) — Le résumé / titre / première ligne du commit généré. Par défaut, f"Delete folder {path_in_repo} with huggingface_hub".
  • commit_description (str, facultatif) — La description du commit généré.
  • create_pr (boolean, facultatif) — Indique s'il faut ou non créer une Pull Request avec cet engagement. La valeur par défaut est False. Si revision n'est pas défini, la PR est ouverte contre la branche "main". Si revision est défini et correspond à une branche, la PR est ouverte contre cette branche. Si revision est défini et n'est pas le nom d'une branche (par exemple : un oid d'engagement), une RevisionNotFoundError est renvoyée par le serveur.
  • parent_commit (str, facultatif) — L’OID / SHA du commit parent, sous forme de chaîne hexadécimale. Les abréviations (7 premiers caractères) sont également prises en charge. Si spécifié et que create_pr est False, le commit échouera si revision ne pointe pas vers parent_commit. Si spécifié et que create_pr est True, la pull request sera créée à partir de parent_commit. Spécifier parent_commit garantit que le dépôt n’a pas été modifié avant l’engagement des modifications, ce qui peut être particulièrement utile si le dépôt est mis à jour / commité simultanément.

Supprime un dossier dans le dépôt indiqué.

Simple wrapper autour de la méthode create_commit().

delete_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • name (str) — Le nom du point de terminaison d’inférence à supprimer.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve l'Inference Endpoint. Par défaut, il s'agit de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Supprimer un point de terminaison d'inférence.

Cette opération n’est pas réversible. Si vous ne souhaitez pas être facturé pour un Inference Endpoint, il est préférable de le mettre en pause avec pause_inference_endpoint() ou de le réduire à zéro avec scale_to_zero_inference_endpoint().

Pour plus de commodité, vous pouvez également supprimer un Inference Endpoint à l'aide de InferenceEndpoint.delete().

delete_repo

< >

( repo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonemissing_ok: bool = False )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle.
  • missing_ok (bool, facultatif, valeur par défaut False) — Si True, ne lève pas d'erreur si le dépôt n'existe pas.

Lève

RepositoryNotFoundError

  • RepositoryNotFoundError — Si le dépôt à partir duquel supprimer ne peut pas être trouvé et que missing_ok est défini sur False (par défaut).

Supprimer un dépôt du HuggingFace Hub. ATTENTION : cette opération est irréversible.

delete_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • scheduled_job_id (str) — ID du Job planifié.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve le Job planifié. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Supprimer un Job de calcul planifié sur l’infrastructure Hugging Face.

delete_space_secret

< >

( repo_id: strkey: strtoken: bool | str | None = None )

Paramètres

  • repo_id (str) — ID du dépôt à mettre à jour. Exemple : "bigcode/in-the-stack".
  • key (str) — Clé secrète. Exemple : "GITHUB_API_KEY".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Supprime un secret d'un Space.

Les secrets permettent de définir des clés ou des jetons secrets pour un Space sans les coder en dur. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

delete_space_variable

< >

( repo_id: strkey: strtoken: bool | str | None = None )

Paramètres

  • repo_id (str) — ID du dépôt à mettre à jour. Exemple : "bigcode/in-the-stack".
  • key (str) — Clé de la variable. Exemple : "MODEL_REPO_ID"
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Supprime une variable d'un Space.

Les variables permettent de définir des variables d’environnement pour un Space sans les coder en dur. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

delete_space_volumes

< >

( repo_id: strtoken: bool | str | None = None )

Paramètres

  • repo_id (str) — ID de l'Espace à mettre à jour. Exemple : "username/my-space".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

BadRequestError

  • BadRequestError — Si l’Espace n’a aucun volume attaché.

Supprimer tous les volumes d'un Space.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.delete_space_volumes("username/my-space")

delete_tag

< >

( repo_id: strtag: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Paramètres

  • repo_id (str) — Le dépôt dans lequel une étiquette sera supprimée. Exemple : "user/my-cool-model".
  • tag (str) — Le nom de la balise à supprimer.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" pour étiqueter un jeu de données ou un espace, None ou "model" pour étiqueter un modèle. La valeur par défaut est None.

Lève

RepositoryNotFoundError ou RevisionNotFoundError

  • RepositoryNotFoundError — Si le dépôt n’est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • RevisionNotFoundError — Si le tag n'est pas trouvé.

Supprimer un tag d’un dépôt sur le Hub.

delete_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → None

Paramètres

  • webhook_id (str) — L'identifiant unique du webhook à supprimer.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

None

Supprimer un webhook.

Exemple :

>>> from huggingface_hub import delete_webhook
>>> delete_webhook("654bbbc16f2ec14d77f109cc")

disable_space_dev_mode

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID de l'Espace pour lequel désactiver le mode dev. Exemple : "Salesforce/BLIP2".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

SpaceRuntime

Informations d'exécution relatives à votre Space.

Lève

RepositoryNotFoundError ou HfHubHTTPError ou BadRequestError

  • RepositoryNotFoundError — Si votre Space n’est pas trouvé (erreur 404). La plupart du temps, le repo_id est incorrect ou votre Space est privé mais vous n’êtes pas authentifié.
  • HfHubHTTPError — 403 Forbidden : seul le propriétaire d’un Space peut activer le mode dev. Si vous souhaitez gérer un Space qui ne vous appartient pas, demandez au propriétaire en ouvrant une Discussion ou dupliquez le Space.
  • BadRequestError — Si votre Space est un Space statique. Les Spaces statiques sont toujours en cours d’exécution et ne font jamais l’objet de facturation. Si vous souhaitez masquer un Space statique, vous pouvez le passer en privé.

Désactiver le mode développement sur un Space.

Spaces Dev Mode facilite le débogage de votre application et accélère l’itération sur les Spaces en vous permettant de redémarrer votre application sans arrêter le conteneur du Space lui-même. L’activation du mode dev nécessite un abonnement PRO ou Team & Enterprise, mais sa désactivation est toujours autorisée (par exemple, après l’expiration d’un abonnement). Consultez https://huggingface.co/docs/hub/spaces-dev-mode pour plus de détails.

disable_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Paramètres

  • webhook_id (str) — L'identifiant unique du webhook à désactiver.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

WebhookInfo

Informations sur le webhook désactivé.

Désactiver un webhook (le passe en état « désactivé »).

Exemple :

>>> from huggingface_hub import disable_webhook
>>> disabled_webhook = disable_webhook("654bbbc16f2ec14d77f109cc")
>>> disabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    jon=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=True,
)

download_bucket_files

< >

( bucket_id: strfiles: list[tuple[str | BucketFile, str | Path]]raise_on_missing_files: bool = Falsetoken: str | bool | None = None )

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • files (list[tuple[Union[str, BucketFile], Union[str, Path]]]) — Fichiers à télécharger sous forme de liste de tuples (source, destination). Consultez la description ci-dessus pour les détails du format.
  • raise_on_missing_files (bool, facultatif) — Si True, lève une EntryNotFoundError si le fichier demandé n'existe pas dans le bucket. Si False (par défaut), les fichiers manquants sont ignorés avec un avertissement.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Télécharger des fichiers depuis un bucket.

L'entrée Files est une liste de tuples (remote file, local file) où remote file est soit le chemin du fichier dans le bucket, soit un objet BucketFile, et local file est le chemin de destination sur le système de fichiers local. Lors de la transmission d'un objet BucketFile (obtenu via list_bucket_tree()), la méthode ignore l'étape de récupération des métadonnées et télécharge directement les fichiers.

Exemple :

>>> from huggingface_hub import download_bucket_files

>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[
...         ("models/model.safetensors", "./local/model.safetensors"),
...         ("config.json", "./local/config.json"),
...     ],
... )
>>> from huggingface_hub import download_bucket_files

>>> parquet_files = [file for file in list_bucket_tree(bucket_id="username/my-bucket") if file.path.endswith(".parquet")]
>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[(file, f"./local/{file.path}") for file in parquet_files],
... )

duplicate_repo

< >

( from_id: strto_id: str | None = Nonerepo_type: str | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonetoken: bool | str | None = Noneexist_ok: bool = Falseresource_group_id: str | None = Nonespace_hardware: SpaceHardware | None = Nonespace_sleep_time: int | None = Nonespace_secrets: list[dict[str, str]] | None = Nonespace_variables: list[dict[str, str]] | None = Nonespace_volumes: list[Volume] | None = None ) → DuplicatedRepoUrl

Paramètres

  • from_id (str) — ID du dépôt à dupliquer. Exemple : "openai/gdpval".
  • to_id (str, facultatif) — ID du nouveau dépôt. Exemple : "myorg/my-gdpval". S'il n'est pas fourni, le nouveau dépôt aura le même nom que le dépôt d'origine, mais dans votre compte.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" en cas de duplication d’un jeu de données ou d’un Space, None ou "model" en cas de duplication d’un modèle. La valeur par défaut est None.
  • private (bool, facultatif) — Indique si le nouveau dépôt doit être privé ou non. Par défaut, la même confidentialité que le dépôt d’origine est appliquée. Ne peut pas être passé en même temps que visibility.
  • visibility (Literal["public", "private", "protected"], facultatif) — Visibilité du nouveau dépôt. Peut être "public" ou "private", ou "protected" pour les Spaces. Par défaut, la visibilité est identique à celle du dépôt d'origine.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • exist_ok (bool, facultatif, par défaut False) — Si True, ne lève pas d'erreur si le dépôt existe déjà.
  • resource_group_id (str, facultatif) — Groupe de ressources dans lequel créer le nouveau dépôt. Les groupes de ressources ne sont disponibles que pour les organisations Enterprise du Hub et permettent de définir quels membres de l’organisation peuvent accéder à la ressource. L’identifiant d’un groupe de ressources peut être trouvé dans l’URL de la page de la ressource sur le Hub (par exemple "66670e5163145ca562cb1988"). Pour en savoir plus sur les groupes de ressources, consultez https://huggingface.co/docs/hub/en/security-resource-groups.
  • space_hardware (SpaceHardware ou str, facultatif) — Choix du matériel si repo_type est “space”. Exemple : "t4-medium". Voir SpaceHardware pour la liste complète.
  • space_sleep_time (int, facultatif) — Nombre de secondes d’inactivité à attendre avant qu’un Space ne passe en veille. Définissez la valeur sur -1 si vous ne souhaitez pas que votre Space passe en veille (comportement par défaut pour le matériel mis à niveau). Pour le matériel gratuit, vous ne pouvez pas configurer la durée de veille (la valeur est fixée à 48 heures d’inactivité). Applicable uniquement si repo_type est « space ». Voir https://huggingface.co/docs/hub/spaces-gpus#sleep-time pour plus de détails.
  • space_secrets (list[dict[str, str]], facultatif) — Une liste de clés secrètes à définir dans votre Space. Chaque élément est de la forme {"key": ..., "value": ..., "description": ...} où description est facultatif. Applicable uniquement si repo_type est « space ». Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets.
  • space_variables (list[dict[str, str]], facultatif) — Une liste de variables d’environnement publiques à définir dans votre Space. Chaque élément est de la forme {"key": ..., "value": ..., "description": ...} où description est facultatif. N’applicable que si repo_type est « space ». Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.
  • space_volumes (list[Volume], facultatif) — Une liste d’objets Volume à monter dans le Space lors de la duplication. Chaque volume possède un type ("bucket", "model", "dataset" ou "space"), une source (identifiant du dépôt ou du bucket), un mount_path (chemin à l’intérieur du conteneur) ainsi que les champs facultatifs revision, read_only et path. Applicable uniquement si repo_type est « space ».

Retourne

DuplicatedRepoUrl

URL du dépôt nouvellement créé. La valeur est une sous-classe de RepoUrl (et de str) contenant des attributs tels que endpoint, repo_type, repo_id et files_copy_pending.

Lève

RepositoryNotFoundError ou HfHubHTTPError

  • RepositoryNotFoundError — Si l’un des identifiants from_id ou to_id ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • HfHubHTTPError — Si l’API HuggingFace a renvoyé une erreur

Dupliquer un dépôt sur le Hub (modèle, jeu de données ou Space).

Cette opération effectue une copie côté serveur qui conserve l’historique git complet et les objets LFS, sans nécessiter de téléchargement/téléversement local.

L’historique git est copié immédiatement, mais les fichiers LFS/Xet peuvent encore être copiés en arrière-plan après le retour de cette méthode. Dans ce cas, files_copy_pending est True sur la valeur retournée et le téléchargement de ces fichiers depuis le nouveau dépôt peut échouer jusqu’à la fin de la copie.

Exemple :

>>> from huggingface_hub import duplicate_repo

# Duplicate a model to your account
>>> repo_url = duplicate_repo("google/gemma-7b")
>>> repo_url
RepoUrl('https://huggingface.co/nateraw/gemma-7b',...)
>>> repo_url.files_copy_pending
True

# Duplicate a dataset with a custom name
>>> duplicate_repo("openai/gdpval", to_id="myorg/my-gdpval", repo_type="dataset")
RepoUrl('https://huggingface.co/datasets/myorg/my-gdpval',...)

# Duplicate a Space with custom hardware
>>> duplicate_repo("multimodalart/dreambooth-training", repo_type="space", space_hardware="t4-medium")
RepoUrl('https://huggingface.co/spaces/nateraw/dreambooth-training',...)

edit_discussion_comment

< >

( repo_id: strdiscussion_num: intcomment_id: strnew_content: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • discussion_num (int) — Le numéro de la Discussion ou de la Pull Request. Doit être un entier strictement positif.
  • comment_id (str) — L'identifiant du commentaire à modifier.
  • new_content (str) — Le nouveau contenu du commentaire. Les commentaires prennent en charge le formatage Markdown.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Commentaire de discussion

le commentaire modifié

Modifie un commentaire sur une Discussion / Pull Request.

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

enable_space_dev_mode

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID de l'Espace pour lequel activer le mode dev. Exemple : "Salesforce/BLIP2".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

SpaceRuntime

Informations d'exécution relatives à votre Space.

Lève

RepositoryNotFoundError ou HfHubHTTPError ou BadRequestError

  • RepositoryNotFoundError — Si votre Space n’est pas trouvé (erreur 404). La plupart du temps, le repo_id est incorrect ou votre Space est privé mais vous n’êtes pas authentifié.
  • HfHubHTTPError — 403 Forbidden : seul le propriétaire d’un Space peut activer le mode dev. Si vous souhaitez gérer un Space qui ne vous appartient pas, demandez au propriétaire en ouvrant une Discussion ou dupliquez le Space.
  • BadRequestError — Si votre Space est un Space statique. Les Spaces statiques sont toujours en cours d’exécution et ne font jamais l’objet de facturation. Si vous souhaitez masquer un Space statique, vous pouvez le passer en privé.

Activer le mode développement sur un Space.

Le mode Dev de Spaces facilite le débogage de votre application et accélère l’itération sur les Spaces en vous permettant de redémarrer votre application sans arrêter le conteneur du Space lui-même. Cette fonctionnalité est disponible dans le cadre d’un abonnement PRO ou Team & Enterprise. Consultez https://huggingface.co/docs/hub/spaces-dev-mode pour plus de détails.

enable_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Paramètres

  • webhook_id (str) — L'identifiant unique du webhook à activer.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

WebhookInfo

Informations sur le webhook activé.

Activer un webhook (le rendre « actif »).

Exemple :

>>> from huggingface_hub import enable_webhook
>>> enabled_webhook = enable_webhook("654bbbc16f2ec14d77f109cc")
>>> enabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

fetch_job_logs

< >

( job_id: strnamespace: str | None = Nonefollow: bool = Falsetail: int | None = Nonetoken: bool | str | None = None )

Paramètres

  • job_id (str) — ID du Job.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job est exécuté. Par défaut, l'espace de noms de l'utilisateur actuel.
  • follow (bool, facultatif) — Si True, les journaux sont diffusés en temps réel jusqu'à la fin de la tâche (bloquant). Si False (par défaut), seuls les journaux actuellement disponibles sont récupérés et la fonction retourne immédiatement (non bloquant).
  • tail (int, facultatif) — Nombre maximal de lignes à retourner depuis les journaux. Combiné à follow=True, commence par les N dernières lignes et continue de diffuser les nouveaux journaux. Si follow=False, ne retourne que les N dernières lignes des journaux actuellement disponibles.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Récupérer tous les journaux d'un Job de calcul sur l'infrastructure Hugging Face.

Exemple :

>>> from huggingface_hub import fetch_job_logs, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> for log in fetch_job_logs(job_id=job.id):
...     print(log)
Hello from HF compute!

>>> # Non-blocking: fetch only currently available logs
>>> for log in fetch_job_logs(job_id=job.id, follow=False):
...     print(log)

>>> # Stream logs starting from the last 100 lines
>>> for log in fetch_job_logs(job_id=job.id, follow=True, tail=100):
...     print(log)

fetch_job_metrics

< >

( job_id: strnamespace: str | None = Nonefollow: bool = Falsetoken: bool | str | None = None )

Paramètres

  • job_id (str) — ID du Job.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job est exécuté. Par défaut, l'espace de noms de l'utilisateur actuel.
  • follow (bool, facultatif) — Si True, les métriques sont diffusées en temps réel jusqu'à la fin du travail (bloquant). Si False (par défaut), seules les métriques actuelles sont récupérées avant le retour (non bloquant).
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Récupérer les métriques en direct d'un Job de calcul sur l'infrastructure Hugging Face.

Exemple :

>>> from huggingface_hub import fetch_job_metrics, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], flavor="a10g-small")
>>> for metrics in fetch_job_metrics(job_id=job.id):
...     print(metrics)
{
    "cpu_usage_pct": 0,
    "cpu_millicores": 3500,
    "memory_used_bytes": 1306624,
    "memory_total_bytes": 15032385536,
    "rx_bps": 0,
    "tx_bps": 0,
    "gpus": {
        "882fa930": {
            "utilization": 0,
            "memory_used_bytes": 0,
            "memory_total_bytes": 22836000000
        }
    },
    "replica": "57vr7"
}

>>> # Stream metrics until the job completes
>>> for metrics in fetch_job_metrics(job_id=job.id, follow=True):
...     print(metrics)

fetch_space_logs

< >

( repo_id: strbuild: bool = Falsefollow: bool = Falsetoken: bool | str | None = None ) → Iterable[str]

Paramètres

  • repo_id (str) — ID de l'Espace. Exemple : "bigcode/in-the-stack".
  • build (bool, facultatif, par défaut False) — Si True, récupère les journaux de construction du conteneur (utile lorsqu'un Space est bloqué dans BUILD_ERROR). Si False (par défaut), récupère les journaux d'exécution, c'est-à-dire la sortie standard/erreur de l'application en cours d'exécution.
  • follow (bool, facultatif, par défaut False) — Si True, affiche les journaux en temps réel (bloquant) jusqu’à ce que le serveur ferme le flux ou qu’une KeyboardInterrupt soit levée. Si False (par défaut), récupère uniquement les journaux actuellement mis en mémoire tampon et renvoie immédiatement (non bloquant, comme docker logs).
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode d’authentification recommandée. Définissez la valeur sur False pour désactiver l’authentification. Voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

Iterable[str]

Un générateur qui produit les lignes de journal au fur et à mesure qu’elles deviennent disponibles.

Récupérer les journaux d’exécution ou de construction d’un Space sur le Hub.

Utile pour déboguer un Space qui échoue à la compilation ou qui plante à l’exécution, en particulier depuis un script ou un flux de travail agentique où la lecture des journaux dans un navigateur n’est pas une option.

Exemple :

>>> from huggingface_hub import fetch_space_logs
>>> # Non-blocking: print currently available run logs and exit.
>>> for line in fetch_space_logs("username/my-space"):
...     print(line, end="")

>>> # Debug a build failure:
>>> for line in fetch_space_logs("username/my-space", build=True):
...     print(line, end="")

>>> # Stream run logs until the server closes the stream.
>>> for line in fetch_space_logs("username/my-space", follow=True):
...     print(line, end="")

file_exists

< >

( repo_id: strfilename: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: str | bool | None = None )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • filename (str) — Le nom du fichier à vérifier, par exemple : "config.json"
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si les informations du dépôt proviennent d’un dataset ou d’un space, None ou "model" si les informations du dépôt proviennent d’un model. La valeur par défaut est None.
  • revision (str, facultatif) — La révision du dépôt à partir de laquelle obtenir les informations. Par défaut, la branche "main".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Vérifie si un fichier existe dans un dépôt sur le Hugging Face Hub.

Exemples :

>>> from huggingface_hub import file_exists
>>> file_exists("bigcode/starcoder", "config.json")
True
>>> file_exists("bigcode/starcoder", "not-a-file")
False
>>> file_exists("bigcode/not-a-repo", "config.json")
False

get_bucket_file_metadata

< >

( bucket_id: strremote_path: strtoken: str | bool | None = None ) → BucketFileMetadata

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • remote_path (str) — Le chemin du fichier dans le bucket.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

BucketFileMetadata

Le fichier de métadonnées contenant la taille et les informations xet.

Récupérer les métadonnées d'un fichier dans un bucket.

Exemple :

>>> from huggingface_hub import get_bucket_file_metadata
>>> metadata = get_bucket_file_metadata(
...     bucket_id="username/my-bucket",
...     remote_path="models/model.safetensors",
... )
>>> metadata.size
42000

get_bucket_paths_info

< >

( bucket_id: strpaths: Iterable[str]token: str | bool | None = None ) → Iterable[BucketFile]

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • paths (Iterable[str]) — Les chemins pour lesquels obtenir des informations. Si un chemin n'existe pas, il est ignoré sans lever d'exception. Seuls les chemins de fichiers sont pris en charge.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[BucketFile]

Les informations relatives aux chemins, sous forme d'itérable d'objets BucketFile.

Obtenir des informations sur les chemins d’un bucket.

Les appels sont effectués par lots de 1000 chemins. Les résultats sont rendus au fur et à mesure de leur réception.

Exemple :

>>> from huggingface_hub import get_bucket_paths_info
>>> paths_info = get_bucket_paths_info("username/my-bucket", ["file.txt", "checkpoints/model.safetensors"])
>>> for info in paths_info:
...     print(info)
BucketFile(type='file', path='file.txt', size=2379, xet_hash='96e637d9665bd35477b1908a23f2e254edfba0618dbd2d62f90a6baee7d139cf', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))
BucketFile(type='file', path='checkpoints/model.safetensors', size=2408828, xet_hash='3ed0e9fefe788ddd61d1e26eba67057e9740a064b009256fbafadf6bb95785ca', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))

get_collection

< >

( collection_slug: strtoken: bool | str | None = None )

Paramètres

  • collection_slug (str) — Slug de la collection du Hub. Exemple : "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Récupère des informations sur une Collection sur le Hub.

Retourne : Collection

Exemple :

>>> from huggingface_hub import get_collection
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")
>>> collection.title
'Recent models'
>>> len(collection.items)
37
>>> collection.items[0]
CollectionItem(
    item_object_id='651446103cd773a050bf64c2',
    item_id='TheBloke/U-Amethyst-20B-AWQ',
    item_type='model',
    position=88,
    note=None
)

get_dataset_leaderboard

< >

( repo_id: strbase_model_only: bool | None = Nonetoken: bool | str | None = Nonetimeout: float | None = None ) → list[DatasetLeaderboardEntry]

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /. Par exemple : "allenai/olmOCR-bench".
  • base_model_only (bool ou None, facultatif) — Par défaut, le classement n’inclut que les modèles qui ne déclarent aucune relation base_model (c’est-à-dire les dépôts canoniques/racines), conformément à la vue par défaut du classement du Hub. Les dépôts affinés ou dérivés qui déclarent un modèle parent sont exclus. Passez base_model_only=False pour désactiver ce filtre et inclure tous les résultats soumis, indépendamment du fait que le modèle déclare ou non une relation de modèle de base.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.

Retourne

list[DatasetLeaderboardEntry]

Une liste d'objets DatasetLeaderboardEntry représentant les entrées du tableau des classements, triées par rang.

Obtenir le classement d'un jeu de données sur le Hub.

Le tableau de classement classe les modèles en fonction de leurs scores d'évaluation sur le jeu de données de référence donné. Tous les jeux de données ne disposent pas d'un tableau de classement — seuls les jeux de données de référence pour lesquels des résultats d'évaluation ont été soumis en disposent. Cela offre une vue centrée sur le jeu de données des scores ; pour une vue centrée sur le modèle, utilisez model_info() avec expand=["evalResults"].

Lève les erreurs suivantes :

  • RepositoryNotFoundError Si le dépôt ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • HfHubHTTPError Si le jeu de données ne possède pas de tableau de classement.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench")
>>> leaderboard[0].model_id
'datalab-to/chandra-ocr-2'
>>> leaderboard[0].rank
1

# Include fine-tuned / derivative models too
>>> full_leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench", base_model_only=False)

get_dataset_tags

< >

( )

Liste tous les tags de jeu de données valides en tant qu'objet d'espace de noms imbriqué.

get_discussion_details

< >

( repo_id: strdiscussion_num: intrepo_type: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • discussion_num (int) — Le numéro de la Discussion ou de la Pull Request. Doit être un entier strictement positif.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Récupère les détails d’une Discussion / d’une Pull Request depuis le Hub.

Retourne : DiscussionWithDetails

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

get_full_repo_name

< >

( model_id: strorganization: str | None = Nonetoken: bool | str | None = None ) → str

Paramètres

  • model_id (str) — Le nom du modèle.
  • organization (str, facultatif) — Si fourni, le nom du dépôt sera dans l'espace de noms de l'organisation plutôt que dans l'espace de noms de l'utilisateur.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

str

Le nom du dépôt dans l’espace de noms de l’utilisateur ({username}/{model_id}) si aucune organisation n’est passée, et dans l’espace de noms de l’organisation ({organization}/{model_id}) sinon.

Retourne le nom du dépôt pour un identifiant de modèle et une organisation facultative donnés.

get_hf_file_metadata

< >

( url: strtoken: bool | str | None = Nonetimeout: float | None = 10 )

Paramètres

  • url (str) — URL du fichier, par exemple renvoyée par hf_hub_url().
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • timeout (float, facultatif, valeur par défaut 10) — Nombre de secondes à attendre avant d’abandonner si le serveur n’a pas envoyé les métadonnées.

Récupérer les métadonnées d'un fichier versionné sur le Hub pour une URL donnée.

get_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Paramètres

  • name (str) — Le nom de l'Inference Endpoint pour lequel récupérer les informations.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve l'Inference Endpoint. Par défaut, il s'agit de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

InferenceEndpoint

informations sur le point d'inférence demandé.

Obtenir des informations sur un point de terminaison d’inférence.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.get_inference_endpoint("my-text-to-image")
>>> endpoint
InferenceEndpoint(name='my-text-to-image', ...)

# Get status
>>> endpoint.status
'running'
>>> endpoint.url
'https://my-text-to-image.region.vendor.endpoints.huggingface.cloud'

# Run inference
>>> endpoint.client.text_to_image(...)

get_model_tags

< >

( )

Liste tous les tags de modèle valides en tant qu'objet d'espace de noms imbriqué

get_organization_overview

< >

( organization: strtoken: bool | str | None = None ) → Organization

Paramètres

  • organization (str) — Nom de l'organisation pour laquelle obtenir un aperçu.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Organization

Un objet Organization avec la présentation de l’organisation.

Lève

HTTPError

  • HTTPError — HTTP 404 si l’organisation n’existe pas sur le Hub.

Obtenez un aperçu d'une organisation sur le Hub.

get_paths_info

< >

( repo_id: strpaths: list[str] | strexpand: bool = Falserevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → list[Union[RepoFile, RepoFolder]]

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • paths (Union[list[str], str], facultatif) — Les chemins pour lesquels obtenir des informations. Si un chemin n'existe pas, il est ignoré sans lever d'exception.
  • expand (bool, facultatif, par défaut False) — Indique s'il faut récupérer plus d'informations sur les chemins (par exemple, le dernier commit et les résultats de l'analyse de sécurité des fichiers). Cette opération est plus coûteuse pour le serveur, si bien que seules 50 résultats sont renvoyés par page (au lieu de 1000). Comme la pagination est implémentée dans huggingface_hub, cela reste transparent pour vous, à l'exception du temps nécessaire pour obtenir les résultats.
  • revision (str, facultatif) — La révision du dépôt à partir de laquelle obtenir les informations. Par défaut, la branche "main".
  • repo_type (str, facultatif) — Le type de dépôt à partir duquel obtenir les informations ("model", "dataset" ou "space". La valeur par défaut est "model".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

list[Union[RepoFile, RepoFolder]]

Les informations relatives aux chemins, sous forme d'une liste d'objets RepoFile et RepoFolder.

Lève

RepositoryNotFoundError ou RevisionNotFoundError

  • RepositoryNotFoundError — Si le dépôt n'est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • RevisionNotFoundError — Si la révision n’est pas trouvée (erreur 404) dans le dépôt.

Obtenir des informations sur les chemins d’un dépôt.

Exemple :

>>> from huggingface_hub import get_paths_info
>>> paths_info = get_paths_info("allenai/c4", ["README.md", "en"], repo_type="dataset")
>>> paths_info
[
    RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None),
    RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None)
]

get_repo_discussions

< >

( repo_id: strauthor: str | None = Nonediscussion_type: constants.DiscussionTypeFilter | None = Nonediscussion_status: constants.DiscussionStatusFilter | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterator[Discussion]

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • author (str, facultatif) — Transmet une valeur pour filtrer par auteur de la discussion. None signifie qu’aucun filtre n’est appliqué. La valeur par défaut est None.
  • discussion_type (str, facultatif) — Définir sur "pull_request" pour ne récupérer que les pull requests, "discussion" pour ne récupérer que les discussions. Définir sur "all" ou None pour récupérer les deux. La valeur par défaut est None.
  • discussion_status (str, facultatif) — À définir sur "open" (respectivement "closed") pour ne récupérer que les discussions ouvertes (respectivement fermées). À définir sur "all" ou None pour récupérer les deux. La valeur par défaut est None.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si la récupération provient d’un jeu de données ou d’un espace, None ou "model" si elle provient d’un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterator[Discussion]

Un itérateur d'objets Discussion.

Récupère les Discussions et les Pull Requests du dépôt indiqué.

Exemple :

Collecter toutes les discussions d'un dépôt dans une liste :

>>> from huggingface_hub import get_repo_discussions
>>> discussions_list = list(get_repo_discussions(repo_id="bert-base-uncased"))

Parcourir les discussions d'un dépôt :

>>> from huggingface_hub import get_repo_discussions
>>> for discussion in get_repo_discussions(repo_id="bert-base-uncased"):
...     print(discussion.num, discussion.title)

get_safetensors_metadata

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsRepoMetadata

Paramètres

  • repo_id (str) — Le nom d’un utilisateur ou d’une organisation et le nom d’un dépôt, séparés par un /.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si le fichier se trouve dans un dataset ou un space, None ou "model" s’il se trouve dans un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — La révision git à partir de laquelle récupérer le fichier. Peut être un nom de branche, un tag ou un hachage de commit. Par défaut, pointe vers la tête de la branche "main".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • timeout (float, facultatif, valeur par défaut 10) — Nombre de secondes à attendre que le serveur envoie des données avant d’abandonner, transmis à chaque requête qui récupère l’en-tête d’un fichier safetensors. Définir sur None pour désactiver le délai d’attente (non recommandé, car une connexion bloquée peut suspendre l’appel indéfiniment).

Retourne

SafetensorsRepoMetadata

informations relatives au dépôt safetensors.

Lève

NotASafetensorsRepoError ou SafetensorsParsingError

  • NotASafetensorsRepoError — Si le dépôt n’est pas un dépôt safetensors, c’est-à-dire s’il ne contient ni le fichier model.safetensors ni le fichier model.safetensors.index.json.
  • SafetensorsParsingError — Si l’en-tête d’un fichier safetensors n’a pas pu être analysé correctement.

Analyser les métadonnées d’un dépôt safetensors sur le Hub.

Nous vérifions d'abord si le dépôt contient un fichier safetensors unique ou un dépôt de safetensors fractionné. S'il s'agit d'un fichier safetensors unique, nous analysons les métadonnées de ce fichier. S'il s'agit d'un dépôt de safetensors fractionné, nous analysons les métadonnées du fichier d'index, puis les métadonnées de chaque fraction.

Pour analyser les métadonnées d'un fichier safetensors unique, utilisez parse_safetensors_file_metadata(). Pour obtenir l'en-tête de chaque shard d'un modèle sharded sur main en une seule requête, utilisez get_sharded_safetensors_metadata().

Pour plus de détails sur le format safetensors, consultez https://huggingface.co/docs/safetensors/index#format.

Exemple :

# Parse repo with single weights file
>>> metadata = get_safetensors_metadata("bigscience/bloomz-560m")
>>> metadata
SafetensorsRepoMetadata(
    metadata=None,
    sharded=False,
    weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...},
    files_metadata={'model.safetensors': SafetensorsFileMetadata(...)}
)
>>> metadata.files_metadata["model.safetensors"].metadata
{'format': 'pt'}

# Parse repo with sharded model
>>> metadata = get_safetensors_metadata("bigscience/bloom")
Parse safetensors files: 100%|██████████████████████████████████████████| 72/72 [00:12<00:00,  5.78it/s]
>>> metadata
SafetensorsRepoMetadata(metadata={'total_size': 352494542848}, sharded=True, weight_map={...}, files_metadata={...})
>>> len(metadata.files_metadata)
72  # All safetensors files have been fetched

# Parse repo with sharded model
>>> get_safetensors_metadata("runwayml/stable-diffusion-v1-5")
NotASafetensorsRepoError: 'runwayml/stable-diffusion-v1-5' is not a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files.

get_sharded_safetensors_metadata

< >

( repo_id: strfilename: str = 'model.safetensors.index.json'token: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsRepoMetadata

Paramètres

  • repo_id (str) — Le nom d’un utilisateur ou d’une organisation et le nom d’un dépôt, séparés par un /.
  • filename (str, facultatif) — Chemin du fichier d’index safetensors dans le dépôt. Par défaut : "model.safetensors.index.json".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • timeout (float, facultatif, valeur par défaut 10) — Nombre de secondes à attendre que le serveur envoie des données avant d’abandonner. Définir sur None pour désactiver le délai d’attente (non recommandé, car une connexion bloquée peut suspendre l’appel indéfiniment).

Retourne

SafetensorsRepoMetadata

les mêmes métadonnées que get_safetensors_metadata().

Récupérez les métadonnées de chaque fragment d’un modèle safetensors fragmenté sur main depuis le Hub en une seule requête, au lieu de get_safetensors_metadata() qui analyse l’en-tête de chaque fragment. Exclusif au Hugging Face Hub.

Exemple :

>>> metadata = get_sharded_safetensors_metadata("HuggingFaceH4/zephyr-7b-beta")
>>> len(metadata.files_metadata)
8

get_space_runtime

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID du dépôt à mettre à jour. Exemple : "bigcode/in-the-stack".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

SpaceRuntime

Informations d'exécution sur un Space, y compris l'étape du Space et le matériel.

Récupère des informations d'exécution sur un Space.

get_space_secrets

< >

( repo_id: strtoken: bool | str | None = None ) → dict[str, SpaceSecret]

Paramètres

  • repo_id (str) — ID du dépôt à interroger. Exemple : "bigcode/in-the-stack".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

dict[str, SpaceSecret]

Dictionnaire d'objets SpaceSecret indexé par le nom du secret.

Récupère tous les secrets d'un Space.

Les valeurs secrètes sont en écriture seule et ne peuvent pas être relues. Seuls la clé, la description et l'heure de la dernière mise à jour sont renvoyés.

Les secrets permettent de définir des clés ou des jetons secrets pour un Space sans les coder en dur. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.get_space_secrets("username/my-space")
{'HF_TOKEN': SpaceSecret(key='HF_TOKEN', description='...', updated_at=datetime.datetime(...))}

get_space_variables

< >

( repo_id: strtoken: bool | str | None = None )

Paramètres

  • repo_id (str) — ID du dépôt à interroger. Exemple : "bigcode/in-the-stack".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Récupère toutes les variables d'un Space.

Les variables permettent de définir des variables d’environnement pour un Space sans les coder en dur. Pour plus de détails, voir https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

get_user_overview

< >

( username: strtoken: bool | str | None = None ) → User

Paramètres

  • username (str) — Nom d'utilisateur de l'utilisateur pour lequel obtenir un aperçu.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

User

Un objet User avec l’aperçu de l’utilisateur.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 si l’utilisateur n’existe pas sur le Hub.

Obtenez un aperçu d'un utilisateur sur le Hub.

get_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Paramètres

  • webhook_id (str) — L'identifiant unique du webhook à récupérer.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

WebhookInfo

Informations sur le webhook.

Obtenir un webhook par son identifiant.

Exemple :

>>> from huggingface_hub import get_webhook
>>> webhook = get_webhook("654bbbc16f2ec14d77f109cc")
>>> print(webhook)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)

get_zero_gpu_quota

< >

( token: bool | str | None = None ) → ZeroGpuQuota

Paramètres

  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Un jeton à granularité fine doit disposer de l’autorisation « Billing > Read billing usage and payment method status » et un jeton OAuth doit avoir le périmètre read-billing.

Retourne

ZeroGpuQuota

Le quota ZeroGPU de l'utilisateur authentifié.

Obtenir le quota ZeroGPU de l'utilisateur authentifié.

Utile pour suivre l’utilisation de ZeroGPU lors de l’appel programmatique d’espaces ZeroGPU (par exemple depuis une application, un agent ou un serveur MCP). Consultez https://huggingface.co/docs/hub/spaces-zerogpu pour plus de détails.

Exemple :

>>> from huggingface_hub import get_zero_gpu_quota
>>> quota = get_zero_gpu_quota()
>>> quota
ZeroGpuQuota(base=2400, remaining=1810, resets_at=datetime.datetime(2026, 9, 30, 9, 12, 3, tzinfo=datetime.timezone.utc), overquota_used=0)
>>> print(f"{quota.remaining / 60:.1f} minutes left")
30.2 minutes left

grant_access

< >

( repo_id: struser: strrepo_type: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — L’identifiant du dépôt auquel accorder l’accès.
  • user (str) — Nom d'utilisateur de l'utilisateur auquel accorder l'accès.
  • repo_type (str, facultatif) — Le type de dépôt auquel accorder l’accès. Doit être l’un des éléments suivants : model, dataset ou space. Valeur par défaut : model.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 si le dépôt n'est pas gated.
  • HfHubHTTPError — HTTP 400 si l'utilisateur a déjà accès au dépôt.
  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.
  • HfHubHTTPError — HTTP 404 si l'utilisateur n'existe pas sur le Hub.

Accorder l'accès à un utilisateur pour un dépôt gated donné.

Accorder l’accès ne nécessite pas que l’utilisateur envoie lui-même une demande d’accès. L’utilisateur est automatiquement ajouté à la liste des acceptés, ce qui lui permet de télécharger les fichiers. Vous pouvez révoquer l’accès accordé à tout moment en utilisant cancel_access_request() ou reject_access_request().

Pour plus d'informations sur les dépôts à accès restreint, consultez https://huggingface.co/docs/hub/models-gated.

hf_hub_download

< >

( repo_id: strfilename: strsubfolder: str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_dir: str | Path | None = Noneforce_download: bool = Falseetag_timeout: float = 10token: bool | str | None = Nonelocal_files_only: bool = Falsetqdm_class: type[base_tqdm] | None = Nonedry_run: bool = False ) → str or DryRunFileInfo

Paramètres

  • repo_id (str) — Le nom d’un utilisateur ou d’une organisation et le nom d’un dépôt, séparés par un /.
  • filename (str) — Le nom du fichier dans le dépôt.
  • subfolder (str, facultatif) — Valeur facultative correspondant à un dossier dans le dépôt.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si le téléchargement provient d’un dataset ou d’un space, None ou "model" si le téléchargement provient d’un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — Identifiant de révision Git facultatif, qui peut être un nom de branche, un tag ou un hash de commit.
  • cache_dir (str, Path, facultatif) — Chemin vers le dossier où les fichiers en cache sont stockés.
  • local_dir (str ou Path, facultatif) — Si fourni, le fichier téléchargé sera placé sous ce répertoire.
  • force_download (bool, facultatif, valeur par défaut False) — Indique si le fichier doit être téléchargé même s'il existe déjà dans le cache local.
  • etag_timeout (float, facultatif, par défaut 10) — Lors de la récupération de l'ETag, nombre de secondes à attendre que le serveur envoie des données avant d'abandonner, valeur transmise à httpx2.request.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • local_files_only (bool, facultatif, valeur par défaut False) — Si True, évite de télécharger le fichier et renvoie le chemin du fichier en cache local s'il existe.
  • tqdm_class (tqdm, facultatif) — Si fourni, remplace le comportement par défaut de la barre de progression. L’argument transmis doit hériter de tqdm.auto.tqdm ou au moins imiter son comportement. Par défaut, la barre de progression personnalisée de HF est utilisée, et peut être désactivée en définissant la variable d’environnement HF_HUB_DISABLE_PROGRESS_BARS.
  • dry_run (bool, facultatif, par défaut False) — Si True, effectue une simulation sans réellement télécharger le fichier. Renvoie un objet DryRunFileInfo contenant des informations sur ce qui serait téléchargé.

Retourne

str ou DryRunFileInfo

  • Si dry_run=False : chemin local du fichier ou, si le réseau est désactivé, dernière version du fichier mise en cache sur le disque.
  • Si dry_run=True : un objet DryRunFileInfo contenant les informations de téléchargement.

Lève

RepositoryNotFoundError ou RevisionNotFoundError ou ~utils.RemoteEntryNotFoundError ou LocalEntryNotFoundError ou EnvironmentError ou OSError ou ValueError

  • RepositoryNotFoundError — Si le dépôt à partir duquel le téléchargement doit être effectué n’est pas trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError — Si la révision à télécharger n'est pas trouvée.
  • ~utils.RemoteEntryNotFoundError — Si le fichier à télécharger ne peut pas être trouvé.
  • LocalEntryNotFoundError — Si le réseau est désactivé ou indisponible et que le fichier n'est pas trouvé dans le cache.
  • EnvironmentError — Si token=True mais que le jeton ne peut pas être trouvé.
  • OSError — Si l'ETag ne peut pas être déterminé.
  • ValueError — Si la valeur d'un paramètre est invalide.

Télécharger un fichier donné s'il n'est pas déjà présent dans le cache local.

La nouvelle disposition du fichier de cache est la suivante :

  • Le répertoire de cache contient un sous-dossier par repo_id (namespaced by repo type)
  • dans chaque dossier de dépôt :
    • refs est une liste des dernières paires de révision => commit_hash connues
    • blobs contient les blobs de fichiers réels (identifiés par leur git-sha ou sha256, selon qu'il s'agisse ou non de fichiers LFS)
    • snapshots contient un sous-dossier par commit, chaque « commit » contenant le sous-ensemble des fichiers résolus à ce commit particulier. Chaque nom de fichier est un lien symbolique vers le blob à ce commit particulier.
[  96]  .
└── [ 160]  models--julien-c--EsperBERTo-small
    ├── [ 160]  blobs
    │   ├── [321M]  403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
    │   ├── [ 398]  7cb18dc9bafbfcf74629a4b760af1b160957a83e
    │   └── [1.4K]  d7edf6bd2a681fb0175f7735299831ee1b22b812
    ├── [  96]  refs
    │   └── [  40]  main
    └── [ 128]  snapshots
        ├── [ 128]  2439f60ef33a0d46d85da5001d52aeda5b00ce9f
        │   ├── [  52]  README.md -> ../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812
        │   └── [  76]  pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
        └── [ 128]  bbc77c8132af1cc5cf678da3f1ddf2de43606d48
            ├── [  52]  README.md -> ../../blobs/7cb18dc9bafbfcf74629a4b760af1b160957a83e
            └── [  76]  pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd

Si local_dir est fourni, la structure de fichiers du dépôt sera répliquée à cet emplacement. Lors de l’utilisation de cette option, le cache_dir ne sera pas utilisé et un dossier .cache/huggingface/ sera créé à la racine de local_dir pour stocker certaines métadonnées liées aux fichiers téléchargés. Bien que ce mécanisme ne soit pas aussi robuste que le système de cache principal, il est optimisé pour récupérer régulièrement la dernière version d’un dépôt.

masquer le commentaire de la discussion

< >

( repo_id: strdiscussion_num: intcomment_id: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • discussion_num (int) — Le numéro de la Discussion ou de la Pull Request. Doit être un entier strictement positif.
  • comment_id (str) — L'identifiant du commentaire à modifier.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Commentaire de discussion

le commentaire caché

Masque un commentaire sur une Discussion / Pull Request.

Le contenu des commentaires masqués ne peut plus être récupéré. Le masquage d'un commentaire est irréversible.

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

inspect_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • job_id (str) — ID du Job.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job est exécuté. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Inspecter un Job de calcul sur l’infrastructure Hugging Face.

Exemple :

>>> from huggingface_hub import inspect_job, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> inspect_job(job_id=job.id)
JobInfo(
    id='68780d00bbe36d38803f645f',
    created_at=datetime.datetime(2025, 7, 16, 20, 35, 12, 808000, tzinfo=datetime.timezone.utc),
    docker_image='python:3.12',
    space_id=None,
    command=['python', '-c', "print('Hello from HF compute!')"],
    arguments=[],
    environment={},
    secrets={},
    flavor='cpu-basic',
    status=JobStatus(stage='RUNNING', message=None)
)

inspect_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • scheduled_job_id (str) — ID du Job planifié.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve le Job planifié. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Inspecter un Job de calcul planifié sur l’infrastructure Hugging Face.

Exemple :

>>> from huggingface_hub import inspect_scheduled_job, create_scheduled_job
>>> scheduled_job = create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly")
>>> inspect_scheduled_job(scheduled_job_id=scheduled_job.id)

kernel_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonetoken: bool | str | None = None ) → ModelInfo

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • revision (str, facultatif) — La révision du dépôt de noyau à partir de laquelle obtenir les informations.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

ModelInfo

Les informations du dépôt de noyau.

Obtenir des informations sur un noyau spécifique sur huggingface.co.

list_accepted_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Paramètres

  • repo_id (str) — L’identifiant du dépôt pour lequel obtenir les demandes d’accès.
  • repo_type (str, facultatif) — Le type de dépôt pour lequel obtenir les demandes d’accès. Doit être l’un des éléments suivants : model, dataset ou space. La valeur par défaut est model.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[AccessRequest]

Un itérable d’objets AccessRequest. Chaque élément contient un attribut username, request_id, email, status et timestamp. Si le dépôt protégé possède un formulaire personnalisé, l’attribut fields sera rempli avec les réponses de l’utilisateur.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 si le dépôt n'est pas gated.
  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.

Obtenir les demandes d'accès acceptées pour un dépôt restreint donné.

Une demande acceptée signifie que l'utilisateur a demandé l'accès au dépôt et que la demande a été acceptée. L'utilisateur peut télécharger n'importe quel fichier du dépôt. Si le mode d'approbation est automatique, cette liste doit contenir par défaut toutes les demandes. Les demandes acceptées peuvent être annulées ou rejetées à tout moment à l'aide de cancel_access_request() et reject_access_request(). Une demande annulée retourne dans la liste des demandes en attente, tandis qu'une demande rejetée passe dans la liste des demandes rejetées. Dans les deux cas, l'utilisateur perd l'accès au dépôt.

Pour plus d'informations sur les dépôts à accès restreint, consultez https://huggingface.co/docs/hub/models-gated.

Exemple :

>>> from huggingface_hub import list_accepted_access_requests

>>> requests = list(list_accepted_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='accepted',
        fields=None,
    ),
    ...
]

list_bucket_tree

< >

( bucket_id: strprefix: str | None = Nonerecursive: bool | None = Nonetoken: str | bool | None = None ) → Iterable[Union[BucketFile, BucketFolder]]

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • prefix (str, facultatif) — Filtre les résultats sur les fichiers dont le chemin commence par ce préfixe.
  • recursive (bool, facultatif) — Si True, liste les fichiers de manière récursive. Si False (par défaut), liste uniquement les fichiers et les répertoires à la racine.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[Union[BucketFile, BucketFolder]]

Un itérable d'objets BucketFile et BucketFolder contenant des informations sur les fichiers et les répertoires (chemin, etc.).

Lister les fichiers d’un bucket.

Exemple :

>>> from huggingface_hub import list_bucket_tree
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket"):
...     print(file_info.path)

>>> # Filter by prefix
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket", prefix="models/"):
...     print(file_info.path)

list_buckets

< >

( namespace: str | None = Nonesearch: str | None = Nonetoken: bool | str | None = None ) → Iterable[BucketInfo]

Paramètres

  • namespace (str, facultatif) — Liste les buckets sous cet espace de noms (utilisateur ou organisation). Par défaut, liste les buckets de l’utilisateur.
  • search (str, facultatif) — Chaîne de recherche pour filtrer les noms de buckets.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[BucketInfo]

Un itérable d'objets BucketInfo.

Lister les buckets sur le Hub sous un certain espace de noms.

Exemple :

>>> from huggingface_hub import list_buckets
>>> for bucket in list_buckets(): # lists buckets in the user's namespace
...     print(bucket)

>>> for bucket in list_buckets(namespace="huggingface"): # lists buckets in the "huggingface" organization
...     print(bucket)

>>> for bucket in list_buckets(search="my-prefix"): # filter buckets by name
...     print(bucket)

list_collections

< >

( owner: list[str] | str | None = Noneitem: list[str] | str | None = Nonesort: CollectionSort_T | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → Iterable[Collection]

Paramètres

  • owner (list[str] ou str, facultatif) — Filtre par nom d'utilisateur du propriétaire.
  • item (list[str] ou str, facultatif) — Filtre les collections contenant un élément particulier. Exemple : "models/teknium/OpenHermes-2.5-Mistral-7B", "datasets/squad" ou "papers/2311.12983".
  • sort (Literal["lastModified", "trending", "upvotes"], facultatif) — Trier les collections par date de dernière modification, tendance ou nombre de votes.
  • limit (int, facultatif) — Nombre maximal de collections à retourner.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[Collection]

un itérable d'objets Collection.

Lister les collections sur le Huggingface Hub, en fonction de certains filtres.

Lors de l’affichage des collections, la liste des éléments par collection est tronquée à 4 éléments maximum. Pour récupérer tous les éléments d’une collection, vous devez utiliser get_collection().

list_daily_papers

< >

( date: str | None = Nonetoken: bool | str | None = Noneweek: str | None = Nonemonth: str | None = Nonesubmitter: str | None = Nonesort: DailyPapersSort_T | None = Nonep: int | None = Nonelimit: int | None = None ) → Iterable[PaperInfo]

Paramètres

  • date (str, facultatif) — Date au format ISO (AAAA-MM-JJ) pour laquelle récupérer les articles quotidiens. Par défaut, les plus récents sont utilisés.
  • token (Union[bool, str, None], facultatif) — Un jeton d'accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé. Pour désactiver l'authentification, passez False.
  • week (str, facultatif) — Semaine au format ISO (AAAA-Sss) pour laquelle récupérer les articles quotidiens. Exemple : 2025-W09.
  • month (str, facultatif) — Mois au format ISO (AAAA-MM) pour lequel récupérer les articles quotidiens. Exemple, 2025-02.
  • submitter (str, facultatif) — Nom d'utilisateur du soumetteur pour filtrer les articles quotidiens.
  • sort (Literal["publishedAt", "trending"], facultatif) — Ordre de tri des articles quotidiens. Peut être par publishedAt ou par trending. Valeur par défaut : "publishedAt"
  • p (int, facultatif) — Numéro de page pour la pagination. Valeur par défaut : 0.
  • limit (int, facultatif) — Limite du nombre d'articles à récupérer. Valeur par défaut : 50.

Retourne

Iterable[PaperInfo]

un itérable d'objets huggingface_hub.hf_api.PaperInfo.

Liste les articles quotidiens publiés à une date donnée sur le Hugging Face Hub.

Exemple :

>>> from huggingface_hub import HfApi

>>> api = HfApi()
>>> list(api.list_daily_papers(date="2025-10-29"))

list_dataset_parquet_files

< >

( repo_id: strconfig: str | None = Nonetoken: bool | str | None = None ) → list[DatasetParquetEntry]

Paramètres

  • repo_id (str) — L'identifiant du dépôt de jeu de données (par ex. "username/dataset-name").
  • config (str, facultatif) — Filtre par un nom de configuration/sous-ensemble spécifique. S’il est fourni, seuls les fichiers parquet correspondant à cette configuration sont renvoyés.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

list[DatasetParquetEntry]

une liste d'objets DatasetParquetEntry contenant la configuration, la partition, l'URL et la taille de chaque fichier parquet.

Liste les fichiers parquet disponibles pour un jeu de données sur le Hub.

Tous les jeux de données hébergés sur le Hub sont convertis automatiquement au format Parquet par le Dataset Viewer. Cette méthode renvoie la liste des fichiers parquet avec leurs URL, configurations, partitions et tailles.

Exemple :

>>> from huggingface_hub import list_dataset_parquet_files
>>> list_dataset_parquet_files("lhoestq/demo1")
>>> entries[0]
DatasetParquetEntry(config='default', split='train', url='https://huggingface.co/...', size=5038)

list_datasets

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Nonebenchmark: Literal[True] | Literal['official'] | str | None = Nonedataset_name: str | None = Nonegated: bool | None = Nonelanguage_creators: str | list[str] | None = Nonelanguage: str | list[str] | None = Nonemultilinguality: str | list[str] | None = Nonesize_categories: str | list[str] | None = Nonetask_categories: str | list[str] | None = Nonetask_ids: str | list[str] | None = Nonesearch: str | None = Nonesort: DatasetSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandDatasetProperty_T] | None = Nonefull: bool | None = Nonetoken: bool | str | None = None ) → Iterable[DatasetInfo]

Paramètres

  • filter (str ou Iterable[str], facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères pour filtrer les jeux de données sur le hub.
  • author (str, facultatif) — Une chaîne de caractères qui identifie l'auteur des jeux de données renvoyés.
  • benchmark (True, "official", str, facultatif) — Filtre les jeux de données par benchmark. Peut être True ou "official" pour retourner les jeux de données de benchmark officiels. Pour la compatibilité future, peut également être une chaîne de caractères représentant le nom du benchmark (actuellement, seul « official » est pris en charge).
  • dataset_name (str, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères permettant d’identifier des jeux de données sur le Hub par leur nom, par exemple SQAC ou wikineural
  • gated (bool, facultatif) — Un booléen pour filtrer les jeux de données sur le Hub en fonction de leur statut de gated. Par défaut, tous les jeux de données sont renvoyés. Si gated=True est passé, seuls les jeux de données gated sont renvoyés. Si gated=False est passé, seuls les jeux de données non gated sont renvoyés.
  • language_creators (str ou List, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères qui peut être utilisée pour identifier les jeux de données sur le Hub selon la manière dont les données ont été curatées, par exemple crowdsourced ou machine_generated.
  • language (str ou List, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères représentant un code de langue à deux caractères, utilisé pour filtrer les jeux de données sur le Hub.
  • multilinguality (str ou List, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères représentant un filtre pour les jeux de données qui contiennent plusieurs langues.
  • size_categories (str ou List, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères permettant d’identifier les jeux de données sur le Hub en fonction de leur taille, par exemple 100K<n<1M ou 1M<n<10M.
  • task_categories (str ou List, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères qui peut être utilisée pour identifier les jeux de données sur le Hub par la tâche conçue, telle que audio_classification ou named_entity_recognition.
  • task_ids (str ou List, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères permettant d’identifier des jeux de données sur le Hub par tâche spécifique, comme speech_emotion_recognition ou paraphrase.
  • search (str, facultatif) — Une chaîne de caractères qui sera contenue dans les jeux de données renvoyés.
  • sort (DatasetSort_T, facultatif) — La clé à utiliser pour trier les jeux de données résultants. Les valeurs possibles sont « created_at », « downloads », « last_modified », « likes » et « trending_score ».
  • limit (int, facultatif) — La limite sur le nombre de jeux de données récupérés. Laisser cette option à None récupère tous les jeux de données.
  • expand (list[ExpandDatasetProperty_T], facultatif) — Liste des propriétés à retourner dans la réponse. Lorsqu’il est utilisé, seules les propriétés de la liste seront retournées. Ce paramètre ne peut pas être utilisé si full est passé. Les valeurs possibles sont "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage" et "resourceGroup".
  • full (bool, facultatif) — Indique s'il faut récupérer toutes les données du jeu de données, y compris last_modified, card_data et les fichiers. Peut contenir des informations utiles telles que l'identifiant PapersWithCode.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[DatasetInfo]

un itérable d'objets huggingface_hub.hf_api.DatasetInfo.

Liste les jeux de données hébergés sur le Huggingface Hub, en fonction de certains filtres.

Exemple d'utilisation avec l'argument filter :

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets
>>> api.list_datasets()


# List only the text classification datasets
>>> api.list_datasets(filter="task_categories:text-classification")


# List only the datasets in russian for language modeling
>>> api.list_datasets(
...     filter=("language:ru", "task_ids:language-modeling")
... )

# List FiftyOne datasets (identified by the tag "fiftyone" in dataset card)
>>> api.list_datasets(filter="fiftyone")

Exemple d'utilisation avec l'argument search :

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets with "text" in their name
>>> api.list_datasets(search="text")

# List all datasets with "text" in their name made by google
>>> api.list_datasets(search="text", author="google")

list_inference_catalog

< >

( accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = Noneengine: Literal['llamacpp', 'sglang', 'tei', 'vllm'] | str | None = Nonelicense: str | None = Nonetask: str | None = Nonesearch: str | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → list[InferenceCatalogModel]

Paramètres

  • accelerator (str, facultatif) — Ne renvoyer que les modèles qui disposent d'une recette pour cet accélérateur ("cpu", "gpu" ou "neuron").
  • engine (str, facultatif) — Ne renvoyer que les modèles qui disposent d’une recette pour ce moteur d’inférence (par ex. "vllm", "llamacpp", "tei", "sglang").
  • license (str, facultatif) — Ne renvoyer que les modèles sous cette licence (par ex. "Apache 2.0").
  • task (str, facultatif) — Ne renvoyer que les modèles pour cette tâche (par ex. "text-generation").
  • search (str, facultatif) — Ne renvoyer que les modèles correspondant à cette requête de recherche.
  • limit (int, facultatif) — Le nombre maximal de modèles à retourner.
  • token (bool ou str, facultatif) — Un jeton d'accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l'authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication).

Retourne

list[InferenceCatalogModel]

Les modèles disponibles dans le catalogue, chacun avec ses recettes testées.

Liste les modèles disponibles dans le catalogue d’inférence Hugging Face.

L'objectif du catalogue d'inférence est de fournir une liste de modèles sélectionnés, optimisés pour l'inférence et dont les configurations par défaut ont été testées. Consultez https://huggingface.co/proxy/endpoints.huggingface.co/catalog pour obtenir la liste des modèles disponibles dans le catalogue.

Utilisez create_inference_endpoint_from_catalog() pour déployer un modèle ou une recette à partir du catalogue.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> catalog = api.list_inference_catalog(task="text-generation", accelerator="neuron")
>>> [(model.repo_id, [recipe.id for recipe in model.recipes]) for model in catalog]
[('meta-llama/Llama-3.1-8B-Instruct', ['sizzling-biryani-g4xsi1ac', 'artisanal-quinoa-yz9ynamx']), ...]

list_inference_catalog est expérimental. Son API est susceptible d’évoluer à l’avenir. Merci de nous faire part de vos retours si vous avez des suggestions ou des demandes.

list_inference_endpoints

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → listInferenceEndpoint

Paramètres

  • namespace (str, facultatif) — L'espace de noms pour lequel lister les points de terminaison. Par défaut, l'espace de noms de l'utilisateur actuel. Définissez-le sur "*" pour lister tous les points de terminaison de tous les espaces de noms (c'est-à-dire l'espace de noms personnel et toutes les organisations auxquelles l'utilisateur appartient).
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

listeInferenceEndpoint

Une liste de tous les points d'inférence pour l'espace de noms donné.

Liste tous les points d'inférence pour l'espace de noms donné.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_inference_endpoints()
[InferenceEndpoint(name='my-endpoint', ...), ...]

list_inference_endpoints_hardware

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → list[InferenceEndpointHardware]

Paramètres

  • namespace (str, facultatif) — L'espace de noms dont il faut lister le matériel disponible et le quota d'accélérateurs. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d'accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l'authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication).

Retourne

list[InferenceEndpointHardware]

Le matériel disponible chez chaque fournisseur et dans chaque région, y compris le matériel actuellement indisponible ou obsolète.

Listez le matériel disponible pour déployer un Inference Endpoint.

Chaque entrée contient les valeurs exactes de vendor, region, accelerator, instance_type et instance_size attendues par create_inference_endpoint(), ainsi que le prix et le quota d'accélérateurs de l'espace de noms.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware = api.list_inference_endpoints_hardware()
>>> [hw.id for hw in hardware if hw.accelerator == "gpu" and hw.status == "available"]
['aws-us-east-1-nvidia-l4-x1', 'aws-us-east-1-nvidia-l4-x4', ...]

list_jobs

< >

( status: list[JobStage | str] | JobStage | str | None = Nonelabels: dict[str, str] | None = Nonetimeout: int | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → Iterable[JobInfo]

Paramètres

  • status (JobStage, str ou list, facultatif) — Ne renvoyer que les Jobs ayant le(s) statut(s) indiqué(s), par exemple "RUNNING" ou [JobStage.RUNNING, JobStage.SCHEDULING]. Voir JobStage pour les valeurs possibles.
  • labels (dict[str, str], facultatif) — Ne renvoyer que les Jobs qui possèdent toutes les étiquettes key=value données, par exemple {"env": "prod", "team": "ml"}.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.
  • namespace (str, facultatif) — L’espace de noms à partir duquel la liste des tâches est récupérée. Par défaut, l’espace de noms de l’utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

Iterable[JobInfo]

un itérable d'objets JobInfo.

Lister les Jobs de calcul sur l’infrastructure Hugging Face.

list_jobs_hardware

< >

( token: bool | str | None = None ) → list[JobHardwareInfo]

Retourne

list[JobHardwareInfo]

Une liste des configurations matérielles disponibles.

Liste les options de matériel disponibles pour les Jobs sur l’infrastructure de Hugging Face.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware_list = api.list_jobs_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ephemeral_storage='20 GB', accelerator=None, unit_cost_micro_usd=167, unit_cost_usd=0.000167, unit_label='minute')
>>> hardware_list[0].name
'cpu-basic'

# Filter GPU options
>>> gpu_hardware = [hw for hw in hardware_list if hw.accelerator is not None]
>>> gpu_hardware[0].accelerator.model
'T4'

list_lfs_files

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[LFSFileInfo]

Paramètres

  • repo_id (str) — Le dépôt pour lequel vous répertoriez les fichiers LFS.
  • repo_type (str, facultatif) — Type de dépôt. À définir sur "dataset" ou "space" lors de l’énumération depuis un dataset ou un space, None ou "model" lors de l’énumération depuis un model. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[LFSFileInfo]

Un itérateur d'objets LFSFileInfo.

Lister tous les fichiers LFS d’un dépôt sur le Hub.

Cela est principalement utile pour compter la quantité de stockage utilisée par un dépôt et pour éventuellement nettoyer les fichiers volumineux avec permanently_delete_lfs_files(). Notez que ce serait une action permanente qui affectera tous les commits référencant ces fichiers supprimés et qui ne peut pas être annulée.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

list_liked_repos

< >

( user: str | None = Nonetoken: bool | str | None = None ) → UserLikes

Paramètres

  • user (str, facultatif) — Nom de l'utilisateur pour lequel vous souhaitez récupérer les « j'aime ».
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

UserLikes

objet contenant le nom d'utilisateur et 3 listes d'identifiants de dépôts (1 pour les modèles, 1 pour les jeux de données et 1 pour les Spaces).

Lève

ValueError

  • ValueError — Si user n'est pas transmis et qu'aucun jeton n'est trouvé (ni en argument, ni sur la machine).

Liste tous les dépôts publics aimés par un utilisateur sur huggingface.co.

Cette liste est publique, le jeton est donc facultatif. Si user n'est pas transmis, il se substitue par l'utilisateur connecté par défaut.

Voir aussi unlike().

Exemple :

>>> from huggingface_hub import list_liked_repos

>>> likes = list_liked_repos("julien-c")

>>> likes.user
"julien-c"

>>> likes.models
["osanseviero/streamlit_1.15", "Xhaheen/ChatGPT_HF", ...]

list_models

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Noneapps: str | list[str] | None = Nonegated: bool | None = Noneinference: Literal['warm'] | None = Noneinference_provider: Literal['all'] | PROVIDER_T | list[PROVIDER_T] | None = Nonetrained_dataset: str | list[str] | None = Nonesearch: str | None = Nonepipeline_tag: str | None = Nonenum_parameters: str | None = Noneemissions_thresholds: tuple[float, float] | None = Nonesort: ModelSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandModelProperty_T] | None = Nonefull: bool | None = NonecardData: bool = Falsefetch_config: bool = Falsetoken: bool | str | None = None ) → Iterable[ModelInfo]

Paramètres

  • filter (str ou Iterable[str], facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères pour filtrer les modèles sur le Hub. Les modèles peuvent être filtrés par bibliothèque, langue, tâche, balises, etc.
  • author (str, facultatif) — Une chaîne de caractères qui identifie l'auteur (utilisateur ou organisation) des modèles renvoyés.
  • apps (str ou List, facultatif) — Une chaîne de caractères ou une liste de chaînes de caractères pour filtrer les modèles sur le Hub qui prennent en charge les applications spécifiées. Les valeurs d'exemple incluent "ollama" ou ["ollama", "vllm"].
  • gated (bool, facultatif) — Un booléen pour filtrer les modèles sur le Hub en fonction de leur statut de gated. Par défaut, tous les modèles sont renvoyés. Si gated=True est passé, seuls les modèles gated sont renvoyés. Si gated=False est passé, seuls les modèles non gated sont renvoyés.
  • inference (Literal["warm"], facultatif) — Si « warm », filtre les modèles du Hub actuellement servis par au moins un fournisseur.
  • inference_provider (Literal["all"] ou str, facultatif) — Une chaîne de caractères pour filtrer les modèles du Hub servis par un fournisseur spécifique. Passez "all" pour obtenir tous les modèles servis par au moins un fournisseur.
  • trained_dataset (str ou List, facultatif) — Une étiquette de chaîne de caractères ou une liste d’étiquettes de chaînes de caractères du jeu de données d’entraînement pour un modèle sur le Hub.
  • search (str, facultatif) — Une chaîne de caractères qui sera contenue dans les identifiants de modèles renvoyés.
  • pipeline_tag (str, facultatif) — Une chaîne de caractères représentant un tag de pipeline pour filtrer les modèles sur le Hub, par exemple summarization.
  • num_parameters (str, facultatif) — Filtre les modèles par nombre de paramètres. Accepte la même syntaxe d’intervalle que l’interface et l’API du Hub, par exemple "min:6B,max:128B", "min:6B" ou "max:128B".
  • emissions_thresholds (Tuple, facultatif) — Un tuple de deux entiers ou flottants représentant une empreinte carbone minimale et maximale, en grammes, pour filtrer les modèles résultants.
  • sort (ModelSort_T, facultatif) — La clé à utiliser pour trier les modèles résultants. Les valeurs possibles sont « created_at », « downloads », « last_modified », « likes » et « trending_score ».
  • limit (int, facultatif) — La limite sur le nombre de modèles récupérés. Laisser cette option à None récupère tous les modèles.
  • expand (list[ExpandModelProperty_T], facultatif) — Liste des propriétés à renvoyer dans la réponse. Lorsqu’il est utilisé, seules les propriétés de la liste seront renvoyées. Ce paramètre ne peut pas être utilisé si full, cardData ou fetch_config sont passés. Les valeurs possibles sont "author", "cardData", "config", "createdAt", "disabled", "downloads", "downloadsAllTime", "evalResults", "gated", "gguf", "inference", "inferenceProviderMapping", "lastModified", "library_name", "likes", "mask_token", "model-index", "pipeline_tag", "private", "safetensors", "sha", "siblings", "spaces", "tags", "transformersInfo", "trendingScore", "widgetData" et "resourceGroup".
  • full (bool, facultatif) — Indique s'il faut récupérer toutes les données du modèle, y compris last_modified, le sha, les fichiers et les tags. Cette valeur est définie sur True par défaut lors de l'utilisation d'un filtre.
  • cardData (bool, facultatif) — Indique s'il faut récupérer les métadonnées du modèle. Peut contenir des informations utiles telles que les émissions de carbone, les métriques et les jeux de données utilisés pour l'entraînement.
  • fetch_config (bool, facultatif) — Indique s'il faut également récupérer les configurations du modèle. Ce n'est pas inclus dans full en raison de sa taille.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[ModelInfo]

un itérable d'objets huggingface_hub.hf_api.ModelInfo.

Liste les modèles hébergés sur le Huggingface Hub, en fonction de certains filtres.

Exemple :

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all models
>>> api.list_models()

# List text classification models
>>> api.list_models(filter="text-classification")

# List models from the KerasHub library
>>> api.list_models(filter="keras-hub")

# List models served by Cohere
>>> api.list_models(inference_provider="cohere")

# List models with "bert" in their name
>>> api.list_models(search="bert")

# List models with "bert" in their name and pushed by google
>>> api.list_models(search="bert", author="google")

# List models with 6B to 128B parameters
>>> api.list_models(num_parameters="min:6B,max:128B", sort="likes")

list_organization_followers

< >

( organization: strtoken: bool | str | None = None ) → Iterable[User]

Paramètres

  • organization (str) — Nom de l'organisation dont on souhaite obtenir les abonnés.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[User]

Une liste d'objets User correspondant aux abonnés de l'organisation.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 si l’organisation n’existe pas sur le Hub.

Lister les abonnés d'une organisation sur le Hub.

list_organization_members

< >

( organization: strtoken: bool | str | None = None ) → Iterable[User]

Paramètres

  • organization (str) — Nom de l’organisation dont on souhaite obtenir les membres.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[User]

Une liste d'objets User avec les membres de l'organisation.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 si l’organisation n’existe pas sur le Hub.

Liste des membres d'une organisation sur le Hub.

list_papers

< >

( query: str | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → Iterable[PaperInfo]

Paramètres

  • query (str, facultatif) — Chaîne de requête de recherche pour trouver des articles. Si fournie, renvoie les articles correspondant à la requête.
  • limit (int, facultatif) — Le nombre maximal de papiers à retourner.
  • token (Union[bool, str, None], facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[PaperInfo]

un itérable d'objets huggingface_hub.hf_api.PaperInfo.

Liste les articles quotidiens sur le Hugging Face Hub à partir d'une requête de recherche.

Exemple :

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all papers with "attention" in their title
>>> api.list_papers(query="attention")

list_pending_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Paramètres

  • repo_id (str) — L’identifiant du dépôt pour lequel obtenir les demandes d’accès.
  • repo_type (str, facultatif) — Le type de dépôt pour lequel obtenir les demandes d’accès. Doit être l’un des éléments suivants : model, dataset ou space. La valeur par défaut est model.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[AccessRequest]

Un itérable d’objets AccessRequest. Chaque élément contient un attribut username, request_id, email, status et timestamp. Si le dépôt protégé possède un formulaire personnalisé, l’attribut fields sera rempli avec les réponses de l’utilisateur.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 si le dépôt n'est pas gated.
  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.

Obtenir les demandes d'accès en attente pour un dépôt gated donné.

Une demande en attente signifie que l'utilisateur a demandé l'accès au dépôt mais que la demande n'a pas encore été traitée. Si le mode d'approbation est automatique, cette liste doit être vide. Les demandes en attente peuvent être acceptées ou rejetées à l'aide de accept_access_request() et reject_access_request().

Pour plus d'informations sur les dépôts à accès restreint, consultez https://huggingface.co/docs/hub/models-gated.

Exemple :

>>> from huggingface_hub import list_pending_access_requests, accept_access_request

# List pending requests
>>> requests = list(list_pending_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='pending',
        fields=None,
    ),
    ...
]

# Accept Clem's request
>>> accept_access_request("meta-llama/Llama-2-7b", "clem")

list_rejected_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Paramètres

  • repo_id (str) — L’identifiant du dépôt pour lequel obtenir les demandes d’accès.
  • repo_type (str, facultatif) — Le type de dépôt pour lequel obtenir les demandes d’accès. Doit être l’un des éléments suivants : model, dataset ou space. La valeur par défaut est model.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[AccessRequest]

Un itérable d’objets AccessRequest. Chaque élément contient un attribut username, request_id, email, status et timestamp. Si le dépôt protégé possède un formulaire personnalisé, l’attribut fields sera rempli avec les réponses de l’utilisateur.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 si le dépôt n'est pas gated.
  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.

Obtenir les demandes d'accès refusées pour un dépôt sous contrôle donné.

Une demande rejetée signifie que l'utilisateur a demandé l'accès au dépôt et que cette demande a été explicitement rejetée par un propriétaire du dépôt (vous-même ou un autre utilisateur de votre organisation). L'utilisateur ne peut télécharger aucun fichier du dépôt. Les demandes rejetées peuvent être acceptées ou annulées à tout moment à l'aide de accept_access_request() et cancel_access_request(). Une demande annulée retourne dans la liste des demandes en attente, tandis qu'une demande acceptée passe dans la liste des demandes acceptées.

Pour plus d'informations sur les dépôts à accès restreint, consultez https://huggingface.co/docs/hub/models-gated.

Exemple :

>>> from huggingface_hub import list_rejected_access_requests

>>> requests = list(list_rejected_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='rejected',
        fields=None,
    ),
    ...
]

list_repo_commits

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = Nonerevision: str | None = Noneformatted: bool = False ) → list[GitCommitInfo]

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" pour lister les commits d’un dataset ou d’un Space, None ou "model" pour list depuis un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • formatted (bool) — Indique s'il faut renvoyer le titre et la description des commits au format HTML. Valeur par défaut : False.

Retourne

list[GitCommitInfo]

liste d'objets contenant des informations sur les commits d'un dépôt sur le Hub.

Lève

RepositoryNotFoundError ou RevisionNotFoundError

  • RepositoryNotFoundError — Si le dépôt n'est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • RevisionNotFoundError — Si la révision n’est pas trouvée (erreur 404) dans le dépôt.

Obtenir la liste des commits d'une révision donnée pour un dépôt sur le Hub.

Les commits sont triés par date (le dernier commit en premier).

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Commits are sorted by date (last commit first)
>>> initial_commit = api.list_repo_commits("gpt2")[-1]

# Initial commit is always a system commit containing the `.gitattributes` file.
>>> initial_commit
GitCommitInfo(
    commit_id='9b865efde13a30c13e0a33e536cf3e4a5a9d71d8',
    authors=['system'],
    created_at=datetime.datetime(2019, 2, 18, 10, 36, 15, tzinfo=datetime.timezone.utc),
    title='initial commit',
    message='',
    formatted_title=None,
    formatted_message=None
)

# Create an empty branch by deriving from initial commit
>>> api.create_branch("gpt2", branch="new_empty_branch", revision=initial_commit.commit_id)

list_repo_files

< >

( repo_id: strrevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → list[str]

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • revision (str, facultatif) — La révision du dépôt à partir de laquelle obtenir les informations.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

list[str]

la liste des fichiers d'un dépôt donné.

Obtenir la liste des fichiers d'un dépôt donné.

list_repo_likers

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[User]

Paramètres

  • repo_id (str) — Le dépôt à récupérer. Exemple : "user/my-cool-model".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.

Retourne

Iterable[User]

un itérable d'objets huggingface_hub.hf_api.User.

Liste tous les utilisateurs qui ont aimé un dépôt donné sur le hugging Face Hub.

Voir aussi list_liked_repos().

list_repo_refs

< >

( repo_id: strrepo_type: str | None = Noneinclude_pull_requests: bool = Falsetoken: str | bool | None = None ) → GitRefs

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • repo_type (str, facultatif) — À définir sur "dataset", "space" ou "kernel" si vous répertoriez les refs d’un dataset, d’un Space ou d’un Kernel, None ou "model" si vous répertoriez depuis un model. La valeur par défaut est None.
  • include_pull_requests (bool, facultatif) — Indique s'il faut inclure les références des pull requests dans la liste. La valeur par défaut est False.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

GitRefs

objet contenant toutes les informations sur les branches et les tags d'un dépôt sur le Hub.

Obtenir la liste des références d'un dépôt donné (à la fois les étiquettes et les branches).

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_repo_refs("gpt2")
GitRefs(branches=[GitRefInfo(name='main', ref='refs/heads/main', target_commit='e7da7f221d5bf496a48136c0cd264e630fe9fcc8')], converts=[], tags=[])

>>> api.list_repo_refs("bigcode/the-stack", repo_type='dataset')
GitRefs(
    branches=[
        GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'),
        GitRefInfo(name='v1.1.a1', ref='refs/heads/v1.1.a1', target_commit='f9826b862d1567f3822d3d25649b0d6d22ace714')
    ],
    converts=[],
    tags=[
        GitRefInfo(name='v1.0', ref='refs/tags/v1.0', target_commit='c37a8cd1e382064d8aced5e05543c5f7753834da')
    ]
)

list_repo_tree

< >

( repo_id: strpath_in_repo: str | None = Nonerecursive: bool = Falseexpand: bool = Falserevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → Iterable[Union[RepoFile, RepoFolder]]

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • path_in_repo (str, facultatif) — Chemin relatif de l'arborescence (dossier) dans le dépôt, par exemple : "checkpoints/1fec34a/results". Par défaut, la racine de l'arborescence (dossier) du dépôt est utilisée.
  • recursive (bool, facultatif, par défaut False) — Indique s'il faut lister récursivement les fichiers et les dossiers de l'arborescence.
  • expand (bool, facultatif, par défaut False) — Indique s'il faut récupérer plus d'informations sur les fichiers et dossiers de l'arborescence (par exemple, la dernière commit et les résultats de l'analyse de sécurité des fichiers). Cette opération est plus coûteuse pour le serveur, si bien que seules 50 résultats sont renvoyés par page (au lieu de 1000). Comme la pagination est implémentée dans huggingface_hub, cela reste transparent pour vous, à l'exception du temps nécessaire pour obtenir les résultats.
  • revision (str, facultatif) — La révision du dépôt à partir de laquelle obtenir l'arborescence. Par défaut, la branche "main".
  • repo_type (str, facultatif) — Le type de dépôt à partir duquel obtenir l’arborescence ("model", "dataset", "space" ou "kernel"). La valeur par défaut est "model".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[Union[RepoFile, RepoFolder]]

Les informations sur les fichiers et dossiers de l’arborescence, sous forme d’un itérable d’objets RepoFile et RepoFolder. L’ordre des fichiers et dossiers n’est pas garanti.

Lève

RepositoryNotFoundError ou RevisionNotFoundError ou ~utils.RemoteEntryNotFoundError

  • RepositoryNotFoundError — Si le dépôt n'est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • RevisionNotFoundError — Si la révision n’est pas trouvée (erreur 404) dans le dépôt.
  • ~utils.RemoteEntryNotFoundError — Si l’arborescence (dossier) n’existe pas (erreur 404) dans le dépôt.

Lister les fichiers et dossiers de l’arborescence d’un dépôt et obtenir des informations à leur sujet.

Exemples :

Obtenir des informations sur l’arborescence d’un dépôt.

>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("lysandre/arxiv-nlp")
>>> repo_tree
<generator object HfApi.list_repo_tree at 0x7fa4088e1ac0>
>>> list(repo_tree)
[
    RepoFile(path='.gitattributes', size=391, blob_id='ae8c63daedbd4206d7d40126955d4e6ab1c80f8f', lfs=None, last_commit=None, security=None),
    RepoFile(path='README.md', size=391, blob_id='43bd404b159de6fba7c2f4d3264347668d43af25', lfs=None, last_commit=None, security=None),
    RepoFile(path='config.json', size=554, blob_id='2f9618c3a19b9a61add74f70bfb121335aeef666', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='flax_model.msgpack', size=497764107, blob_id='8095a62ccb4d806da7666fcda07467e2d150218e',
        lfs={'size': 497764107, 'sha256': 'd88b0d6a6ff9c3f8151f9d3228f57092aaea997f09af009eefd7373a77b5abb9', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='merges.txt', size=456318, blob_id='226b0752cac7789c48f0cb3ec53eda48b7be36cc', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='pytorch_model.bin', size=548123560, blob_id='64eaa9c526867e404b68f2c5d66fd78e27026523',
        lfs={'size': 548123560, 'sha256': '9be78edb5b928eba33aa88f431551348f7466ba9f5ef3daf1d552398722a5436', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='vocab.json', size=898669, blob_id='b00361fece0387ca34b4b8b8539ed830d644dbeb', lfs=None, last_commit=None, security=None)]
]

Obtenez encore plus d’informations sur l’arborescence d’un dépôt (dernier commit et résultats de l’analyse de sécurité des fichiers)

>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("prompthero/openjourney-v4", expand=True)
>>> list(repo_tree)
[
    RepoFolder(
        path='feature_extractor',
        tree_id='aa536c4ea18073388b5b0bc791057a7296a00398',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFolder(
        path='safety_checker',
        tree_id='65aef9d787e5557373fdf714d6c34d4fcdd70440',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFile(
        path='model_index.json',
        size=582,
        blob_id='d3d7c1e8c3e78eeb1640b8e2041ee256e24c9ee1',
        lfs=None,
        last_commit={
            'oid': 'b195ed2d503f3eb29637050a886d77bd81d35f0e',
            'title': 'Fix deprecation warning by changing `CLIPFeatureExtractor` to `CLIPImageProcessor`. (#54)',
            'date': datetime.datetime(2023, 5, 15, 21, 41, 59, tzinfo=datetime.timezone.utc)
        },
        security={
            'safe': True,
            'av_scan': {'virusFound': False, 'virusNames': None},
            'pickle_import_scan': None
        }
    )
    ...
]

list_scheduled_jobs

< >

( labels: dict[str, str] | None = Nonetimeout: int | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → list[ScheduledJobInfo]

Paramètres

  • labels (dict[str, str], facultatif) — Ne renvoyer que les Jobs planifiés qui possèdent toutes les étiquettes key=value données, par exemple {"env": "prod", "team": "ml"}.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.
  • namespace (str, facultatif) — L’espace de noms à partir duquel la liste des tâches est récupérée. Par défaut, l’espace de noms de l’utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

list[ScheduledJobInfo]

une liste d'objets ScheduledJobInfo.

Liste les Jobs de calcul planifiés sur l’infrastructure Hugging Face.

list_space_templates

< >

( token: str | bool | None = None ) → list[SpaceTemplate]

Paramètres

Retourne

list[SpaceTemplate]

La liste des modèles d’espaces disponibles.

Lister les modèles de Space officiels disponibles sur le Hub.

Le repo_id d’un modèle retourné (ou son name court) peut être transmis en tant que space_template à HfApi.create_repo() pour initialiser un nouvel espace à partir de ce modèle.

Exemple :

>>> from huggingface_hub import list_space_templates
>>> templates = list_space_templates()
>>> templates[0]
SpaceTemplate(name='Streamlit', repo_id='streamlit/streamlit-template-space', sdk='docker', preferred_private=False)

list_spaces

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Nonesearch: str | None = Nonedatasets: str | Iterable[str] | None = Nonemodels: str | Iterable[str] | None = Nonelinked: bool = Falsesort: SpaceSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandSpaceProperty_T] | None = Nonefull: bool | None = Nonetoken: bool | str | None = None ) → Iterable[SpaceInfo]

Paramètres

  • filter (str ou Iterable, facultatif) — Une étiquette sous forme de chaîne de caractères ou une liste d’étiquettes permettant d’identifier les Spaces sur le Hub.
  • author (str, facultatif) — Une chaîne de caractères qui identifie l'auteur des Spaces retournés.
  • search (str, facultatif) — Une chaîne de caractères qui sera contenue dans les Spaces renvoyés.
  • datasets (str ou Iterable, facultatif) — Indique s'il faut retourner les Spaces qui utilisent un jeu de données. Le nom d'un jeu de données spécifique peut être passé sous forme de chaîne de caractères.
  • models (str ou Iterable, facultatif) — Indique s'il faut retourner les Spaces qui utilisent un modèle. Le nom d'un modèle spécifique peut être passé sous forme de chaîne de caractères.
  • linked (bool, facultatif) — Indique s'il faut retourner les Spaces qui utilisent un modèle ou un jeu de données.
  • sort (SpaceSort_T, facultatif) — La clé à utiliser pour trier les espaces résultants. Les valeurs possibles sont « created_at », « last_modified », « likes » et « trending_score ».
  • limit (int, facultatif) — La limite sur le nombre de Spaces récupérés. Laisser cette option à None récupère tous les Spaces.
  • expand (list[ExpandSpaceProperty_T], facultatif) — Liste des propriétés à renvoyer dans la réponse. Lorsqu’il est utilisé, seules les propriétés de la liste seront renvoyées. Ce paramètre ne peut pas être utilisé si full est passé. Les valeurs possibles sont "author", "cardData", "datasets", "disabled", "lastModified", "createdAt", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage" et "resourceGroup".
  • full (bool, facultatif) — Indique s'il faut récupérer toutes les données des Spaces, y compris les champs last_modified, siblings et card_data.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[SpaceInfo]

un itérable d'objets huggingface_hub.hf_api.SpaceInfo.

Liste les espaces hébergés sur le Huggingface Hub, en fonction de certains filtres.

list_spaces_hardware

< >

( token: bool | str | None = None ) → list[JobHardwareInfo]

Retourne

list[JobHardwareInfo]

Une liste des configurations matérielles disponibles.

Liste les options de matériel disponibles pour Spaces.

Exemple :

>>> from huggingface_hub import list_spaces_hardware
>>> hardware_list = list_spaces_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ...)
>>> hardware_list[0].name
'cpu-basic'

list_user_followers

< >

( username: strtoken: bool | str | None = None ) → Iterable[User]

Paramètres

  • username (str) — Nom d'utilisateur de l'utilisateur dont on souhaite obtenir les abonnés.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[User]

Une liste d'objets User correspondant aux abonnés de l'utilisateur.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 si l’utilisateur n’existe pas sur le Hub.

Obtenir la liste des abonnés d'un utilisateur sur le Hub.

list_user_following

< >

( username: strtoken: bool | str | None = None ) → Iterable[User]

Paramètres

  • username (str) — Nom d'utilisateur de l'utilisateur dont on souhaite obtenir la liste des comptes suivis.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[User]

Une liste d'objets User correspondant aux utilisateurs suivis par l'utilisateur.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 si l’utilisateur n’existe pas sur le Hub.

Obtenir la liste des utilisateurs suivis par un utilisateur sur le Hub.

list_user_repos

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → Iterable[RepoStorageInfo]

Paramètres

  • namespace (str, facultatif) — Nom de l’organisation. S’il n’est pas fourni, liste les dépôts de l’utilisateur authentifié.
  • token (bool ou str, facultatif) — Un jeton d'accès utilisateur valide. Par défaut, le jeton enregistré localement est utilisé.

Retourne

Iterable[RepoStorageInfo]

Un itérable d'objets RepoStorageInfo.

Liste tous les dépôts (modèles, jeux de données, espaces, buckets) d’un utilisateur ou d’une organisation avec les informations de stockage.

Utilise le point de terminaison /api/settings/repositories pour l'utilisateur authentifié ou /api/organizations/{namespace}/settings/repositories pour une organisation.

Exemple :

>>> from huggingface_hub import list_user_repos

>>> repos = list(list_user_repos())
>>> repos[0]
RepoStorageInfo(id='username/my-model', type='model', ...)

>>> # List repos from an organization
>>> repos = list(list_user_repos(namespace="my-org"))

list_webhooks

< >

( token: bool | str | None = None ) → list[WebhookInfo]

Paramètres

Retourne

list[WebhookInfo]

Liste d'objets d'informations de webhook.

Liste tous les webhooks configurés.

Exemple :

>>> from huggingface_hub import list_webhooks
>>> webhooks = list_webhooks()
>>> len(webhooks)
2
>>> webhooks[0]
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)

merge_pull_request

< >

( repo_id: strdiscussion_num: inttoken: bool | str | None = Nonecomment: str | None = Nonerepo_type: str | None = None ) → DiscussionStatusChange

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • discussion_num (int) — Le numéro de la Discussion ou de la Pull Request. Doit être un entier strictement positif.
  • comment (str, facultatif) — Commentaire facultatif à publier avec la modification de statut.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

DiscussionStatusChange

l'événement de changement d'état

Fusionne une Pull Request.

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

model_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = NonesecurityStatus: bool | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandModelProperty_T] | None = Nonetoken: bool | str | None = None ) → huggingface_hub.hf_api.ModelInfo

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • revision (str, facultatif) — La révision du dépôt de modèle à partir duquel obtenir les informations.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.
  • securityStatus (bool, facultatif) — Indique s'il faut également récupérer l'état de sécurité du dépôt du modèle. L'état de sécurité sera renvoyé dans le champ security_repo_status.
  • files_metadata (bool, facultatif) — Indique s'il faut ou non récupérer les métadonnées des fichiers du dépôt (taille, métadonnées LFS, etc.). La valeur par défaut est False.
  • expand (list[ExpandModelProperty_T], facultatif) — Liste des propriétés à retourner dans la réponse. Lorsqu’il est utilisé, seules les propriétés de la liste seront retournées. Ce paramètre ne peut pas être utilisé si securityStatus ou files_metadata sont passés. Les valeurs possibles sont "author", "baseModels", "cardData", "childrenModelCount", "config", "createdAt", "disabled", "downloads", "downloadsAllTime", "evalResults", "gated", "gguf", "inference", "inferenceProviderMapping", "lastModified", "library_name", "likes", "mask_token", "model-index", "pipeline_tag", "private", "safetensors", "sha", "siblings", "spaces", "tags", "transformersInfo", "trendingScore", "widgetData", "usedStorage" et "resourceGroup".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

huggingface_hub.hf_api.ModelInfo

Les informations du dépôt de modèles.

Obtenir des informations sur un modèle spécifique sur huggingface.co

Le modèle peut être privé si vous passez un jeton acceptable ou si vous êtes connecté.

Lève les erreurs suivantes :

  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError Si la révision à télécharger n'est pas trouvée.

move_bucket

< >

( from_id: strto_id: strtoken: bool | str | None = None )

Paramètres

  • from_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de bucket séparés par un /. Identifiant du bucket d'origine (par ex. "username/my-bucket").
  • to_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de bucket séparés par un /. Identifiant final du bucket (par ex. "username/new-bucket-name" ou "organization/my-bucket").
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

BucketNotFoundError

  • BucketNotFoundError — Si le bucket source ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini en private et que vous n’y avez pas accès.

Déplacer un bucket de « namespace1/repo_name1 » vers « namespace2/repo_name2 »

Notez qu'il existe certaines limitations. Pour plus d'informations sur le déplacement des dépôts, veuillez consulter https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo.

Exemple :

>>> from huggingface_hub import move_bucket

>>> # Rename a bucket within the same namespace
>>> move_bucket(from_id="username/old-name", to_id="username/new-name")

>>> # Transfer a bucket to an organization
>>> move_bucket(from_id="username/my-bucket", to_id="my-org/my-bucket")

move_repo

< >

( from_id: strto_id: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Paramètres

  • from_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /. Identifiant du dépôt d'origine.
  • to_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /. Identifiant final du dépôt.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Déplacer un dépôt de namespace1/repo_name1 vers namespace2/repo_name2

Notez qu'il existe certaines limitations. Pour plus d'informations sur le déplacement des dépôts, veuillez consulter https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo.

Lève les erreurs suivantes :

  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

paper_info

< >

( id: str ) → PaperInfo

Paramètres

  • id (str, facultatif) — Identifiant ArXiv de l'article.

Retourne

PaperInfo

Un objet PaperInfo.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 si le papier n'existe pas sur le Hub.

Obtenir des informations sur un article du Hub.

parse_safetensors_file_metadata

< >

( repo_id: strfilename: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsFileMetadata

Paramètres

  • repo_id (str) — Le nom d’un utilisateur ou d’une organisation et le nom d’un dépôt, séparés par un /.
  • filename (str) — Le nom du fichier dans le dépôt.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si le fichier se trouve dans un dataset ou un space, None ou "model" s’il se trouve dans un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — La révision git à partir de laquelle récupérer le fichier. Peut être un nom de branche, un tag ou un hachage de commit. Par défaut, pointe vers la tête de la branche "main".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • timeout (float, facultatif, valeur par défaut 10) — Nombre de secondes à attendre que le serveur envoie des données avant d’abandonner. Définir sur None pour désactiver le délai d’attente (non recommandé, car une connexion bloquée peut suspendre l’appel indéfiniment).

Retourne

SafetensorsFileMetadata

informations relatives à un fichier safetensors.

Lève

NotASafetensorsRepoError ou SafetensorsParsingError

  • NotASafetensorsRepoError — Si le dépôt n’est pas un dépôt safetensors, c’est-à-dire s’il ne contient ni le fichier model.safetensors ni le fichier model.safetensors.index.json.
  • SafetensorsParsingError — Si l’en-tête d’un fichier safetensors n’a pas pu être analysé correctement.

Analyser les métadonnées d'un fichier safetensors sur le Hub.

Pour analyser les métadonnées de tous les fichiers safetensors d'un dépôt en une seule fois, utilisez get_safetensors_metadata().

Pour plus de détails sur le format safetensors, consultez https://huggingface.co/docs/safetensors/index#format.

pause_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Paramètres

  • name (str) — Le nom du point de terminaison d’inférence à mettre en pause.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve l'Inference Endpoint. Par défaut, il s'agit de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

InferenceEndpoint

informations sur le point de terminaison d'inférence en pause.

Mettre en pause un point de terminaison d'inférence.

Un Inference Endpoint en pause n'est pas facturé. Il peut être repris à tout moment à l'aide de resume_inference_endpoint(). Ceci est différent du redimensionnement de l'Inference Endpoint à zéro avec scale_to_zero_inference_endpoint(), qui serait automatiquement redémarré lorsqu'une requête lui est adressée.

Pour plus de commodité, vous pouvez également mettre en pause un Inference Endpoint à l'aide de pause_inference_endpoint().

pause_space

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID de l'Espace à mettre en pause. Exemple : "Salesforce/BLIP2".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

SpaceRuntime

Informations d'exécution sur votre Space, y compris stage=PAUSED et le matériel demandé.

Lève

RepositoryNotFoundError ou HfHubHTTPError ou BadRequestError

  • RepositoryNotFoundError — Si votre Space n’est pas trouvé (erreur 404). La plupart du temps, le repo_id est incorrect ou votre Space est privé mais vous n’êtes pas authentifié.
  • HfHubHTTPError — 403 Forbidden : seul le propriétaire d’un Space peut le mettre en pause. Si vous souhaitez gérer un Space qui ne vous appartient pas, demandez au propriétaire en ouvrant une Discussion ou dupliquez le Space.
  • BadRequestError — Si votre Space est un Space statique. Les Spaces statiques sont toujours en cours d’exécution et ne font jamais l’objet de facturation. Si vous souhaitez masquer un Space statique, vous pouvez le passer en privé.

Mettez votre Space en pause.

Un Space en pause cesse de s’exécuter jusqu’à ce que son propriétaire le redémarre manuellement. Cela diffère de l’état de veille dans lequel les Spaces gratuits passent après 48 h d’inactivité. Le temps en pause n’est pas facturé sur votre compte, quel que soit le matériel sélectionné. Pour redémarrer votre Space, utilisez restart_space() et accédez à la page de paramètres de votre Space.

Pour plus de détails, veuillez consulter la documentation.

permanently_delete_lfs_files

< >

( repo_id: strlfs_files: Iterable[LFSFileInfo]rewrite_history: bool = Truerepo_type: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — Le dépôt pour lequel vous répertoriez les fichiers LFS.
  • lfs_files (Iterable[LFSFileInfo]) — Un itérable d’éléments LFSFileInfo à supprimer définitivement du dépôt. Utilisez list_lfs_files() pour lister tous les fichiers LFS d’un dépôt.
  • rewrite_history (bool, facultatif, par défaut True) — Indique s'il faut réécrire l'historique du dépôt afin de supprimer les pointeurs de fichiers qui référencent les fichiers LFS supprimés (recommandé).
  • repo_type (str, facultatif) — Type de dépôt. À définir sur "dataset" ou "space" lors de l’énumération depuis un dataset ou un space, None ou "model" lors de l’énumération depuis un model. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Supprimer définitivement les fichiers LFS d'un dépôt sur le Hub.

Ceci est une action permanente qui affectera tous les commits faisant référence aux fichiers supprimés et pourrait corrompre votre dépôt. Il s’agit d’une opération irréversible. N’utilisez cette fonctionnalité que si vous savez ce que vous faites.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

preupload_lfs_files

< >

( repo_id: stradditions: Iterable[CommitOperationAdd]token: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Nonenum_threads: int = 5free_memory: bool = Truegitignore_content: str | None = None )

Paramètres

  • repo_id (str) — Le dépôt dans lequel vous committrez les fichiers, par exemple : "username/custom_transformers".
  • additions (Iterable de CommitOperationAdd) — La liste des fichiers à téléverser. Avertissement : les objets de cette liste seront modifiés pour inclure des informations relatives au téléversement. Ne réutilisez pas les mêmes objets pour plusieurs commits.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — Le type de dépôt à téléverser (par ex. "model" -par défaut-, "dataset", "space" ou "kernel").
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • create_pr (boolean, facultatif) — Indique si vous prévoyez de créer une Pull Request avec cet engagement. La valeur par défaut est False.
  • num_threads (int, facultatif) — Nombre de threads simultanés pour le téléversement des fichiers. Valeur par défaut : 5. Le définir à 2 signifie qu’au maximum 2 fichiers seront téléversés simultanément.
  • free_memory (bool, facultatif, par défaut True) — Si True, l'attribut path_or_fileobj de chaque CommitOperationAdd est remplacé par un objet bytes vide après le téléversement afin d'économiser de la mémoire. Définissez False si vous devez réutiliser les objets d'opération en dehors d'un appel ultérieur à create_commit().
  • gitignore_content (str, facultatif) — Le contenu du fichier .gitignore pour savoir quels fichiers doivent être ignorés. L'ordre de priorité consiste d'abord à vérifier si gitignore_content est transmis, puis à vérifier si le fichier .gitignore est présent dans la liste des fichiers à committer, et enfin à utiliser par défaut le fichier .gitignore déjà hébergé sur le Hub (le cas échéant).

Téléversez les fichiers LFS sur S3 avant de préparer un futur commit.

Cette méthode est utile si vous générez les fichiers à téléverser à la volée et que vous ne souhaitez pas les stocker en mémoire avant de les téléverser tous d’un coup.

Ceci est une méthode destinée aux utilisateurs avancés. Vous ne devriez pas avoir besoin de l’appeler directement pour effectuer un commit standard. Utilisez plutôt create_commit() directement.

Les opérations de commit seront modifiées au cours du processus. En particulier, le path_or_fileobj associé sera supprimé après le téléversement afin d’économiser de la mémoire (et remplacé par un objet bytes vide). Ne réutilisez pas les mêmes objets, sauf pour les transmettre à create_commit(). Si vous ne souhaitez pas supprimer le contenu associé de l’objet d’opération de commit, passez free_memory=False.

Exemple :

>>> from huggingface_hub import CommitOperationAdd, preupload_lfs_files, create_commit, create_repo

>>> repo_id = create_repo("test_preupload").repo_id

# Generate and preupload LFS files one by one
>>> operations = [] # List of all `CommitOperationAdd` objects that will be generated
>>> for i in range(5):
...     content = ... # generate binary content
...     addition = CommitOperationAdd(path_in_repo=f"shard_{i}_of_5.bin", path_or_fileobj=content)
...     preupload_lfs_files(repo_id, additions=[addition]) # upload + free memory
...     operations.append(addition)

# Create commit
>>> create_commit(repo_id, operations=operations, commit_message="Commit all shards")

read_paper

< >

( id: str ) → str

Paramètres

  • id (str) — Identifiant ArXiv de l'article.

Retourne

str

Le contenu de la page du papier au format Markdown.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 si le papier n'existe pas sur le Hub.

Obtenir le contenu Markdown d’une page de papier sur le Hub.

reject_access_request

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonerejection_reason: str | Nonetoken: bool | str | None = None )

Paramètres

  • repo_id (str) — L’identifiant du dépôt pour lequel refuser la demande d’accès.
  • user (str, facultatif) — Le nom d'utilisateur de l'utilisateur dont la demande d'accès doit être rejetée. Il faut fournir exactement l'un des paramètres user ou request_id.
  • request_id (str, facultatif) — L’identifiant de la demande d’accès à rejeter (voir AccessRequest). Obligatoire lorsque le dépôt est configuré pour ne pas partager les noms d’utilisateur des demandeurs. Il faut fournir exactement l’un des deux : user ou request_id.
  • repo_type (str, facultatif) — Le type de dépôt pour lequel refuser la demande d’accès. Doit être l’un des éléments suivants : model, dataset ou space. Valeur par défaut : model.
  • rejection_reason (str, facultatif) — Raison de rejet facultative qui sera visible par l'utilisateur (200 caractères maximum).
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 si le dépôt n'est pas gated.
  • HfHubHTTPError — HTTP 403 si vous n’avez qu’un accès en lecture seule au dépôt. C’est le cas si vous n’avez pas le rôle write ou admin dans l’organisation à laquelle appartient le dépôt, ou si vous avez transmis un jeton read.
  • HfHubHTTPError — HTTP 404 si l'utilisateur n'existe pas sur le Hub.
  • HfHubHTTPError — HTTP 404 si la demande d’accès de l’utilisateur ne peut pas être trouvée.
  • HfHubHTTPError — HTTP 404 si la demande d'accès de l'utilisateur figure déjà sur la liste des demandes rejetées.

Refuser une demande d'accès d'un utilisateur pour un dépôt gated donné.

Une demande refusée est ajoutée à la liste des demandes refusées. L'utilisateur ne peut télécharger aucun fichier du dépôt. Les demandes refusées peuvent être acceptées ou annulées à tout moment à l'aide de accept_access_request() et cancel_access_request(). Une demande annulée retourne dans la liste des demandes en attente, tandis qu'une demande acceptée est ajoutée à la liste des demandes acceptées.

Pour plus d'informations sur les dépôts à accès restreint, consultez https://huggingface.co/docs/hub/models-gated.

rename_discussion

< >

( repo_id: strdiscussion_num: intnew_title: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionTitleChange

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • discussion_num (int) — Le numéro de la Discussion ou de la Pull Request. Doit être un entier strictement positif.
  • new_title (str) — Le nouveau titre de la discussion
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" lors d’un téléchargement vers un jeu de données ou un espace, None ou "model" lors d’un téléchargement vers un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

DiscussionTitleChange

l'événement de changement de titre

Renomme une Discussion.

Exemples :

>>> new_title = "New title, fixing a typo"
>>> HfApi().rename_discussion(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     new_title=new_title
... )
# DiscussionTitleChange(id='deadbeef0000000', type='title-change', ...)

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

repo_exists

< >

( repo_id: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si les informations du dépôt proviennent d’un dataset ou d’un space, None ou "model" si les informations du dépôt proviennent d’un model. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Vérifie si un dépôt existe sur le Hugging Face Hub.

Exemples :

>>> from huggingface_hub import repo_exists
>>> repo_exists("google/gemma-7b")
True
>>> repo_exists("google/not-a-repo")
False

repo_info

< >

( repo_id: strrevision: str | None = Nonerepo_type: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: ExpandModelProperty_T | ExpandDatasetProperty_T | ExpandSpaceProperty_T | None = Nonetoken: bool | str | None = None ) → Union[SpaceInfo, DatasetInfo, ModelInfo]

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • revision (str, facultatif) — La révision du dépôt à partir de laquelle obtenir les informations.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si les informations du dépôt proviennent d’un dataset ou d’un space, None ou "model" si les informations du dépôt proviennent d’un model. La valeur par défaut est None.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.
  • expand (ExpandModelProperty_T ou ExpandDatasetProperty_T ou ExpandSpaceProperty_T, facultatif) — Liste des propriétés à renvoyer dans la réponse. Lorsqu’il est utilisé, seules les propriétés de la liste seront renvoyées. Ce paramètre ne peut pas être utilisé si files_metadata est passé. Pour une liste exhaustive des propriétés disponibles, consultez model_info(), dataset_info() ou space_info().
  • files_metadata (bool, facultatif) — Indique s'il faut ou non récupérer les métadonnées des fichiers du dépôt (taille, métadonnées LFS, etc.). La valeur par défaut est False.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Union[SpaceInfo, DatasetInfo, ModelInfo]

Les informations du dépôt, sous forme d'objet huggingface_hub.hf_api.DatasetInfo, huggingface_hub.hf_api.ModelInfo ou huggingface_hub.hf_api.SpaceInfo.

Obtenez l'objet info pour un dépôt donné d'un type donné.

Lève les erreurs suivantes :

  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError Si la révision à télécharger n'est pas trouvée.

request_space_hardware

< >

( repo_id: strhardware: SpaceHardwaretoken: bool | str | None = Nonesleep_time: int | None = None ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID du dépôt à mettre à jour. Exemple : "bigcode/in-the-stack".
  • hardware (str ou SpaceHardware) — Matériel sur lequel exécuter le Space. Exemple : "t4-medium".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • sleep_time (int, facultatif) — Nombre de secondes d’inactivité à attendre avant qu’un Space ne passe en veille. Définissez la valeur sur -1 si vous ne souhaitez pas que votre Space passe en veille (comportement par défaut pour le matériel mis à niveau). Pour le matériel gratuit, vous ne pouvez pas configurer la durée de veille (la valeur est fixée à 48 heures d’inactivité). Voir https://huggingface.co/docs/hub/spaces-gpus#sleep-time pour plus de détails.

Retourne

SpaceRuntime

Informations d'exécution sur un Space, y compris l'étape du Space et le matériel.

Demander du nouveau matériel pour un Space.

Il est également possible de demander du matériel directement lors de la création du dépôt Space ! Consultez create_repo() pour plus de détails.

rerun_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Paramètres

  • job_id (str) — ID du Job à relancer.
  • namespace (str, facultatif) — Espace de noms du Job. Par défaut, l’espace de noms de l’utilisateur actuel.
  • token (bool ou str, facultatif) — Jeton d'accès utilisateur. Par défaut, le jeton enregistré localement est utilisé.

Retourne

JobInfo

Le Job nouvellement démarré.

Exécuter un nouveau Job en utilisant la spécification du Job existant, y compris ses paramètres de nouvelle tentative et de ressources.

resolve_revision

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_files_only: bool = Falsetoken: bool | str | None = None ) → ResolvedRevision

Paramètres

  • repo_id (str) — Le nom d’un utilisateur ou d’une organisation et le nom d’un dépôt, séparés par un /.
  • repo_type (str, facultatif) — À définir sur "dataset", "space" ou "kernel" si le dépôt est un dépôt de jeu de données, d’espace ou de noyau, None ou "model" s’il s’agit d’un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — La révision à résoudre. Peut être un nom de branche, un tag, une référence de PR ou un hachage de commit. Par défaut, la branche par défaut est utilisée. Si un ResolvedRevision est passé, il est renvoyé tel quel - sauf s'il a été résolu par rapport à un autre dépôt, auquel cas la révision initialement demandée est résolue à nouveau.
  • cache_dir (str, Path, facultatif) — Chemin du dossier où les fichiers en cache sont stockés. La valeur par défaut est celle de HF_HUB_CACHE.
  • local_files_only (bool, facultatif, par défaut False) — Si True, résout la révision uniquement depuis le cache local, sans contacter le Hub.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

ResolvedRevision

Sous-classe de str contenant à la fois la révision demandée et l'identifiant de commit auquel elle correspond.

Lève

RevisionResolutionError ou RevisionNotFoundError ou RepositoryNotFoundError

  • RevisionResolutionError — Si la révision ne peut pas être résolue : le Hub n’a pas pu être atteint et rien n’est mis en cache localement.
  • RevisionNotFoundError — Si la révision n'existe pas sur le Hub.
  • RepositoryNotFoundError — Si le dépôt ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

Résoudre une révision (branche, tag, référence de PR) en hachage de commit.

Cette fonctionnalité est destinée aux bibliothèques qui téléchargent et chargent séparément plusieurs composants d’un dépôt (config, weights, tokenizer, …). Résoudre la révision une seule fois et transmettre l’objet ResolvedRevision retourné garantit que chaque appel ultérieur cible exactement le même commit, même si le dépôt est mis à jour entre-temps. Cela permet également d’économiser des appels HTTP, car les téléchargements effectués avec un hash de commit peuvent être servis depuis le cache local sans contacter le Hub.

La correspondance revision -> commit hash est mise en cache sur le disque (dans le dossier refs/ du cache), sur une base de meilleur effort. Si le Hub ne peut pas être atteint ultérieurement (mode hors ligne, erreur de connexion, délai d’attente, indisponibilité du Hub, …), la valeur mise en cache est utilisée en secours.

Si vous avez seulement besoin de télécharger un instantané complet du dépôt, un seul appel à snapshot_download() suffit et fait déjà le bon travail. resolve_revision n’est utile que lors du téléchargement de fichiers séparément.

Exemple :

>>> from huggingface_hub import hf_hub_download, resolve_revision
>>> revision = resolve_revision("openai-community/gpt2")
>>> revision
ResolvedRevision(initial=None, resolved='607a30d783dfa663caf39e06633721c8d4cfcd7e')

# Pass it around: every download is pinned to the same commit
>>> config = hf_hub_download("openai-community/gpt2", "config.json", revision=revision)
>>> weights = hf_hub_download("openai-community/gpt2", "model.safetensors", revision=revision)

restart_space

< >

( repo_id: strtoken: bool | str | None = Nonefactory_reboot: bool = False ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID de l'Espace à redémarrer. Exemple : "Salesforce/BLIP2".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • factory_reboot (bool, facultatif) — Si True, l’espace est reconstruit de zéro sans mettre en cache les dépendances.

Retourne

SpaceRuntime

Informations d'exécution relatives à votre Space.

Lève

RepositoryNotFoundError ou HfHubHTTPError ou BadRequestError

  • RepositoryNotFoundError — Si votre Space n’est pas trouvé (erreur 404). La plupart du temps, le repo_id est incorrect ou votre Space est privé mais vous n’êtes pas authentifié.
  • HfHubHTTPError — 403 Forbidden : seul le propriétaire d’un Space peut le redémarrer. Si vous souhaitez redémarrer un Space qui ne vous appartient pas, demandez au propriétaire en ouvrant une Discussion ou dupliquez le Space.
  • BadRequestError — Si votre Space est un Space statique. Les Spaces statiques sont toujours en cours d’exécution et ne font jamais l’objet de facturation. Si vous souhaitez masquer un Space statique, vous pouvez le passer en privé.

Redémarrez votre Space.

C’est la seule façon de redémarrer un Space de manière programmatique si vous l’avez mis en pause (voir pause_space()). Vous devez être le propriétaire du Space pour le redémarrer. Si vous utilisez un matériel amélioré, votre compte sera facturé dès que le Space sera redémarré. Vous pouvez déclencher un redémarrage quel que soit l’état actuel du Space.

Pour plus de détails, veuillez consulter la documentation.

resume_inference_endpoint

< >

( name: strnamespace: str | None = Nonerunning_ok: bool = Truetoken: bool | str | None = None ) → InferenceEndpoint

Paramètres

  • name (str) — Le nom du point de terminaison d’inférence à reprendre.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve l'Inference Endpoint. Par défaut, il s'agit de l'utilisateur actuel.
  • running_ok (bool, facultatif) — Si True, la méthode ne lèvera pas d’erreur si le Inference Endpoint est déjà en cours d’exécution. La valeur par défaut est True.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

InferenceEndpoint

informations sur le point de terminaison d'inférence repris.

Reprendre un point de terminaison d’inférence.

Pour plus de commodité, vous pouvez également reprendre un Inference Endpoint à l'aide de InferenceEndpoint.resume().

resume_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • scheduled_job_id (str) — ID du Job planifié.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve le Job planifié. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Reprendre (dépauser) un Job de calcul planifié sur l’infrastructure Hugging Face.

revision_exists

< >

( repo_id: strrevision: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • revision (str) — La révision du dépôt à vérifier.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si les informations du dépôt proviennent d’un dataset ou d’un space, None ou "model" si les informations du dépôt proviennent d’un model. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Vérifie si une révision spécifique existe sur un dépôt du Hugging Face Hub.

Exemples :

>>> from huggingface_hub import revision_exists
>>> revision_exists("google/gemma-7b", "float16")
True
>>> revision_exists("google/gemma-7b", "not-a-revision")
False

run_as_future

< >

( fn: Callable[..., R]*args**kwargs ) → Future

Paramètres

  • fn (Callable) — La méthode à exécuter en arrière-plan.
  • *args, **kwargs — Arguments avec lesquels la méthode sera appelée.

Retourne

Future

une instance Future pour obtenir le résultat de la tâche.

Exécuter une méthode en arrière-plan et renvoyer une instance de Future.

L’objectif principal est d’exécuter des méthodes sans bloquer le thread principal (par exemple, pour envoyer des données pendant un entraînement). Les tâches en arrière-plan sont mises en file d’attente pour préserver l’ordre, mais ne sont pas exécutées en parallèle. Si vous avez besoin d’accélérer vos scripts en parallélisant de nombreux appels à l’API, vous devez configurer et utiliser votre propre ThreadPoolExecutor.

Note : Les méthodes les plus utilisées, comme upload_file(), upload_folder() et create_commit(), disposent d'un argument run_as_future: bool pour les appeler directement en arrière-plan. Cela équivaut à appeler api.run_as_future(...) sur elles, mais est moins verbeux.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> future = api.run_as_future(api.whoami) # instant
>>> future.done()
False
>>> future.result() # wait until complete and return result
(...)
>>> future.done()
True

run_job

< >

( image: strcommand: list[str]env: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonessh: bool = Falsenetwork_group: str | None = Nonenetwork_aliases: list[str] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • image (str) — L’image Docker à utiliser. Exemples : "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Exemple avec une image d’un Space : "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — La commande à exécuter. Exemple : ["echo", "hello"].
  • env (dict[str, Any], facultatif) — Définit les variables d’environnement pour le Job.
  • secrets (dict[str, Any], facultatif) — Définit les variables d’environnement secrètes pour le Job.
  • flavor (str, facultatif) — Flavor pour le matériel. Consultez JobHardware pour les valeurs possibles. Valeur par défaut : "cpu-basic".
  • timeout (Union[int, float, str], facultatif) — Durée maximale du Job : int avec s (secondes, par défaut), m (minutes), h (heures) ou d (jours). Exemple : 300 ou "5m" pour 5 minutes.
  • attempts (int, facultatif) — Nombre maximal de tentatives, y compris l’exécution initiale. Valeur par défaut : 1. Par exemple, 3 réessaie un Job en échec jusqu’à 2 fois.
  • name (str, facultatif) — Un nom pour le Job. Stocké en tant que libellé name. Ne peut pas être transmis conjointement avec une clé name dans labels. Les noms n’ont pas à être uniques. Par défaut, un nom est dérivé de l’image et de la commande (avec un suffixe de hachage court).
  • labels (dict[str, str], facultatif) — Étiquettes à associer au travail (paires clé-valeur).
  • volumes (list[Volume], facultatif) — Buckets ou dépôts Hugging Face à monter en tant que volumes dans le conteneur du job. Chaque volume est un Volume avec type ("bucket", "model", "dataset" ou "space"), source (par ex. "username/my-bucket") et mount_path (par ex. "/data").
  • expose (list[int], facultatif) — Ports de conteneur à exposer via le proxy des jobs. Chaque port listé est accessible sur le domaine public des jobs (par ex. https://<job_id>--8000.hf.jobs). L’accès nécessite toujours un jeton HF avec un accès en lecture à l’espace de noms du job. Utilisez expose_public pour un accès non authentifié.
  • expose_public (list[int], facultatif) — Ports à exposer via le proxy des Jobs sans authentification. Ils n’ont pas besoin d’être listés dans expose.
  • ssh (bool, facultatif) — Si True, le conteneur du job est accessible via SSH à l’URL donnée par job.status.ssh_url (par ex. ssh <job_id>@ssh.hf.jobs, ou hf jobs ssh <job_id> depuis la CLI). La connexion nécessite un accès en écriture à l’espace de noms du job et une clé publique SSH enregistrée sur le Hub (https://huggingface.co/settings/keys). Valeur par défaut : False.
  • network_group (str, facultatif) — Nom du groupe de réseau à rejoindre. Les jobs du même espace de noms et du même groupe de ressources partageant un groupe sont placés ensemble et peuvent se joindre sur chaque port. Au sein de chaque membre, HF_NETWORK_GROUP_HOSTNAME se résout vers chaque membre du groupe. Alphanumériques minuscules et tirets, 46 caractères maximum.
  • network_aliases (list[str], facultatif) — Alias que ce job revendique dans son groupe réseau. Les membres accèdent aux jobs revendiquant un alias à ${HF_NETWORK_GROUP_PREFIX}<alias>. Plusieurs jobs peuvent revendiquer le même alias. Alphanumériques minuscules et tirets, 34 caractères maximum, uniques au sein du job. Nécessite network_group.
  • resource_group_id (str, facultatif) — L’identifiant du groupe de ressources dans lequel créer le Job. Utilisé pour contrôler l’accès aux ressources au sein d’une organisation et pour les fonctionnalités d’attribution des coûts et de limites de dépenses. S’il n’est pas fourni, le Job est créé en dehors de tout groupe de ressources.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job sera créé. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Exécuter des jobs de calcul sur l'infrastructure Hugging Face.

Exemple :

Lancez votre premier Job :

>>> from huggingface_hub import run_job
>>> run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])

Lancer un travail sur GPU :

>>> from huggingface_hub import run_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> run_job(image=image, command=command, flavor="a10g-small")

Exécuter un Job avec des volumes :

>>> from huggingface_hub import Volume, run_job
>>> dataset_volume = Volume(type="dataset", source="HuggingFaceFW/fineweb", mount_path="/data")
>>> output_bucket_volume = Volume(type="bucket", source="username/my-bucket", mount_path="/output")
>>> image = "duckdb/duckdb"
>>> command = ["duckdb", "-c", "COPY (SELECT * FROM '/data/**/*.parquet' LIMIT 5) TO '/output/first-rows.parquet'"]
>>> run_job(image=image, command=command, volumes=[dataset_volume, output_bucket_volume])

run_uv_job

< >

( script: strscript_args: list[str] | None = Nonedependencies: list[str] | None = Nonepython: str | None = Noneimage: str | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonessh: bool = Falsenetwork_group: str | None = Nonenetwork_aliases: list[str] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • script (str) — Chemin ou URL du script UV, ou une commande.
  • script_args (list[str], facultatif) — Arguments à passer au script ou à la commande.
  • dependencies (list[str], facultatif) — Dépendances à utiliser pour exécuter le script UV.
  • python (str, facultatif) — Utiliser une version spécifique de Python. La valeur par défaut est 3.12.
  • image (str, facultatif, par défaut “ghcr.io/astral-sh/uv —python3.12-bookworm”) : Utiliser une image Docker personnalisée avec uv installé.
  • env (dict[str, Any], facultatif) — Définit les variables d’environnement pour le Job.
  • secrets (dict[str, Any], facultatif) — Définit les variables d’environnement secrètes pour le Job.
  • flavor (str, facultatif) — Flavor pour le matériel. Consultez JobHardware pour les valeurs possibles. Valeur par défaut : "cpu-basic".
  • timeout (Union[int, float, str], facultatif) — Durée maximale du Job : int avec s (secondes, par défaut), m (minutes), h (heures) ou d (jours). Exemple : 300 ou "5m" pour 5 minutes.
  • attempts (int, facultatif) — Nombre maximal de tentatives, y compris l’exécution initiale. Valeur par défaut : 1.
  • name (str, facultatif) — Un nom pour le Job. Stocké en tant que libellé name. Ne peut pas être transmis conjointement avec une clé name dans labels. Les noms n’ont pas à être uniques. Par défaut, un nom est dérivé du script et de ses arguments (avec un suffixe de hachage court).
  • labels (dict[str, str], facultatif) — Étiquettes à associer au travail (paires clé-valeur).
  • volumes (list[Volume], facultatif) — Buckets ou dépôts Hugging Face à monter en tant que volumes dans le conteneur du job. Chaque volume est un Volume avec type ("bucket", "model", "dataset" ou "space"), source (par ex. "username/my-bucket") et mount_path (par ex. "/data").
  • expose (list[int], facultatif) — Ports de conteneur à exposer via le proxy des jobs. Chaque port listé est accessible sur le domaine public des jobs (par ex. https://<job_id>--8000.hf.jobs). L’accès nécessite toujours un jeton HF avec un accès en lecture à l’espace de noms du job. Utilisez expose_public pour un accès non authentifié.
  • expose_public (list[int], facultatif) — Ports à exposer via le proxy des Jobs sans authentification. Ils n’ont pas besoin d’être listés dans expose.
  • ssh (bool, facultatif) — Si True, le conteneur du job est accessible via SSH à l’URL donnée par job.status.ssh_url (par ex. ssh <job_id>@ssh.hf.jobs, ou hf jobs ssh <job_id> depuis la CLI). La connexion nécessite un accès en écriture à l’espace de noms du job et une clé publique SSH enregistrée sur le Hub (https://huggingface.co/settings/keys). Valeur par défaut : False.
  • network_group (str, facultatif) — Nom du groupe de réseau à rejoindre. Les jobs du même espace de noms et du même groupe de ressources partageant un groupe sont placés ensemble et peuvent se joindre sur chaque port. Au sein de chaque membre, HF_NETWORK_GROUP_HOSTNAME se résout vers chaque membre du groupe. Alphanumériques minuscules et tirets, 46 caractères maximum.
  • network_aliases (list[str], facultatif) — Alias que ce job revendique dans son groupe réseau. Les membres accèdent aux jobs revendiquant un alias à ${HF_NETWORK_GROUP_PREFIX}<alias>. Plusieurs jobs peuvent revendiquer le même alias. Alphanumériques minuscules et tirets, 34 caractères maximum, uniques au sein du job. Nécessite network_group.
  • resource_group_id (str, facultatif) — L’identifiant du groupe de ressources dans lequel créer le Job. Utilisé pour contrôler l’accès aux ressources au sein d’une organisation et pour les fonctionnalités d’attribution des coûts et de limites de dépenses. S’il n’est pas fourni, le Job est créé en dehors de tout groupe de ressources.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job sera créé. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Exécuter un Job de script UV sur l’infrastructure Hugging Face.

Contrairement à hf jobs uv run, cette méthode ignore la table optionnelle [tool.hf-jobs] qu'un script UV peut contenir dans son en-tête PEP 723 (voir le guide des Jobs) : la configuration de lancement doit être transmise explicitement ici.

Exemple :

Exécuter un script depuis une URL :

>>> from huggingface_hub import run_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small")

Exécuter un script local :

>>> from huggingface_hub import run_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small")

Exécuter une commande :

>>> from huggingface_hub import run_uv_job
>>> script = "lighteval"
>>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"]
>>> run_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small")

Monter des volumes, par exemple pour enregistrer les points de contrôle du modèle pendant l’entraînement :

>>> from huggingface_hub import Volume, run_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--output_dir", "/training-outputs/training-v3-final", ...]
>>> checkpoints_bucket = Volume(type="bucket", source="username/my-bucket", mount_path="/training-outputs")
>>> run_uv_job(script, script_args=script_args, volumes=[checkpoints_bucket])

scale_to_zero_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Paramètres

  • name (str) — Le nom du point de terminaison d’inférence à mettre à l’échelle zéro.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve l'Inference Endpoint. Par défaut, il s'agit de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

InferenceEndpoint

informations sur le point de terminaison d'inférence mis à l'échelle zéro.

Mettre à l’échelle le point de terminaison d’inférence à zéro.

Un Inference Endpoint mis à l'échelle zéro ne sera pas facturé. Il reprendra au prochain envoi de requête, avec un délai de démarrage à froid. Cela diffère de la mise en pause de l'Inference Endpoint via pause_inference_endpoint(), qui nécessiterait une reprise manuelle via resume_inference_endpoint().

Pour plus de commodité, vous pouvez également mettre à l'échelle un Inference Endpoint à zéro à l'aide de InferenceEndpoint.scale_to_zero().

search_spaces

< >

( query: strfilter: str | Iterable[str] | None = Nonesdk: str | list[str] | None = Noneinclude_non_running: bool = Falsetoken: bool | str | None = None ) → Iterable[SpaceSearchResult]

Paramètres

  • query (str) — La chaîne de requête de recherche.
  • filter (str ou Iterable[str], facultatif) — Une étiquette sous forme de chaîne de caractères ou une liste d'étiquettes pour effectuer le filtrage.
  • sdk (str ou list[str], facultatif) — Filtrer par SDK (par ex. "gradio", "docker", "static").
  • include_non_running (bool, facultatif) — Indique s'il faut inclure les Spaces non actifs dans les résultats. La valeur par défaut est False.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

Iterable[SpaceSearchResult]

un itérable d'objets SpaceSearchResult.

Rechercher des espaces sur le Hub à l'aide de la recherche sémantique.

Cet endpoint utilise la recherche sémantique (basée sur les embeddings) pour les requêtes multi-mots et la recherche plein texte pour les requêtes à un seul mot.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> results = list(api.search_spaces("generate image"))
>>> results[0].id
'mrfakename/Z-Image-Turbo'
>>> results[0].ai_category
'Image Generation'

set_space_sleep_time

< >

( repo_id: strsleep_time: inttoken: bool | str | None = None ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID du dépôt à mettre à jour. Exemple : "bigcode/in-the-stack".
  • sleep_time (int, facultatif) — Nombre de secondes d’inactivité à attendre avant qu’un Space ne passe en veille. Définissez la valeur sur -1 si vous ne souhaitez pas que votre Space soit mis en pause (comportement par défaut pour le matériel mis à niveau). Pour le matériel gratuit, vous ne pouvez pas configurer la durée de veille (la valeur est fixée à 48 heures d’inactivité). Voir https://huggingface.co/docs/hub/spaces-gpus#sleep-time pour plus de détails.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

SpaceRuntime

Informations d'exécution sur un Space, y compris l'étape du Space et le matériel.

Définir une durée de veille personnalisée pour un Space exécuté sur du matériel mis à niveau.

Votre Space passera en veille après X secondes d'inactivité. Vous n'êtes pas facturé lorsque votre Space est en mode « sleep ». Si un nouveau visiteur accède à votre Space, il le « réveillera ». Seuls les matériels améliorés permettent de configurer la durée de veille. Pour en savoir plus sur la phase de veille, veuillez consulter https://huggingface.co/docs/hub/spaces-gpus#sleep-time.

Il est également possible de définir un temps de veille personnalisé lors de la demande de matériel avec request_space_hardware().

set_space_volumes

< >

( repo_id: strvolumes: list[Volume]token: bool | str | None = None )

Paramètres

  • repo_id (str) — ID de l'Espace à mettre à jour. Exemple : "username/my-space".
  • volumes (list[Volume]) — Liste d’objets Volume à monter. Chaque volume possède un type ("bucket", "model", "dataset" ou "space"), une source (identifiant du dépôt ou du bucket), un mount_path (chemin à l’intérieur du conteneur) et des champs facultatifs revision, read_only et path.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

BadRequestError

  • BadRequestError — Si le Space est un Space statique (les volumes ne sont pas pris en charge sur les Spaces statiques).

Définir les volumes pour un Space.

Définit (ou remplace) la liste des volumes montés dans le Space. Chaque volume donne au conteneur du Space un accès à une ressource du Hub (modèle, jeu de données ou bucket de stockage).

Exemple :

>>> from huggingface_hub import HfApi, Volume
>>> api = HfApi()
>>> api.set_space_volumes(
...     "username/my-space",
...     volumes=[
...         Volume(type="model", source="username/my-model", mount_path="/models", read_only=True),
...         Volume(type="bucket", source="username/my-bucket", mount_path="/data"),
...     ],
... )

snapshot_download

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_dir: str | Path | None = Noneetag_timeout: float = 10force_download: bool = Falsetoken: bool | str | None = Nonelocal_files_only: bool = Falseallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonemax_workers: int = 8tqdm_class: type[base_tqdm] | None = Nonedry_run: bool = False ) → str or list of DryRunFileInfo

Paramètres

  • repo_id (str) — Le nom d’un utilisateur ou d’une organisation et le nom d’un dépôt, séparés par un /.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" si le téléchargement provient d’un dataset ou d’un space, None ou "model" si le téléchargement provient d’un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — Identifiant de révision Git facultatif, qui peut être un nom de branche, un tag ou un hash de commit.
  • cache_dir (str, Path, facultatif) — Chemin vers le dossier où les fichiers en cache sont stockés.
  • local_dir (str ou Path, facultatif) — Si fourni, les fichiers téléchargés seront placés sous ce répertoire.
  • etag_timeout (float, facultatif, par défaut 10) — Lors de la récupération de l'ETag, nombre de secondes à attendre que le serveur envoie des données avant d'abandonner, valeur transmise à httpx2.request.
  • force_download (bool, facultatif, valeur par défaut False) — Indique si le fichier doit être téléchargé même s'il existe déjà dans le cache local.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • local_files_only (bool, facultatif, valeur par défaut False) — Si True, évite de télécharger le fichier et renvoie le chemin du fichier en cache local s'il existe.
  • allow_patterns (list[str] ou str, facultatif) — Si fourni, seuls les fichiers correspondant à au moins un motif sont téléchargés.
  • ignore_patterns (list[str] ou str, facultatif) — Si fourni, les fichiers correspondant à l’un des motifs ne sont pas téléchargés.
  • max_workers (int, facultatif) — Nombre de threads concurrents pour télécharger les fichiers (1 thread = 1 téléchargement de fichier). Valeur par défaut : 8.
  • tqdm_class (tqdm, facultatif) — Si fourni, remplace le comportement par défaut de la barre de progression. L’argument transmis doit hériter de tqdm.auto.tqdm ou au moins imiter son comportement. Notez que tqdm_class n’est pas transmis à chaque téléchargement individuel. Par défaut, la barre de progression personnalisée de HF est utilisée, et peut être désactivée en définissant la variable d’environnement HF_HUB_DISABLE_PROGRESS_BARS.
  • dry_run (bool, facultatif, par défaut False) — Si True, effectue une simulation sans réellement télécharger les fichiers. Renvoie une liste d'objets DryRunFileInfo contenant des informations sur ce qui serait téléchargé.

Retourne

str ou liste de DryRunFileInfo

  • Si dry_run=False : chemin du dossier de l'instantané du dépôt.
  • Si dry_run=True : une liste d'objets DryRunFileInfo contenant les informations de téléchargement.

Lève

RepositoryNotFoundError ou RevisionNotFoundError ou EnvironmentError ou OSError ou ValueError

  • RepositoryNotFoundError — Si le dépôt à partir duquel le téléchargement doit être effectué n’est pas trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError — Si la révision à télécharger n'est pas trouvée.
  • EnvironmentError — Si token=True et que le jeton ne peut pas être trouvé.
  • OSError — si l'ETag ne peut pas être déterminé.
  • ValueError — si la valeur d'un paramètre est invalide.

Télécharger les fichiers du dépôt.

Téléchargez un instantané complet des fichiers d’un dépôt à la révision spécifiée. C’est utile lorsque vous souhaitez tous les fichiers d’un dépôt, car vous ne savez pas a priori lesquels vous seront nécessaires. Tous les fichiers sont imbriqués dans un dossier afin de conserver leur nom de fichier réel par rapport à ce dossier. Vous pouvez également filtrer les fichiers à télécharger à l’aide de allow_patterns et ignore_patterns.

Si local_dir est fourni, la structure de fichiers du dépôt sera répliquée à cet emplacement. Lors de l’utilisation de cette option, le cache_dir ne sera pas utilisé et un dossier .cache/huggingface/ sera créé à la racine de local_dir pour stocker certaines métadonnées liées aux fichiers téléchargés. Bien que ce mécanisme ne soit pas aussi robuste que le système de cache principal, il est optimisé pour récupérer régulièrement la dernière version d’un dépôt.

Une alternative consisterait à cloner le dépôt, mais cela nécessite que git et git-lfs soient installés et correctement configurés. Il est également impossible de filtrer les fichiers à télécharger lors du clonage d'un dépôt à l'aide de git.

space_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandSpaceProperty_T] | None = Nonetoken: bool | str | None = None ) → SpaceInfo

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • revision (str, facultatif) — La révision du dépôt de l’espace à partir duquel obtenir les informations.
  • timeout (float, facultatif) — Indique s'il faut définir un délai d'attente pour la requête vers le Hub.
  • files_metadata (bool, facultatif) — Indique s'il faut ou non récupérer les métadonnées des fichiers du dépôt (taille, métadonnées LFS, etc.). La valeur par défaut est False.
  • expand (list[ExpandSpaceProperty_T], facultatif) — Liste des propriétés à renvoyer dans la réponse. Lorsqu’il est utilisé, seules les propriétés de la liste seront renvoyées. Ce paramètre ne peut pas être utilisé si full est passé. Les valeurs possibles sont "author", "cardData", "createdAt", "datasets", "disabled", "lastModified", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage" et "resourceGroup".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

SpaceInfo

Les informations du dépôt Space.

Obtenir des informations sur un Space spécifique sur huggingface.co.

Un espace peut être privé si vous passez un jeton acceptable.

Lève les erreurs suivantes :

  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError Si la révision à télécharger n'est pas trouvée.

super_squash_history

< >

( repo_id: strbranch: str | None = Nonecommit_message: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • branch (str, facultatif) — La branche à écraser. Par défaut, la tête de la branche "main".
  • commit_message (str, facultatif) — Le message de commit à utiliser pour le commit aplati.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" pour lister les commits d’un dataset ou d’un Space, None ou "model" pour list depuis un modèle. La valeur par défaut est None.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

RepositoryNotFoundError ou RevisionNotFoundError ou BadRequestError

  • RepositoryNotFoundError — Si le dépôt n'est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • RevisionNotFoundError — Si la branche à fusionner ne peut pas être trouvée.
  • BadRequestError — Si la référence pour une branche est invalide. Vous ne pouvez pas écraser l’historique sur des tags.

Écraser l’historique des commits d’une branche pour un dépôt sur le Hub.

Écraser l’historique du dépôt est utile lorsque vous savez que vous allez effectuer des centaines de commits et que vous ne souhaitez pas encombrer l’historique. L’écrasement de commits ne peut être effectué que depuis la tête d’une branche.

Une fois les commits fusionnés, l’historique des commits ne peut plus être récupéré. Il s’agit d’une opération irréversible.

Une fois l’historique d’une branche aplatit, il n’est plus possible de la fusionner dans une autre branche, car leurs historiques ont divergé.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Create repo
>>> repo_id = api.create_repo("test-squash").repo_id

# Make a lot of commits.
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="lfs.bin", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"another_content")

# Squash history
>>> api.super_squash_history(repo_id=repo_id)

suspend_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • scheduled_job_id (str) — ID du Job planifié.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve le Job planifié. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Suspendre (mettre en pause) un Job de calcul planifié sur l’infrastructure Hugging Face.

sync_bucket

< >

( source: str | None = Nonedest: str | None = Nonedelete: bool = Falseignore_times: bool = Falseignore_sizes: bool = Falseexisting: bool = Falseignore_existing: bool = Falseinclude: list[str] | None = Noneexclude: list[str] | None = Nonefilter_from: str | None = Noneplan: str | None = Noneapply: str | None = Nonedry_run: bool = Falseverbose: bool = Falsequiet: bool = Falsetoken: bool | str | None = None ) → [SyncPlan]

Paramètres

  • source (str, facultatif) — Chemin d’origine : répertoire local ou hf://buckets/namespace/bucket_name(/prefix). Obligatoire sauf si vous utilisez apply.
  • dest (str, optional) — Destination path: local directory or hf://buckets/namespace/bucket_name(/prefix). Required unless using apply.
  • delete (bool, facultatif, par défaut False) — Supprime les fichiers de destination qui ne sont pas présents dans la source.
  • ignore_times (bool, facultatif, par défaut False) — Ignorer les fichiers uniquement en fonction de leur taille, en ignorant les dates de modification.
  • ignore_sizes (bool, facultatif, valeur par défaut False) — Ignorer les fichiers uniquement sur la base des heures de modification, en ignorant les tailles.
  • existing (bool, facultatif, par défaut False) — Ignorer la création de nouveaux fichiers sur le récepteur (ne mettre à jour que les fichiers existants).
  • ignore_existing (bool, facultatif, valeur par défaut False) — Ignorer la mise à jour des fichiers existants sur le récepteur (ne créer que de nouveaux fichiers).
  • include (list[str], facultatif) — Inclure les fichiers correspondant aux motifs (style fnmatch).
  • exclude (list[str], facultatif) — Exclure les fichiers correspondant aux motifs (style fnmatch).
  • filter_from (str, facultatif) — Chemin vers un fichier de filtre contenant des règles d'inclusion/exclusion.
  • plan (str, facultatif) — Enregistre le plan de synchronisation dans ce fichier JSONL au lieu de l'exécuter.
  • apply (str, optional) — Applique un fichier de plan précédemment enregistré. Si défini, source et dest ne sont pas nécessaires.
  • dry_run (bool, facultatif, par défaut False) — Affiche le plan de synchronisation sur la sortie standard au format JSONL sans l'exécuter.
  • verbose (bool, facultatif, par défaut False) — Affiche les opérations détaillées pour chaque fichier.
  • quiet (bool, facultatif, par défaut False) — Supprime toutes les sorties et les barres de progression.
  • token (Union[bool, str, None], optionnel) — Un jeton d'accès utilisateur valide. S'il n'est pas fourni, le jeton enregistré localement sera utilisé.

Retourne

[SyncPlan]

Le plan de synchronisation calculé (ou chargé).

Synchroniser les fichiers entre un répertoire local et un bucket.

Cela équivaut à la commande CLI hf buckets sync. L'un des paramètres source ou dest doit être un chemin de bucket (hf://buckets/...) et l'autre doit être un chemin de répertoire local.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Upload local directory to bucket
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket")

# Download bucket to local directory
>>> api.sync_bucket("hf://buckets/username/my-bucket", "./data")

# Sync with delete and filtering
>>> api.sync_bucket(
...     "./data",
...     "hf://buckets/username/my-bucket",
...     delete=True,
...     include=["*.safetensors"],
... )

# Dry run: preview what would be synced
>>> plan = api.sync_bucket("./data", "hf://buckets/username/my-bucket", dry_run=True)
>>> plan.summary()
{'uploads': 3, 'downloads': 0, 'deletes': 0, 'skips': 1, 'total_size': 4096}

# Save plan for review, then apply
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket", plan="sync-plan.jsonl")
>>> api.sync_bucket(apply="sync-plan.jsonl")

sync_job_volume

< >

( source: str | Pathmount_path: strremote_name: str | None = Noneread_only: bool = Truenamespace: str | None = Nonetoken: bool | str | None = None ) → Volume

Paramètres

  • source (str ou Path) — Chemin vers un répertoire local à synchroniser.
  • mount_path (str) — Chemin de montage à l’intérieur du conteneur du Job, par exemple "/inputs". Doit commencer par /.
  • remote_name (str, facultatif) — Nom du sous-dossier du bucket vers lequel synchroniser. Par défaut, un nom {dirname}-{hash} est dérivé du chemin source et du nom d’hôte de la machine.
  • read_only (bool, facultatif, valeur par défaut True) — Monte le volume en lecture seule dans le Job. Passez False pour permettre au Job d'écrire dans le dossier du bucket (par exemple pour récupérer les sorties avec sync_bucket() par la suite).
  • namespace (str, facultatif) — L’espace de noms propriétaire du bucket jobs-artifacts. Par défaut, l’espace de noms de l’utilisateur actuel est utilisé. Utilisez le même espace de noms que le Job qui montera le volume.
  • token (Union[bool, str, None], facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

Volume

Un volume de bucket limité à la sous-dossier synchronisé, à passer dans la liste volumes de run_job(), run_uv_job(), create_scheduled_job() ou create_scheduled_uv_job().

Synchroniser un répertoire local avec un bucket et retourner un Volume prêt à être monté dans un Job.

Les fichiers sont téléversés dans un sous-dossier du bucket {namespace}/jobs-artifacts (créé automatiquement en privé ; un avertissement est émis s’il existe déjà et est public) en utilisant la même logique de synchronisation que sync_bucket() : la resynchronisation du même répertoire ne téléverse que les nouveaux fichiers ou les fichiers modifiés. Par défaut, le nom du sous-dossier est dérivé du chemin du répertoire et du nom d’hôte de la machine, de sorte que les appels répétés depuis le même répertoire réutilisent le même dossier distant. Passez remote_name pour utiliser un nom fixe à la place.

Notez que les données sont copiées vers le bucket, et non montées en direct : les modifications effectuées localement après la synchronisation ne sont pas visibles par le Job (relancez sync_job_volume pour mettre à jour), et le volume est monté en lecture seule par défaut. Pour récupérer les données écrites par un Job sur un volume en lecture-écriture, synchronisez le dossier du bucket avec sync_bucket(). Si le répertoire source est vide (par exemple, un répertoire de sortie), un fichier .keep est téléversé afin que le volume puisse tout de même être monté.

Exemple :

>>> from huggingface_hub import run_uv_job, sync_job_volume

# Upload ./training-data once, then run multiple jobs against it
>>> volume = sync_job_volume("./training-data", "/data")
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.01"], volumes=[volume])
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.05"], volumes=[volume])

# Read-write volume to retrieve outputs after the job completes
>>> volume = sync_job_volume("./outputs", "/outputs", read_only=False)
>>> job = run_uv_job("process.py", volumes=[volume])

trigger_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Paramètres

  • scheduled_job_id (str) — ID du Job planifié.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve le Job planifié. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

JobInfo

Informations sur l'exécution déclenchée.

Lève

HfHubHTTPError

  • HfHubHTTPError — HTTP 409 si une autre instance est déjà en cours d’exécution et que concurrency est désactivé sur le planifié.

Déclencher l'exécution immédiate d'un Job planifié.

Cela déclenche une exécution immédiate de la spécification du planifié. Il ne modifie pas le planning et n’a pas d’effet sur la prochaine exécution planifiée. Si une instance est déjà en cours d’exécution et que le planifié n’autorise pas les exécutions concurrentes, la requête est rejetée (HTTP 409).

contrairement à

< >

( repo_id: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Paramètres

  • repo_id (str) — Le dépôt à désaimer. Exemple : "user/my-cool-model".
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset" ou "space" pour retirer le like d’un jeu de données ou d’un espace, None ou "model" pour retirer le like d’un modèle. La valeur par défaut est None.

Lève

RepositoryNotFoundError

  • RepositoryNotFoundError — Si le dépôt n’est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.

Contrairement à un dépôt donné sur le Hub (par exemple, retirer de la liste des favoris).

Pour empêcher l'utilisation abusive, il n'est pas possible de like un dépôt depuis un script.

Voir aussi list_liked_repos().

Exemple :

>>> from huggingface_hub import list_liked_repos, unlike
>>> "gpt2" in list_liked_repos().models # we assume you have already liked gpt2
True
>>> unlike("gpt2")
>>> "gpt2" in list_liked_repos().models
False

update_bucket_settings

< >

( bucket_id: strprivate: booltoken: bool | str | None = None )

Paramètres

  • bucket_id (str) — L'identifiant du bucket (par exemple "username/my-bucket").
  • private (bool) — Indique s'il faut rendre le bucket privé.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Lève

BucketNotFoundError ou or

  • BucketNotFoundError — Si le bucket ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas,
  • or — car il est défini sur private et que vous n’y avez pas accès.

Mettre à jour les paramètres d’un bucket sur le Hub.

Actuellement, le seul paramètre pris en charge est la visibilité du bucket.

Exemple :

>>> from huggingface_hub import update_bucket_settings

>>> # Make a bucket public
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=False)

>>> # Make it private again
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=True)

update_collection_item

< >

( collection_slug: stritem_object_id: strnote: str | None = Noneposition: int | None = Nonetoken: bool | str | None = None )

Paramètres

  • collection_slug (str) — Slug de la collection à mettre à jour. Exemple : "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — ID de l'élément dans la collection. Il ne s'agit pas de l'ID de l'élément sur le Hub (repo_id ou paper id). Il doit être récupéré depuis un objet CollectionItem. Exemple : collection.items[0].item_object_id.
  • note (str, facultatif) — Une note à joindre à l'élément de la collection. La taille maximale d'une note est de 500 caractères.
  • position (int, facultatif) — Nouvelle position de l'élément dans la collection.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Mettre à jour un élément dans une collection.

Exemple :

>>> from huggingface_hub import get_collection, update_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Update item based on its ID (add note + update position)
>>> update_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
...     note="Newly updated model!",
...     position=0,
... )

update_collection_metadata

< >

( collection_slug: strtitle: str | None = Nonedescription: str | None = Noneposition: int | None = Noneprivate: bool | None = Nonetheme: str | None = Nonetoken: bool | str | None = None )

Paramètres

  • collection_slug (str) — Slug de la collection à mettre à jour. Exemple : "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • title (str) — Titre de la collection à mettre à jour.
  • description (str, facultatif) — Description de la collection à mettre à jour. La taille maximale d'une description est de 150 caractères.
  • position (int, facultatif) — Nouvelle position de la collection dans la liste des collections de l'utilisateur.
  • private (bool, facultatif) — Indique si la collection doit être privée ou non.
  • theme (str, facultatif) — Thème de la collection sur le Hub.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Mettre à jour les métadonnées d'une collection sur le Hub.

Tous les arguments sont facultatifs. Seules les métadonnées fournies seront mises à jour.

Retourne : Collection

Exemple :

>>> from huggingface_hub import update_collection_metadata
>>> collection = update_collection_metadata(
...     collection_slug="username/iccv-2023-64f9a55bb3115b4f513ec026",
...     title="ICCV Oct. 2023",
...     description="Portfolio of models, datasets, papers and demos I presented at ICCV Oct. 2023",
...     private=False,
...     theme="pink",
... )
>>> collection.slug
"username/iccv-oct-2023-64f9a55bb3115b4f513ec026"
# ^collection slug got updated but not the trailing ID

update_collection_resource_group

< >

( collection_slug: strresource_group_id: str | Nonetoken: bool | str | None = None )

Paramètres

  • collection_slug (str) — Slug de la collection à mettre à jour. Exemple : "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • resource_group_id (str ou None) — Le groupe de ressources auquel affecter la collection, sous forme de chaîne hexadécimale de 24 caractères. Si None, la collection est retirée de tout groupe de ressources.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Affectez une collection à un groupe de ressources, ou retirez-la de tout groupe de ressources.

Valable uniquement pour les collections appartenant à une organisation.

Exemple :

>>> from huggingface_hub import update_collection_resource_group
>>> update_collection_resource_group(
...     collection_slug="my-org/iccv-2023-64f9a55bb3115b4f513ec026",
...     resource_group_id="66980ecfc1e12a49c8f0e42d",
... )

update_inference_endpoint

< >

( name: straccelerator: str | None = Noneinstance_size: str | None = Noneinstance_type: str | None = Nonemin_replica: int | None = Nonemax_replica: int | None = Nonescale_to_zero_timeout: int | None = Nonescaling_metric: InferenceEndpointScalingMetric | None = Nonescaling_threshold: float | None = Nonerepository: str | None = Noneframework: str | None = Nonerevision: str | None = Nonetask: str | None = Nonecustom_image: dict | None = Nonecontainer_command: list[str] | None = Nonecontainer_args: list[str] | None = Nonetensor_parallel_size: int | None = Nonedata_parallel_size: int | None = Noneenv: dict[str, str] | None = Nonesecrets: dict[str, str] | None = Nonedomain: str | None = Nonepath: str | None = Nonecache_http_responses: bool | None = Nonetags: list[str] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Paramètres

  • name (str) — Le nom du point de terminaison d’inférence à mettre à jour.
  • accelerator (str, facultatif) — L'accélérateur matériel à utiliser pour l'inférence (par ex. "cpu").
  • instance_size (str, facultatif) — La taille ou le type d’instance à utiliser pour l’hébergement du modèle (par ex. "x4").
  • instance_type (str, facultatif) — Le type d’instance cloud sur lequel l’Inference Endpoint sera déployé (par ex. "intel-icl").
  • min_replica (int, facultatif) — Le nombre minimal de répliques (instances) à maintenir en cours d’exécution pour l’Inference Endpoint.
  • max_replica (int, facultatif) — Le nombre maximal de répliques (instances) vers lequel mettre à l’échelle l’Inference Endpoint.
  • scale_to_zero_timeout (int, facultatif) — Durée, en minutes, avant qu'un point de terminaison inactif ne soit mis à l'échelle zéro.
  • scaling_metric (str ou InferenceEndpointScalingMetric , facultatif) — La référence de la métrique de mise à l’échelle. Soit « pendingRequests », soit « hardwareUsage » lorsqu’elle est fournie. Valeur par défaut : None.
  • scaling_threshold (float, facultatif) — Seuil de la métrique de mise à l'échelle utilisé pour déclencher une augmentation. Ignoré si la métrique de mise à l'échelle n'est pas fournie. Valeur par défaut : None.
  • repository (str, facultatif) — Le nom du dépôt de modèle associé à l'Inference Endpoint (par exemple "gpt2").
  • framework (str, facultatif) — Le framework d’apprentissage automatique utilisé pour le modèle (par exemple "custom").
  • revision (str, facultatif) — La révision spécifique du modèle à déployer sur l’Inference Endpoint (par exemple "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, facultatif) — La tâche sur laquelle déployer le modèle (par ex. "text-classification").
  • custom_image (dict, facultatif) — L’image conteneur à exécuter. Soit un dictionnaire indexé par variante d’image (par ex. {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, également sGLang, tgi, tei, llamacpp, hfServe, …), qui est transmis tel quel, soit un dictionnaire plat décrivant un conteneur personnalisé (par ex. {"url": ..., "port": ...}), qui est envoyé sous la forme {"custom": ...}.
  • container_command (list[str], facultatif) — Remplace la commande d’entrée du conteneur (correspond à model.command dans la charge utile de l’API). Fonctionne avec les images d’ingénierie gérées (par exemple vLLM, SGLang) et les images personnalisées.
  • container_args (list[str], facultatif) — Arguments ajoutés à l’entrypoint du conteneur (correspond à model.args dans la charge utile de l’API). Fonctionne avec les images d’engine gérées (par exemple vLLM, SGLang) et les images personnalisées.
  • tensor_parallel_size (int, facultatif) — Nombre d'accélérateurs sur lesquels répartir une copie unique du modèle (images vLLM et SGLang). Écrit dans la configuration de l'image moteur. L'API exige model.image dans son ensemble, donc lorsque custom_image n'est pas fourni, l'image actuellement configurée sur le point de terminaison est récupérée et mise à jour sur place.
  • data_parallel_size (int, facultatif) — Nombre de copies du modèle à exécuter, une par accélérateur (images vLLM). Même traitement que tensor_parallel_size.
  • env (dict[str, str], facultatif) — Variables d'environnement non confidentielles à injecter dans l'environnement du conteneur
  • secrets (dict[str, str], facultatif) — Valeurs secrètes à injecter dans l'environnement du conteneur.
  • domain (str, facultatif) — Le domaine personnalisé pour le déploiement de l'Inference Endpoint. S'il est configuré, l'Inference Endpoint sera accessible à ce domaine (par exemple "my-new-domain.cool-website.woof").
  • path (str, facultatif) — Le chemin personnalisé vers le modèle déployé, doit commencer par / (par ex. "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, facultatif) — Indique s'il faut mettre en cache les réponses HTTP de l'Inference Endpoint.
  • tags (list[str], facultatif) — Une liste de tags à associer à l'Inference Endpoint.
  • namespace (str, facultatif) — L’espace de noms dans lequel le point de terminaison d’inférence sera mis à jour. Par défaut, l’espace de noms de l’utilisateur actuel est utilisé.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

InferenceEndpoint

informations sur le point d'inférence mis à jour.

Mettre à jour un point de terminaison d’inférence.

Cette méthode permet de mettre à jour la configuration de calcul, le modèle déployé, la route, ou toute combinaison de ces éléments. Tous les arguments sont facultatifs, mais au moins un doit être fourni.

Pour plus de commodité, vous pouvez également mettre à jour un Inference Endpoint à l'aide de InferenceEndpoint.update().

update_job_expose

< >

( job_id: strexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Paramètres

  • job_id (str) — ID du Job en cours d’exécution.
  • expose (list[int], facultatif) — Ports à exposer via le proxy des Jobs. L’accès nécessite un jeton HF avec un accès en lecture à l’espace de noms du Job.
  • expose_public (list[int], facultatif) — Ports à exposer via le proxy des Jobs sans authentification. Ils n’ont pas besoin d’être listés dans expose.
  • namespace (str, facultatif) — Espace de noms du Job. Par défaut, l’espace de noms de l’utilisateur actuel.
  • token (bool ou str, facultatif) — Jeton d'accès utilisateur. Par défaut, le jeton enregistré localement est utilisé.

Retourne

JobInfo

Le Job mis à jour.

Remplacez les ports exposés d’un Job en cours d’exécution sans le relancer.

expose et expose_public forment ensemble la configuration complète des ports : les ports qui ne figurent dans aucune des deux listes sont fermés. Ne passez aucun des deux pour fermer tous les ports exposés.

update_job_labels

< >

( job_id: strlabels: dict[str, str]namespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Paramètres

  • job_id (str) — ID du Job.
  • labels (dict[str, str]) — Nouvelles étiquettes à définir sur le travail. Remplace toutes les étiquettes existantes. Les clés et les valeurs doivent contenir au maximum 100 caractères et ne comporter que des caractères alphanumériques, des tirets et des tirets bas.
  • namespace (str, facultatif) — L'espace de noms dans lequel le Job est exécuté. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

JobInfo

Les informations de Job mises à jour.

Mettre à jour les étiquettes d'un Job existant.

Remplace tous les étiquettes fournies par l'utilisateur par les nouvelles étiquettes.

update_repo_settings

< >

( repo_id: strgated: Literal['auto', 'manual', False] | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = None )

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • gated (Literal["auto", "manual", False], facultatif) — Le statut de contrôle d'accès du dépôt. Si défini sur None (par défaut, le paramètre gated du dépôt ne sera pas mis à jour.
    • « auto » : le dépôt est protégé et les demandes d'accès sont approuvées ou refusées automatiquement en fonction de critères prédéfinis.
    • “manual” : le dépôt est protégé et les demandes d’accès nécessitent une approbation manuelle.
    • False : le dépôt n'est pas protégé et tout le monde peut y accéder.
  • private (bool, facultatif) — Indique si le dépôt doit être privé. Ne peut pas être transmis en même temps que visibility.
  • visibility (Literal["public", "private", "protected"], facultatif) — Visibilité du dépôt. Peut être "public" ou "private", ou "protected" pour les Spaces.
  • token (Union[str, bool, None], facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — Le type de dépôt dont les paramètres doivent être mis à jour ("model", "dataset" ou "space"). La valeur par défaut est "model".

Lève

ValueError ou HfHubHTTPError ou RepositoryNotFoundError

  • ValueError — Si gated n'est pas l'une des valeurs « auto », « manual » ou False.
  • ValueError — Si repo_type n'est pas l'une des valeurs de constants.REPO_TYPES.
  • HfHubHTTPError — Si la requête vers l’API du Hugging Face Hub échoue.
  • RepositoryNotFoundError — Si le dépôt à partir duquel le téléchargement doit être effectué n’est pas trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.

Mettre à jour les paramètres d'un dépôt, y compris l'accès contrôlé et la visibilité.

Pour offrir un meilleur contrôle sur l’utilisation des dépôts, le Hub permet aux auteurs de dépôts d’activer les demandes d’accès à leurs dépôts et de modifier la visibilité du dépôt.

update_scheduled_job_labels

< >

( scheduled_job_id: strlabels: dict[str, str]namespace: str | None = Nonetoken: bool | str | None = None ) → ScheduledJobInfo

Paramètres

  • scheduled_job_id (str) — ID du Job planifié.
  • labels (dict[str, str]) — Nouvelles étiquettes à définir sur le travail planifié. Remplace toutes les étiquettes existantes. Les clés et les valeurs doivent contenir au maximum 100 caractères et ne comporter que des caractères alphanumériques, des tirets et des tirets bas.
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve le Job planifié. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

ScheduledJobInfo

Les informations mises à jour sur le Job planifié.

Mettre à jour les étiquettes d'un Job planifié existant.

Remplace tous les étiquettes fournies par l'utilisateur par les nouvelles étiquettes.

update_scheduled_job_schedule

< >

( scheduled_job_id: strschedule: strnamespace: str | None = Nonetoken: bool | str | None = None ) → ScheduledJobInfo

Paramètres

  • scheduled_job_id (str) — ID du Job planifié.
  • schedule (str) — L’un des éléments suivants : “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, ou une expression d’horaire CRON (par exemple, ‘0 9 * * 1’ pour 9 h chaque lundi).
  • namespace (str, facultatif) — L'espace de noms dans lequel se trouve le Job planifié. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

ScheduledJobInfo

Les informations mises à jour sur le Job planifié.

Modifier le moment d’exécution d’un Job planifié existant.

Seul l’horaire est mis à jour : la spécification du Job, les étiquettes et l’état de suspension sont conservés. Pour exécuter le Job planifié une seule fois immédiatement sans modifier son horaire, utilisez plutôt trigger_scheduled_job().

Exemple :

>>> from huggingface_hub import update_scheduled_job_schedule
>>> scheduled_job = update_scheduled_job_schedule(scheduled_job_id="6abb8dc9c617607c354d45f4", schedule="@daily")
>>> scheduled_job.schedule
'@daily'

update_webhook

< >

( webhook_id: strurl: str | None = Nonejob_id: str | None = Nonewatched: list[dict | WebhookWatchedItem] | None = Nonedomains: list[constants.WEBHOOK_DOMAIN_T] | None = Nonesecret: str | None = Nonesecrets: dict[str, str] | None = Nonetoken: bool | str | None = None ) → WebhookInfo

Paramètres

  • webhook_id (str) — L'identifiant unique du webhook à mettre à jour.
  • url (str, optionnel) — L’URL à laquelle la charge utile sera envoyée.
  • job_id (str, optionnel) — ID du Job source à déclencher avec la charge utile du webhook. Obligatoire lors de la configuration de secrets.
  • watched (list[WebhookWatchedItem], optionnel) — Liste des éléments à surveiller. Il peut s’agir d’utilisateurs, d’organisations, de modèles, de jeux de données ou d’espaces. Reportez-vous à WebhookWatchedItem pour plus de détails. Les éléments surveillés peuvent également être fournis sous forme de dictionnaires simples.
  • domains (list[Literal["repo", "discussion"]], optionnel) — Les domaines à surveiller. Cela peut inclure « repo », « discussion » ou les deux.
  • secret (str, optionnel) — Un secret pour signer la charge utile, offrant une couche de sécurité supplémentaire.
  • secrets (dict[str, str], optionnel) — Variables d’environnement secrètes pour le Job déclenché par le webhook. Les clés listées remplacent la valeur stockée, une chaîne vide supprime ce secret, et les clés omises conservent leur valeur stockée. Nécessite job_id.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

WebhookInfo

Informations sur le webhook mis à jour.

Mettre à jour un webhook existant.

Exemple :

>>> from huggingface_hub import update_webhook
>>> updated_payload = update_webhook(
...     webhook_id="654bbbc16f2ec14d77f109cc",
...     url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     domains=["repo"],
...     secret="my-secret",
... )
>>> print(updated_payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo"],
    secret="my-secret",
    disabled=False,

upload_attachment

< >

( path: str | Pathtoken: bool | str | None = None ) → str

Paramètres

  • path (str ou Path) — Chemin du fichier à téléverser. Les formats pris en charge sont PNG, JPEG, GIF, WebP, MP4, MOV, WebM, MP3 et WAV. Les fichiers doivent être inférieurs à 10 Mo (50 Mo pour les vidéos).
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Le jeton doit disposer de l’autorisation discussion.write. Pour téléverser de manière anonyme, passez False.

Retourne

str

l'URL du fichier téléversé.

Lève

ValueError

  • ValueError — Si le format de fichier n'est pas pris en charge.

Téléverse un fichier image, vidéo ou audio sur le Hub et renvoie son URL.

C’est ce que fait l’éditeur web du Hub lorsque vous glissez un fichier dans la zone de commentaire d’une Discussion ou d’une Pull Request. Intégrez l’URL renvoyée dans une description ou un commentaire : ![alt text](url) pour une image, l’URL brute pour une vidéo et <audio controls src="url"></audio> pour un fichier audio.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> url = api.upload_attachment("screenshot.png")
>>> api.create_discussion("username/my-model", title="Rendering bug", description=f"![screenshot]({url})")

upload_file

< >

( path_or_fileobj: str | Path | bytes | BinaryIOpath_in_repo: strrepo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = Nonerun_as_future: bool = False_hot_reload: bool | None = None ) → CommitInfo or Future

Paramètres

  • path_or_fileobj (str, Path, bytes ou IO) — Chemin vers un fichier sur la machine locale ou flux de données binaires / fileobj / tampon.
  • path_in_repo (str) — Chemin de fichier relatif dans le dépôt, par exemple : "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — Le dépôt vers lequel le fichier sera téléversé, par exemple : "username/custom_transformers"
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset", "space" ou "kernel" lors d’un dépôt dans un dépôt de jeu de données, d’espace ou de noyau, None ou "model" lors d’un dépôt dans un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • commit_message (str, facultatif) — Le résumé / titre / première ligne du commit généré
  • commit_description (str, facultatif) — La description du commit généré
  • create_pr (boolean, facultatif) — Indique s'il faut ou non créer une Pull Request avec cet engagement. La valeur par défaut est False. Si revision n'est pas défini, la PR est ouverte contre la branche "main". Si revision est défini et correspond à une branche, la PR est ouverte contre cette branche. Si revision est défini et n'est pas le nom d'une branche (par exemple : un oid d'engagement), une RevisionNotFoundError est renvoyée par le serveur.
  • parent_commit (str, facultatif) — L’OID / SHA du commit parent, sous forme de chaîne hexadécimale. Les abréviations (7 premiers caractères) sont également prises en charge. Si spécifié et que create_pr est False, le commit échouera si revision ne pointe pas vers parent_commit. Si spécifié et que create_pr est True, la pull request sera créée à partir de parent_commit. Spécifier parent_commit garantit que le dépôt n’a pas été modifié avant l’engagement des modifications, ce qui peut être particulièrement utile si le dépôt est mis à jour / commité simultanément.
  • run_as_future (bool, facultatif) — Indique s'il faut exécuter cette méthode en arrière-plan. Les tâches en arrière-plan sont exécutées séquentiellement sans bloquer le thread principal. Passer run_as_future=True renverra un objet Future. La valeur par défaut est False.

Retourne

CommitInfo ou Future

Instance de CommitInfo contenant des informations sur le nouvel engagement créé (hash de l'engagement, url de l'engagement, url de la PR, message de l'engagement,…). Si run_as_future=True est passé, renvoie un objet Future qui contiendra le résultat lors de son exécution.

Téléverser un fichier local (jusqu’à 50 Go) dans le dépôt indiqué. Le téléversement est effectué via une requête HTTP post et ne nécessite pas que git ou git-lfs soient installés.

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide
  • RepositoryNotFoundError Si le dépôt à partir duquel le téléchargement doit être effectué ne peut pas être trouvé. Cela peut être dû au fait qu’il n’existe pas, ou qu’il est défini comme private et que vous n’y avez pas accès.
  • RevisionNotFoundError Si la révision à télécharger n'est pas trouvée.

upload_file suppose que le dépôt existe déjà sur le Hub. En cas d’erreur Client 404, vérifiez que vous êtes authentifié, que votre jeton dispose des autorisations requises et que repo_id et repo_type sont correctement définis. Si le dépôt n’existe pas, créez-le d’abord à l’aide de create_repo().

Exemple :

>>> from huggingface_hub import upload_file

>>> with open("./local/filepath", "rb") as fobj:
...     upload_file(
...         path_or_fileobj=fileobj,
...         path_in_repo="remote/file/path.h5",
...         repo_id="username/my-dataset",
...         repo_type="dataset",
...         token="my_token",
...     )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
... )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
...     create_pr=True,
... )

upload_folder

< >

( repo_id: strfolder_path: str | Pathpath_in_repo: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = Noneallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonedelete_patterns: list[str] | str | None = Nonerun_as_future: bool = False ) → CommitInfo or Future

Paramètres

  • repo_id (str) — Le dépôt vers lequel le fichier sera téléversé, par exemple : "username/custom_transformers"
  • folder_path (str ou Path) — Chemin vers le dossier à téléverser sur le système de fichiers local
  • path_in_repo (str, facultatif) — Chemin relatif du répertoire dans le dépôt, par exemple : "checkpoints/1fec34a/results". Par défaut, le dossier racine du dépôt est utilisé.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • repo_type (str, facultatif) — À définir sur "dataset", "space" ou "kernel" lors d’un dépôt dans un dépôt de jeu de données, d’espace ou de noyau, None ou "model" lors d’un dépôt dans un modèle. La valeur par défaut est None.
  • revision (str, facultatif) — La révision git à partir de laquelle effectuer l'engagement. Par défaut, il s'agit de la tête de la branche "main".
  • commit_message (str, facultatif) — Le résumé / titre / première ligne du commit généré. Valeur par défaut : f"Upload {path_in_repo} with huggingface_hub"
  • commit_description (str facultatif) — La description du commit généré
  • create_pr (boolean, facultatif) — Indique s'il faut ou non créer une Pull Request avec cet engagement. La valeur par défaut est False. La PR est toujours ouverte contre la branche par défaut : définir à la fois create_pr=True et revision lève une ValueError. Notez que chaque appel avec create_pr=True ouvre une nouvelle pull request : pour reprendre un téléversement interrompu dans la PR existante, relancez avec revision="refs/pr/N" à la place.
  • parent_commit (str, facultatif) — L’OID / SHA du commit parent, sous forme de chaîne hexadécimale. Les abréviations (7 premiers caractères) sont également prises en charge. Si spécifié et que create_pr est False, le commit échouera si revision ne pointe pas vers parent_commit. Spécifier parent_commit garantit que le dépôt n’a pas été modifié avant l’engagement des modifications, ce qui peut être particulièrement utile si le dépôt est mis à jour / commité simultanément. Si le téléversement est réparti en plusieurs commits (dossiers volumineux), parent_commit ne s’applique qu’au premier.
  • allow_patterns (list[str] ou str, facultatif) — Si fourni, seuls les fichiers correspondant à au moins un motif sont téléversés.
  • ignore_patterns (list[str] ou str, facultatif) — Si fourni, les fichiers correspondant à l’un des motifs ne sont pas téléversés.
  • delete_patterns (list[str] ou str, facultatif) — Si fourni, les fichiers distants correspondant à l’un des motifs seront supprimés du dépôt lors de l’engagement des nouveaux fichiers. Cela est utile si vous ne savez pas quels fichiers ont déjà été téléversés. Remarque : pour éviter les incohérences, le fichier .gitattributes n’est pas supprimé, même s’il correspond au motif.
  • run_as_future (bool, facultatif) — Indique s'il faut exécuter cette méthode en arrière-plan. Les tâches en arrière-plan sont exécutées séquentiellement sans bloquer le thread principal. Passer run_as_future=True renverra un objet Future. La valeur par défaut est False.

Retourne

CommitInfo ou Future

Instance de CommitInfo contenant des informations sur le nouvel engagement créé (hash de l'engagement, url de l'engagement, url de la PR, message de l'engagement,…). Si run_as_future=True est passé, renvoie un objet Future qui contiendra le résultat lors de son exécution.

Téléversez un dossier local dans le dépôt indiqué. Le téléversement est effectué via des requêtes HTTP et ne nécessite pas que git ou git-lfs soient installés.

La structure du dossier sera conservée. Les fichiers portant le même nom et déjà présents dans le dépôt seront écrasés. Les autres resteront inchangés.

Utilisez les arguments allow_patterns et ignore_patterns pour spécifier les fichiers à téléverser. Ces paramètres acceptent un motif unique ou une liste de motifs. Les motifs sont des jokers standard (motifs globbing) tels que documentés ici. Si allow_patterns et ignore_patterns sont tous deux fournis, les deux contraintes s’appliquent. Par défaut, tous les fichiers du dossier sont téléversés.

Utilisez l'argument delete_patterns pour spécifier les fichiers distants que vous souhaitez supprimer. Le type d'entrée est le même que pour allow_patterns (voir ci-dessus). Si path_in_repo est également fourni, les motifs sont comparés aux chemins relatifs à ce dossier. Par exemple, upload_folder(..., path_in_repo="experiment", delete_patterns="logs/*") supprimera tout fichier distant sous ./experiment/logs/. Notez que le fichier .gitattributes ne sera pas supprimé, même s'il correspond aux motifs.

Tout dossier .git/ présent dans un sous-dossier sera ignoré. Veuillez toutefois noter que le fichier .gitignore n'est pas pris en compte.

Lorsque hf_xet est installé (par défaut), les fichiers sont téléversés via un pipeline en flux continu : les téléversements démarrent pendant que le dossier est encore vérifié par rapport au Hub, les fichiers sont hachés pendant leur découpage pour le téléversement (une seule passe de lecture) et les grands dossiers sont automatiquement commités par lots pour rester sous les limites du serveur (les commits suivants reçoivent un suffixe (part N) dans le message de commit). Si le téléversement est interrompu, la réexécution de l’appel reprend l’opération : les fichiers déjà commités sont ignorés et les données déjà téléversées sont dédupliquées. Si hf_xet n’est pas installé, le système bascule sur un commit unique créé avec create_commit().

Lève les erreurs suivantes :

  • HTTPError si l'API HuggingFace a renvoyé une erreur
  • ValueError si la valeur d'un paramètre est invalide

upload_folder suppose que le dépôt existe déjà sur le Hub. Si vous obtenez une erreur Client 404, veuillez vous assurer que vous êtes authentifié, que votre jeton dispose des autorisations requises et que repo_id et repo_type sont définis correctement. Si le dépôt n'existe pas, créez-le d'abord à l'aide de create_repo().

Exemple :

# Upload checkpoints folder except the log files
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     ignore_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder including logs while deleting existing logs from the repo
# Useful if you don't know exactly which log files have already being pushed
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     delete_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder while creating a PR
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     create_pr=True,
... )

verify_repo_checksums

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonelocal_dir: str | Path | None = Nonecache_dir: str | Path | None = Nonetoken: str | bool | None = None ) → FolderVerification

Paramètres

  • repo_id (str) — Un espace de noms (utilisateur ou organisation) et un nom de dépôt séparés par un /.
  • repo_type (str, facultatif) — Le type de dépôt à partir duquel obtenir l’arborescence ("model", "dataset" ou "space". La valeur par défaut est "model".
  • revision (str, facultatif) — La révision du dépôt à partir de laquelle obtenir l'arborescence. Par défaut, la branche "main".
  • local_dir (str ou Path, facultatif) — Le répertoire local à vérifier.
  • cache_dir (str ou Path, facultatif) — Le répertoire de cache à vérifier.
  • token (Union[bool, str, None], optionnel) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.

Retourne

FolderVerification

un résultat structuré contenant les détails de la vérification.

Lève

RepositoryNotFoundError ou RevisionNotFoundError

  • RepositoryNotFoundError — Si le dépôt n'est pas trouvé (erreur 404) : repo_id/repo_type incorrect, dépôt privé mais non authentifié ou dépôt inexistant.
  • RevisionNotFoundError — Si la révision n’est pas trouvée (erreur 404) dans le dépôt.

Vérifier les fichiers locaux d'un dépôt par rapport aux sommes de contrôle du Hub.

wait_for_job

< >

( job_id: str | list[str]timeout: float | None = Nonepoll_interval: float = 1.0stages: list[JobStage] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo or list[JobInfo]

Paramètres

  • job_id (str ou list[str]) — ID du Job, ou une liste d’IDs de Jobs à attendre. Si une liste est passée, une liste de JobInfo est retournée (dans le même ordre).
  • timeout (float, facultatif) — Durée maximale d’attente de la fin du ou des Job, en secondes. Si None, l’attente est indéfinie.
  • poll_interval (float, facultatif) — Temps d’attente entre chaque vérification d’état, en secondes. Valeur par défaut : 1 s.
  • stages (list[JobStage], facultatif) — Les étapes à attendre. Par défaut, il s’agit des étapes terminales ("COMPLETED", "CANCELED", "ERROR", "DELETED"). Passez par exemple [JobStage.RUNNING] pour attendre que le Job démarre. Les étapes terminales arrêtent toujours l’attente, quelle que soit cette valeur.
  • namespace (str, facultatif) — L'espace de noms dans lequel les Job(s) s'exécutent. Par défaut, l'espace de noms de l'utilisateur actuel.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. S’il n’est pas fourni, le jeton enregistré localement sera utilisé, ce qui est la méthode d’authentification recommandée. Définissez-le sur False pour désactiver l’authentification. Voir : https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

JobInfo ou list[JobInfo]

les informations finales du Job.

Lève

TimeoutError

  • TimeoutError — Si au moins un Job n’a pas atteint l’une des étapes cibles après timeout secondes.

Attendez qu'un ou plusieurs Jobs de calcul sur l'infrastructure Hugging Face atteignent un stade donné.

Chaque statut de Job est interrogé (via inspect_job()) toutes les poll_interval secondes jusqu'à ce que son stage soit l'un des stages (stages terminaux par défaut : "COMPLETED", "CANCELED", "ERROR" ou "DELETED"). Le JobInfo final est retourné dans tous les cas : un Job en échec ou annulé ne lève pas d'exception — vérifiez job.status.stage pour agir en fonction du résultat.

Les étapes terminales arrêtent toujours l’attente, même lorsqu’elles ne sont pas listées dans stages. Cela évite d’attendre indéfiniment une étape que le Job n’atteindra jamais (par exemple, attendre "RUNNING" pour un Job qui échoue pendant la planification).

Exemple :

>>> from huggingface_hub import run_job, wait_for_job
>>> job = run_job(image="python:3.12", command=["python", "-c", "print('Hello from HF compute!')"])
>>> wait_for_job(job_id=job.id).status.stage
'COMPLETED'

wait_for_space

< >

( repo_id: strtimeout: float | None = Nonepoll_interval: float = 1.0token: bool | str | None = None ) → SpaceRuntime

Paramètres

  • repo_id (str) — ID de l'Espace à attendre. Exemple : "username/my-space".
  • timeout (float, facultatif) — Temps d’attente maximal, en secondes. Si None, attend indéfiniment.
  • poll_interval (float, facultatif) — Secondes entre les vérifications d'état. Valeur par défaut : 1 s.
  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide. Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode d’authentification recommandée. Définissez la valeur sur False pour désactiver l’authentification. Voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Retourne

SpaceRuntime

Les informations d'exécution finales une fois que le Space atteint un état terminal.

Lève

TimeoutError

  • TimeoutError — Si l’Espace n’a pas atteint une étape terminale après timeout secondes.

Attendez qu'un Space atteigne un état terminal (pas en cours de construction/démarrage).

Les sondages appellent get_space_runtime() toutes les poll_interval secondes jusqu’à ce que l’état du Space ne soit plus intermédiaire (BUILDING, RUNNING_BUILDING, APP_STARTING, RUNNING_APP_STARTING). Renvoie le SpaceRuntime final dans tous les cas — vérifiez runtime.stage pour agir en fonction du résultat (par ex. RUNNING vs BUILD_ERROR).

Exemple :

>>> from huggingface_hub import restart_space, wait_for_space
>>> restart_space("username/my-space")
>>> runtime = wait_for_space("username/my-space")
>>> runtime.stage
'RUNNING'

whoami

< >

( token: bool | str | None = Nonecache: bool = False )

Paramètres

  • token (bool ou str, facultatif) — Un jeton d’accès utilisateur valide (chaîne de caractères). Par défaut, le jeton enregistré localement est utilisé, ce qui est la méthode recommandée pour l’authentification (voir https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Pour désactiver l’authentification, passez False.
  • cache (bool, facultatif) — Indique s'il faut mettre en cache le résultat de l'appel whoami pour les appels suivants. Si une erreur se produit lors du premier appel, elle ne sera pas mise en cache. La valeur par défaut est False.

Appeler l'API HF pour savoir « whoami ».

Si vous passez cache=True, le résultat sera mis en cache pour les appels suivants pendant toute la durée du processus Python. Cela est utile si vous prévoyez d’appeler whoami plusieurs fois, car ce point d’accès est fortement limité en débit pour des raisons de sécurité.

API Dataclasses

AccessRequest

classe huggingface_hub.hf_api.AccessRequest

< >

( username: str | Nonerequest_id: strfullname: str | Noneemail: str | Nonetimestamp: datetimestatus: Literal['pending', 'accepted', 'rejected']fields: dict[str, Any] | None = None )

Paramètres

  • username (str, facultatif) — Nom d'utilisateur de l'utilisateur ayant demandé l'accès. None si le dépôt est configuré pour ne pas partager les noms d'utilisateur des demandeurs. Dans ce cas, utilisez request_id pour accepter, refuser ou annuler la demande.
  • request_id (str) — Identifiant de la demande d'accès. Toujours défini, même si le nom d'utilisateur n'est pas partagé.
  • fullname (str, facultatif) — Nom complet de l'utilisateur ayant demandé l'accès. None si le dépôt est configuré pour ne pas partager les noms des demandeurs.
  • email (str, facultatif) — E-mail de l’utilisateur ayant demandé l’accès. None si l’accès a été accordé manuellement ou si le dépôt est configuré pour ne pas partager les e-mails des demandeurs.
  • timestamp (datetime) — Horodatage de la requête.
  • status (Literal["pending", "accepted", "rejected"]) — Statut de la demande. Peut être l’un des éléments de ["pending", "accepted", "rejected"].
  • fields (dict[str, Any], facultatif) — Champs supplémentaires remplis par l'utilisateur dans le formulaire de gate.

Structure de données contenant des informations sur une demande d'accès utilisateur.

BucketFile

classe huggingface_hub.BucketFile

< >

( **kwargs )

Contient des informations sur un fichier dans un bucket sur le Hub. Cet objet est retourné par list_bucket_tree().

Similaire à RepoFile mais pour les fichiers dans les buckets.

BucketFileMetadata

classe huggingface_hub.BucketFileMetadata

< >

( size: intxet_file_data: XetFileData )

Paramètres

  • size (int) — Taille du fichier en octets.
  • xet_file_data (XetFileData) — Informations Xet pour le fichier (hachage et route de rafraîchissement).

Structure de données contenant des informations sur un fichier dans un bucket.

Retourné par get_bucket_file_metadata().

BucketInfo

classe huggingface_hub.BucketInfo

< >

( **kwargs )

Paramètres

  • id (str) — ID du bucket.
  • private (bool) — Indique si le bucket est privé.
  • created_at (datetime) — Date de création du bucket sur le Hub.
  • size (int) — Taille du seau en octets.
  • total_files (int) — Nombre total de fichiers dans le bucket.

Contient des informations sur un bucket sur le Hub. Cet objet est retourné par bucket_info() et list_buckets().

BucketUrl

classe huggingface_hub.BucketUrl

< >

( url: strendpoint: str = '' )

Paramètres

  • url (str) — Valeur de chaîne de l'URL du bucket.
  • endpoint (str, facultatif) — Endpoint du Hub. Par défaut, https://huggingface.co.

Décrive une URL de bucket sur le Hub.

BucketUrl est retourné par create_bucket(). À l’initialisation, l’URL est analysée pour peupler les propriétés :

  • endpoint (str)
  • espace de noms (str)
  • bucket_id (str)
  • url (str)
  • uri (HfUri)

DatasetLeaderboardEntry

classe huggingface_hub.DatasetLeaderboardEntry

< >

( **kwargs )

Paramètres

  • rank (int) — Rang du modèle sur le classement (indexation à partir de 1).
  • model_id (str) — ID du modèle (par ex. "meta-llama/Llama-3-8b").
  • value (float) — Valeur du score d'évaluation.
  • filename (str) — Nom du fichier de résultat contenant les données d'évaluation.
  • verified (bool) — Indique si le résultat a été vérifié.
  • source (dict[str, Any], facultatif) — Informations sur l'origine du résultat d'évaluation. Contient des clés telles que "url", "name" et "isExternal". Toutes les entrées ne disposent pas d'une source.
  • author (User ou Organization) — L’auteur du modèle, analysé en fonction du champ "type" de la réponse de l’API.
  • pull_request (int, facultatif) — Numéro de la pull request associée à l'entrée du classement, le cas échéant.
  • notes (str, facultatif) — Notes associées à l'entrée du classement, le cas échéant.

Contient des informations sur une seule entrée d'un classement de jeux de données sur le Hub.

Un tableau de classement classe les modèles en fonction de leurs scores d'évaluation sur un jeu de données de référence donné. Cet objet est renvoyé par get_dataset_leaderboard(). Pour obtenir les résultats d'évaluation d'un modèle spécifique sur différents jeux de données de référence, consultez ModelInfo.eval_results (via model_info() avec expand=["evalResults"]) et EvalResultEntry.

EvalResultEntry

classe huggingface_hub.EvalResultEntry

< >

( dataset_id: strtask_id: strvalue: typing.Anydataset_revision: str | None = Noneverify_token: str | None = Nonedate: str | None = Nonesource_url: str | None = Nonesource_name: str | None = Nonesource_user: str | None = Nonesource_org: str | None = Nonenotes: str | None = None )

Paramètres

  • dataset_id (str) — ID du jeu de données de référence sur le Hub. Exemple : “cais/hle”, “Idavidrein/gpqa”.
  • task_id (str) — Identifiant de la tâche au sein du benchmark. Exemple : « gpqa_diamond ».
  • value (Any) — La valeur de la métrique. Exemple : 20.90.
  • dataset_revision (str, facultatif) — SHA Git du jeu de données de référence.
  • verify_token (str, facultatif) — Une signature qui peut être utilisée pour prouver que l'évaluation est auditable et reproductible de manière démontrable.
  • date (str, facultatif) — Moment de l’exécution de l’évaluation (date et heure au format ISO-8601). Par défaut, correspond à l’heure du commit git.
  • source_url (str, facultatif) — Lien vers la source d’évaluation (par ex. https://huggingface.co/spaces/SaylorTwift/smollm3-mmlu-pro). Obligatoire si source_name, source_user ou source_org est fourni.
  • source_name (str, facultatif) — Nom d’affichage de la source. Exemple : « Eval Logs ».
  • source_user (str, facultatif) — Nom d'utilisateur HF pour l'attribution. Exemple : « celinah ».
  • source_org (str, facultatif) — Nom de l’organisation HF pour l’attribution. Exemple : « cais ».
  • notes (str, facultatif) — Détails sur la configuration de l'évaluation. Exemple : « tools », « no-tools », « chain-of-thought ».

Entrée de résultat d'évaluation pour le format .eval_results/*.yaml.

Représente les scores d’évaluation stockés dans les dépôts de modèles, qui apparaissent automatiquement sur la page du modèle et sur le tableau de classement du jeu de données de référence.

Pour le format model-index obsolète dans README.md, utilisez EvalResult à la place.

Voir https://huggingface.co/docs/hub/eval-results pour plus de détails.

Exemple :

>>> from huggingface_hub import EvalResultEntry
>>> # Minimal example with required fields only
>>> result = EvalResultEntry(
...     dataset_id="Idavidrein/gpqa",
...     task_id="gpqa_diamond",
...     value=0.412,
... )
>>> # Full example with all fields
>>> result = EvalResultEntry(
...     dataset_id="cais/hle",
...     task_id="default",
...     value=20.90,
...     dataset_revision="5503434ddd753f426f4b38109466949a1217c2bb",
...     verify_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
...     date="2025-01-15T10:30:00Z",
...     source_url="https://huggingface.co/datasets/cais/hle",
...     source_name="CAIS HLE",
...     source_org="cais",
...     notes="no-tools",
... )

SyncOperation

classe huggingface_hub.SyncOperation

< >

( action: typing.Literal['upload', 'download', 'delete', 'skip']path: strsize: int | None = Nonereason: str = ''local_mtime: str | None = Noneremote_mtime: str | None = Nonebucket_file: huggingface_hub._buckets.BucketFile | None = None )

Représente une opération de synchronisation à effectuer.

SyncPlan

classe huggingface_hub.SyncPlan

< >

( source: strdest: strtimestamp: stroperations: list = <factory> )

Représente un plan de synchronisation complet.

CommitInfo

classe huggingface_hub.CommitInfo

< >

( commit_url: str*args**kwargs )

Paramètres

  • commit_url (str) — Url où trouver le commit.
  • commit_message (str) — Le résumé (première ligne) du commit qui a été créé.
  • commit_description (str) — Description du commit qui a été créé. Peut être vide.
  • oid (str) — Identifiant du commit. Exemple : "91c54ad1727ee830252e457677f467be0bfd8a57".
  • pr_url (str, facultatif) — Url de la PR créée, le cas échéant. Rempli lorsque create_pr=True est passé.
  • pr_revision (str, facultatif) — Révision de la PR créée, le cas échéant. Rempli lorsque create_pr=True est passé. Exemple : "refs/pr/1".
  • pr_num (int, facultatif) — Numéro de la discussion de PR créée, le cas échéant. Rempli lorsque create_pr=True est transmis. Peut être transmis en tant que discussion_num dans get_discussion_details(). Exemple : 1.
  • repo_url (RepoUrl) — URL du dépôt du commit contenant des informations telles que repo_id, repo_type, etc.

Structure de données contenant des informations sur un nouvel engagement créé.

Retourné par toute méthode qui crée un commit sur le Hub : create_commit(), upload_file(), upload_folder(), delete_file(), delete_folder(). Il hérite de str pour des raisons de compatibilité ascendante, mais l’utilisation de méthodes spécifiques à str est dépréciée.

DatasetInfo

classe huggingface_hub.DatasetInfo

< >

( **kwargs )

Paramètres

  • id (str) — ID du jeu de données.
  • author (str) — Auteur du jeu de données.
  • card_data (DatasetCardData, facultatif) — Métadonnées de la carte de jeu de données sous forme d'objet huggingface_hub.repocard_data.DatasetCardData.
  • citation (str, optional) — Citation information for the dataset.
  • created_at (datetime, facultatif) — Date de création du dépôt sur le Hub. Notez que la valeur minimale est 2022-03-02T23:29:04.000Z, correspondant à la date à laquelle nous avons commencé à stocker les dates de création.
  • description (str, facultatif) — Description du jeu de données.
  • disabled (bool, facultatif) — Indique si le dépôt est désactivé.
  • downloads (int) — Nombre de téléchargements du jeu de données au cours des 30 derniers jours.
  • downloads_all_time (int) — Nombre cumulé de téléchargements du jeu de données depuis sa création.
  • gated (Literal["auto", "manual", False], facultatif) — Indique si le dépôt est protégé. Si oui, précise si l’approbation est manuelle ou automatique.
  • last_modified (datetime, facultatif) — Date du dernier commit dans le dépôt.
  • likes (int) — Nombre de « j’aime » du jeu de données.
  • main_size (int, facultatif) — Taille en octets de la branche principale du jeu de données.
  • paperswithcode_id (str, facultatif) — ID Papers with code du jeu de données.
  • private (bool) — Indique si le dépôt est privé.
  • resource_group (dict, facultatif) — Informations sur le groupe de ressources du jeu de données.
  • sha (str) — SHA du dépôt à cette révision particulière.
  • siblings (list[RepoSibling]) — Liste d’objets huggingface_hub.hf_api.RepoSibling qui constituent le jeu de données.
  • tags (list[str]) — Liste des tags du jeu de données.
  • trending_score (int, facultatif) — Score de tendance du jeu de données.
  • used_storage (int, facultatif) — Taille en octets du jeu de données sur le Hub.

Contient des informations sur un jeu de données du Hub. Cet objet est retourné par dataset_info() et list_datasets().

La plupart des attributs de cette classe sont optionnels. Cela est dû au fait que les données renvoyées par le Hub dépendent de la requête effectuée. En général, plus la requête est spécifique, plus les informations renvoyées sont nombreuses. À l’inverse, lors de l’énumération des jeux de données à l’aide de list_datasets(), seul un sous-ensemble des attributs est renvoyé.

DryRunFileInfo

classe huggingface_hub.DryRunFileInfo

< >

( commit_hash: strfile_size: int | Nonefilename: strlocal_path: stris_cached: boolwill_download: bool )

Paramètres

  • commit_hash (str) — Le commit_hash associé au fichier.
  • file_size (int, facultatif) — Taille du fichier, si connue. Dans le cas d'un fichier LFS, contient la taille du fichier LFS réel, et non celle du pointeur.
  • filename (str) — Nom du fichier dans le dépôt.
  • is_cached (bool) — Indique si le fichier est déjà mis en cache localement.
  • will_download (bool) — Indique si le fichier sera téléchargé si hf_hub_download est appelé avec dry_run=False. En pratique, will_download est True si le fichier n’est pas en cache ou si force_download=True.

Informations renvoyées lors de l'exécution à blanc d'un téléchargement de fichier.

Retourné par hf_hub_download() lorsque dry_run=True.

DuplicatedRepoUrl

classe huggingface_hub.DuplicatedRepoUrl

< >

( url: Anyendpoint: str | None = None )

Paramètres

  • files_copy_pending (bool) — True si les fichiers LFS/Xet du nouveau dépôt sont encore en cours de copie en arrière-plan. Tant que la copie n'est pas terminée, le téléchargement de ces fichiers peut échouer.

RepoUrl renvoyé par duplicate_repo().

GitRefInfo

classe huggingface_hub.GitRefInfo

< >

( name: strref: strtarget_commit: str )

Paramètres

  • name (str) — Nom de la référence (par exemple, nom d'étiquette ou nom de branche).
  • ref (str) — Référence git complète sur le Hub (par ex. "refs/heads/main" ou "refs/tags/v1.0").
  • target_commit (str) — OID de la cible de commit pour la référence (par exemple "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")

Contient des informations sur une référence git pour un dépôt sur le Hub.

GitCommitInfo

classe huggingface_hub.GitCommitInfo

< >

( commit_id: strauthors: list[str]created_at: datetimetitle: strmessage: strformatted_title: str | Noneformatted_message: str | None )

Paramètres

  • commit_id (str) — OID de la commit (par ex. "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")
  • authors (list[str]) — Liste des auteurs du commit.
  • created_at (datetime) — Date et heure de création du commit.
  • title (str) — Titre de la commit. Il s'agit d'une valeur en texte libre saisie par les auteurs.
  • message (str) — Description du commit. Il s'agit d'une valeur en texte libre saisie par les auteurs.
  • formatted_title (str) — Titre de la commit formaté en HTML. N'est renvoyé que si formatted=True est défini.
  • formatted_message (str) — Description du commit formatée en HTML. N’est renvoyée que si formatted=True est défini.

Contient des informations sur un commit git d'un dépôt sur le Hub. Consultez list_repo_commits() pour plus de détails.

GitRefs

classe huggingface_hub.GitRefs

< >

( branches: list[GitRefInfo]converts: list[GitRefInfo]tags: list[GitRefInfo]pull_requests: list[GitRefInfo] | None = None )

Paramètres

  • branches (list[GitRefInfo]) — Une liste de GitRefInfo contenant des informations sur les branches du dépôt.
  • converts (list[GitRefInfo]) — Une liste de GitRefInfo contenant des informations sur les refs « convert » du dépôt. Les refs convert sont utilisées (en interne) pour pousser des données prétraitées dans les dépôts de Dataset.
  • tags (list[GitRefInfo]) — Une liste de GitRefInfo contenant des informations sur les tags du dépôt.
  • pull_requests (list[GitRefInfo], facultatif) — Une liste de GitRefInfo contenant des informations sur les pull requests du dépôt. Retournée uniquement si include_prs=True est défini.

Contient des informations sur toutes les références git d'un dépôt sur le Hub.

Object est retourné par list_repo_refs().

InferenceProviderMapping

classe huggingface_hub.hf_api.InferenceProviderMapping

< >

( **kwargs )

KernelInfo

classe huggingface_hub.KernelInfo

< >

( **kwargs )

Paramètres

  • id (str) — ID du dépôt du noyau.
  • author (str, facultatif) — Auteur du dépôt du noyau.
  • downloads (int, facultatif) — Nombre de téléchargements du dépôt de noyaux au cours des 30 derniers jours.
  • gated (Literal["auto", "manual", False], facultatif) — Indique si le dépôt est protégé. Le cas échéant, précise si l’approbation est manuelle ou automatique.
  • last_modified (datetime, facultatif) — Date du dernier commit dans le dépôt.
  • likes (int, facultatif) — Nombre de « j'aime » du dépôt du noyau.
  • private (bool, facultatif) — Indique si le dépôt est privé.
  • sha (str, facultatif) — SHA du dépôt à cette révision particulière.

Contient des informations sur un dépôt de noyau sur le Hub. Cet objet est renvoyé par kernel_info().

LFSFileInfo

classe huggingface_hub.hf_api.LFSFileInfo

< >

( **kwargs )

Paramètres

  • file_oid (str) — Identifiant d’objet SHA-256 du fichier. C’est l’identifiant à transmettre lors de la suppression définitive du fichier.
  • filename (str) — Nom de fichier possible pour l'objet LFS. Consultez la note ci-dessus pour plus d'informations.
  • oid (str) — OID de l'objet LFS.
  • pushed_at (datetime) — Date à laquelle l'objet LFS a été poussé vers le dépôt.
  • ref (str, facultatif) — Référence vers laquelle l’objet LFS a été poussé (le cas échéant).
  • size (int) — Taille de l'objet LFS.

Contient des informations sur un fichier stocké en LFS dans un dépôt sur le Hub.

Utilisé dans le contexte de la liste et de la suppression définitive des fichiers LFS d'un dépôt afin de libérer de l'espace. Voir list_lfs_files() et permanently_delete_lfs_files() pour plus de détails.

Les fichiers Git LFS sont suivis à l'aide d'identifiants d'objets SHA-256, plutôt que de chemins de fichiers, afin d'optimiser les performances. Cette approche est nécessaire car un même objet peut être référencé par plusieurs chemins au fil de différents commits, ce qui rend la recherche et la résolution de ces liens peu pratique. Consultez notre documentation pour savoir comment identifier le ou les noms de fichiers associés à chaque SHA.

Exemple :

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

ModelInfo

classe huggingface_hub.ModelInfo

< >

( **kwargs )

Paramètres

  • id (str) — ID du modèle.
  • author (str, facultatif) — Auteur du modèle.
  • base_models (list[str], facultatif) — Liste des modèles de base dont ce modèle est dérivé.
  • card_data (ModelCardData, facultatif) — Métadonnées de la carte de modèle sous forme d'objet huggingface_hub.repocard_data.ModelCardData.
  • children_model_count (int, facultatif) — Nombre de modèles enfants dérivés de ce modèle.
  • config (dict, facultatif) — Configuration du modèle.
  • created_at (datetime, facultatif) — Date de création du dépôt sur le Hub. Notez que la valeur minimale est 2022-03-02T23:29:04.000Z, correspondant à la date à laquelle nous avons commencé à stocker les dates de création.
  • disabled (bool, facultatif) — Indique si le dépôt est désactivé.
  • downloads (int) — Nombre de téléchargements du modèle au cours des 30 derniers jours.
  • downloads_all_time (int) — Nombre cumulé de téléchargements du modèle depuis sa création.
  • eval_results (list[EvalResultEntry], facultatif) — Résultats d'évaluation du modèle.
  • gated (Literal["auto", "manual", False], facultatif) — Indique si le dépôt est protégé. Si oui, précise si l’approbation est manuelle ou automatique.
  • gguf (dict, facultatif) — Informations GGUF du modèle.
  • inference (Literal["warm"], facultatif) — Statut du modèle sur les fournisseurs d’inférence. « Warm » si le modèle est servi par au moins un fournisseur.
  • inference_provider_mapping (list[InferenceProviderMapping], facultatif) — Une liste de InferenceProviderMapping ordonnée selon l’ordre des fournisseurs de l’utilisateur.
  • last_modified (datetime, facultatif) — Date du dernier commit dans le dépôt.
  • library_name (str, facultatif) — Bibliothèque associée au modèle.
  • likes (int) — Nombre de « j’aime » du modèle.
  • mask_token (str, facultatif) — Jeton de masque utilisé par le modèle.
  • model_index (dict, facultatif) — Index du modèle pour l'évaluation.
  • pipeline_tag (str, facultatif) — Étiquette de pipeline associée au modèle.
  • private (bool) — Indique si le dépôt est privé.
  • resource_group (dict, facultatif) — Informations sur le groupe de ressources du modèle.
  • safetensors (SafeTensorsInfo, facultatif) — Informations safetensors du modèle.
  • security_repo_status (dict, facultatif) — Statut de l’analyse de sécurité du modèle.
  • sha (str, facultatif) — SHA du dépôt à cette révision particulière.
  • siblings (list[RepoSibling]) — Liste d’objets huggingface_hub.hf_api.RepoSibling qui constituent le modèle.
  • spaces (list[str], facultatif) — Liste des espaces utilisant le modèle.
  • tags (list[str]) — Liste des tags du modèle. Par rapport à card_data.tags, contient des tags supplémentaires calculés par le Hub (p. ex. les bibliothèques prises en charge, l’arXiv du modèle).
  • transformers_info (TransformersInfo, facultatif) — Informations spécifiques à Transformers (classe auto, processeur, etc.) associées au modèle.
  • trending_score (int, facultatif) — Score de tendance du modèle.
  • used_storage (int, facultatif) — Taille en octets du modèle sur le Hub.
  • widget_data (Any, facultatif) — Données du widget associées au modèle.

Contient des informations sur un modèle du Hub. Cet objet est retourné par model_info() et list_models().

La plupart des attributs de cette classe sont optionnels. Cela est dû au fait que les données renvoyées par le Hub dépendent de la requête effectuée. En général, plus la requête est spécifique, plus les informations renvoyées sont nombreuses. À l’inverse, lors de l’énumération des modèles à l’aide de list_models(), seul un sous-ensemble des attributs est renvoyé.

RepoSibling

classe huggingface_hub.hf_api.RepoSibling

< >

( rfilename: strsize: int | None = Noneblob_id: str | None = Nonelfs: BlobLfsInfo | None = None )

Paramètres

  • rfilename (str) — nom du fichier, relatif à la racine du dépôt.
  • size (int, facultatif) — La taille du fichier, en octets. Cet attribut est défini lorsque l’argument files_metadata de repo_info() est défini à True. Il est None dans le cas contraire.
  • blob_id (str, facultatif) — L’OID git du fichier. Cet attribut est défini lorsque l’argument files_metadata de repo_info() est défini sur True. Il est None dans le cas contraire.
  • lfs (BlobLfsInfo, facultatif) — Les métadonnées LFS du fichier. Cet attribut est défini lorsque l’argument files_metadata de repo_info() est défini sur True et que le fichier est stocké avec Git LFS. Il est None dans le cas contraire.

Contient des informations de base sur un fichier de dépôt dans un dépôt sur le Hub.

Tous les attributs de cette classe sont facultatifs, à l'exception de rfilename. En effet, seuls les noms de fichiers sont renvoyés lors de l'énumération des dépôts sur le Hub (avec list_models(), list_datasets() ou list_spaces()). Si vous avez besoin de plus d'informations, telles que la taille du fichier, l'identifiant du blob ou les détails lfs, vous devez les demander explicitement pour un dépôt à la fois (en utilisant model_info(), dataset_info() ou space_info()), car cela impose davantage de contraintes au serveur backend pour les récupérer.

RepoFile

classe huggingface_hub.RepoFile

< >

( **kwargs )

Paramètres

  • path (str) — chemin du fichier relatif à la racine du dépôt.
  • size (int) — La taille du fichier, en octets.
  • blob_id (str) — OID git du fichier.
  • lfs (BlobLfsInfo, facultatif) — Les métadonnées LFS du fichier.
  • xet_hash (str, facultatif) — Le hachage Xet du fichier.
  • last_commit (LastCommitInfo, facultatif) — Métadonnées du dernier commit du fichier. Défini uniquement si list_repo_tree() et get_paths_info() sont appelés avec expand=True.
  • security (BlobSecurityInfo, facultatif) — Les métadonnées de l’analyse de sécurité du fichier. Défini uniquement si list_repo_tree() et get_paths_info() sont appelés avec expand=True.

Contient des informations sur un fichier du Hub.

RepoUrl

classe huggingface_hub.RepoUrl

< >

( url: Anyendpoint: str | None = None )

Paramètres

  • url (Any) — Valeur de chaîne de l'URL du dépôt.
  • endpoint (str, facultatif) — Endpoint du Hub. Par défaut, https://huggingface.co.

Lève

HfUriError

  • HfUriError — Si l’URL ne peut pas être analysée (par exemple, dépôt mono-segment canonique, ou repo_type inconnu).

Sous-classe de str décrivant une URL de dépôt sur le Hub.

RepoUrl est retourné par HfApi.create_repo. Il hérite de str pour des raisons de compatibilité ascendante. À l’initialisation, l’URL est analysée pour alimenter les propriétés :

  • endpoint (str)
  • espace de noms (str)
  • repo_name (str)
  • repo_id (str)
  • repo_type (Literal["model", "dataset", "space"])
  • url (str)

Exemple :

>>> RepoUrl('https://huggingface.co/openai-community/gpt2')
RepoUrl('https://huggingface.co/openai-community/gpt2', endpoint='https://huggingface.co', repo_type='model', repo_id='openai-community/gpt2')

>>> RepoUrl('https://huggingface.co/proxy/hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://huggingface.co/proxy/hub-ci.huggingface.co')
RepoUrl('https://huggingface.co/proxy/hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://huggingface.co/proxy/hub-ci.huggingface.co', repo_type='dataset', repo_id='dummy_user/dummy_dataset')

>>> RepoUrl('hf://datasets/my-user/my-dataset')
RepoUrl('hf://datasets/my-user/my-dataset', endpoint='https://huggingface.co', repo_type='dataset', repo_id='user/dataset')

>>> HfApi.create_repo("dummy_model")
RepoUrl('https://huggingface.co/Wauplin/dummy_model', endpoint='https://huggingface.co', repo_type='model', repo_id='Wauplin/dummy_model')

SafetensorsRepoMetadata

classe huggingface_hub.utils.SafetensorsRepoMetadata

< >

( metadata: dict | Nonesharded: boolweight_map: dictfiles_metadata: dict )

Paramètres

  • metadata (dict, facultatif) — Les métadonnées contenues dans le fichier ‘model.safetensors.index.json’, s’il existe. Rempli uniquement pour les modèles fragmentés.
  • sharded (bool) — Indique si le dépôt contient un modèle sharded ou non.
  • weight_map (dict[str, str]) — Une carte de tous les poids. Les clés sont les noms des tenseurs et les valeurs sont les noms des fichiers contenant les tenseurs.
  • files_metadata (dict[str, SafetensorsFileMetadata]) — Une carte de toutes les métadonnées des fichiers. Les clés sont les noms de fichiers et les valeurs sont les métadonnées du fichier correspondant, sous forme d’objet SafetensorsFileMetadata.
  • parameter_count (dict[str, int]) — Une correspondance du nombre de paramètres par type de données. Les clés sont les types de données et les valeurs sont le nombre de paramètres de ce type de données.

Métadonnées pour un dépôt Safetensors.

Un dépôt est considéré comme un dépôt Safetensors s'il contient, à sa racine, soit un fichier de poids model.safetensors (modèle non partagé), soit un fichier d'index model.safetensors.index.json (modèle fragmenté).

Cette classe est retournée par get_safetensors_metadata().

Pour plus de détails sur le format safetensors, consultez https://huggingface.co/docs/safetensors/index#format.

SafetensorsFileMetadata

classe huggingface_hub.utils.SafetensorsFileMetadata

< >

( metadata: dicttensors: dict )

Paramètres

  • metadata (dict) — Les métadonnées contenues dans le fichier.
  • tensors (dict[str, TensorInfo]) — Une carte de tous les tenseurs. Les clés sont les noms des tenseurs et les valeurs sont des informations sur le tenseur correspondant, sous forme d'objet TensorInfo.
  • parameter_count (dict[str, int]) — Une correspondance du nombre de paramètres par type de données. Les clés sont les types de données et les valeurs sont le nombre de paramètres de ce type de données.

Métadonnées d'un fichier Safetensors hébergé sur le Hub.

Cette classe est retournée par parse_safetensors_file_metadata().

Pour plus de détails sur le format safetensors, consultez https://huggingface.co/docs/safetensors/index#format.

SpaceInfo

classe huggingface_hub.SpaceInfo

< >

( **kwargs )

Paramètres

  • id (str) — ID de l'Espace.
  • author (str, facultatif) — Auteur de l'Espace.
  • card_data (SpaceCardData, facultatif) — Métadonnées de la carte de l’espace sous forme d’objet huggingface_hub.repocard_data.SpaceCardData.
  • created_at (datetime, facultatif) — Date de création du dépôt sur le Hub. Notez que la valeur minimale est 2022-03-02T23:29:04.000Z, correspondant à la date à laquelle nous avons commencé à stocker les dates de création.
  • datasets (list[str], facultatif) — Liste des jeux de données utilisés par le Space.
  • disabled (bool, facultatif) — Indique si l'Espace est désactivé.
  • gated (Literal["auto", "manual", False], facultatif) — Indique si le dépôt est protégé. Si oui, précise si l’approbation est manuelle ou automatique.
  • host (str, facultatif) — URL de l'hôte de l'Espace.
  • last_modified (datetime, facultatif) — Date du dernier commit dans le dépôt.
  • likes (int) — Nombre de « j’aime » de l’espace.
  • models (list[str], facultatif) — Liste des modèles utilisés par le Space.
  • private (bool) — Indique si le dépôt est privé.
  • region (Literal["us", "eu"], facultatif) — Région cloud dans laquelle l’espace est stocké.
  • resource_group (dict, facultatif) — Informations sur le groupe de ressources de l'Espace.
  • runtime (SpaceRuntime, facultatif) — Informations sur le runtime de l’espace sous forme d’objet huggingface_hub.hf_api.SpaceRuntime.
  • sdk (str, facultatif) — SDK utilisé par le Space.
  • sha (str, facultatif) — SHA du dépôt à cette révision particulière.
  • siblings (list[RepoSibling]) — Liste d’objets huggingface_hub.hf_api.RepoSibling qui composent le Space.
  • subdomain (str, facultatif) — Sous-domaine de l'Espace.
  • tags (list[str]) — Liste des tags de l'Espace.
  • trending_score (int, facultatif) — Score de tendance de l'Espace.
  • used_storage (int, facultatif) — Taille en octets de l'Espace sur le Hub.

Contient des informations sur un Space du Hub. Cet objet est retourné par space_info() et list_spaces().

La plupart des attributs de cette classe sont optionnels. Cela est dû au fait que les données renvoyées par le Hub dépendent de la requête effectuée. En général, plus la requête est spécifique, plus les informations renvoyées sont nombreuses. À l’inverse, lors de l’énumération des espaces à l’aide de list_spaces(), seul un sous-ensemble des attributs est renvoyé.

SpaceSearchResult

classe huggingface_hub.SpaceSearchResult

< >

( data: dict )

Paramètres

  • id (str) — ID de l'espace (par exemple "username/repo-name").
  • author (str) — Auteur de l'Espace.
  • title (str) — Titre d’affichage de l’espace.
  • emoji (str or None) — Emoji icon of the Space.
  • sdk (str ou None) — SDK utilisé par le Space (par ex. "gradio", "docker", "static").
  • likes (int) — Nombre de « j’aime ».
  • private (bool) — Indique si l'Espace est privé.
  • tags (list[str] ou None) — Liste de balises.
  • runtime (SpaceRuntime ou None) — Informations sur l’environnement d’exécution (étape, matériel, etc.).
  • ai_short_description (str ou None) — Courte description générée par IA.
  • ai_category (str ou None) — Catégorie générée par IA (par exemple "Image Generation").
  • semantic_relevancy_score (float ou None) — Score de pertinence sémantique (0-1) par rapport à la requête de recherche.
  • trending_score (int ou None) — Score de tendance.

Un résultat unique de l'API de recherche sémantique de Spaces.

Retourné par HfApi.search_spaces().

TensorInfo

classe huggingface_hub.utils.TensorInfo

< >

( dtype: typing.Literal['F64', 'F32', 'F16', 'BF16', 'I64', 'I32', 'I16', 'I8', 'U8', 'U3', 'BOOL']shape: listdata_offsets: tuple )

Paramètres

  • dtype (str) — Le type de données du tenseur (« F64 », « F32 », « F16 », « BF16 », « I64 », « I32 », « I16 », « I8 », « U8 », « U3 », « BOOL »).
  • shape (list[int]) — La forme du tenseur.
  • data_offsets (tuple[int, int]) — Les décalages des données dans le fichier, sous forme de tuple [BEGIN, END].
  • parameter_count (int) — Le nombre de paramètres dans le tenseur.

Informations sur un tenseur.

Pour plus de détails sur le format safetensors, consultez https://huggingface.co/docs/safetensors/index#format.

Utilisateur

classe huggingface_hub.User

< >

( **kwargs )

Paramètres

  • username (str) — Nom de l'utilisateur sur le Hub (unique).
  • fullname (str) — Nom complet de l’utilisateur.
  • avatar_url (str) — URL de l’avatar de l’utilisateur.
  • details (str, facultatif) — Détails de l’utilisateur.
  • is_following (bool, facultatif) — Indique si l'utilisateur authentifié suit cet utilisateur.
  • is_pro (bool, facultatif) — Indique si l'utilisateur est un utilisateur pro.
  • num_models (int, facultatif) — Nombre de modèles créés par l'utilisateur.
  • num_datasets (int, facultatif) — Nombre de jeux de données créés par l'utilisateur.
  • num_spaces (int, facultatif) — Nombre d'espaces créés par l'utilisateur.
  • num_discussions (int, facultatif) — Nombre de discussions initiées par l'utilisateur.
  • num_papers (int, facultatif) — Nombre d'articles rédigés par l'utilisateur.
  • num_upvotes (int, facultatif) — Nombre de votes positifs reçus par l'utilisateur.
  • num_likes (int, facultatif) — Nombre de « j’aime » donnés par l’utilisateur.
  • num_following (int, facultatif) — Nombre d'utilisateurs suivis par cet utilisateur.
  • num_followers (int, facultatif) — Nombre d'utilisateurs qui suivent cet utilisateur.
  • orgs (liste de Organization) — Liste des organisations dont l'utilisateur est membre.

Contient des informations sur un utilisateur du Hub.

UserLikes

classe huggingface_hub.UserLikes

< >

( user: strtotal: intdatasets: list[str]kernels: list[str]models: list[str]spaces: list[str] )

Paramètres

  • user (str) — Nom de l'utilisateur pour lequel nous avons récupéré les likes.
  • total (int) — Total number of likes.
  • datasets (list[str]) — Liste des jeux de données aimés par l'utilisateur (sous forme de repo_ids).
  • kernels (list[str]) — Liste des kernels aimés par l'utilisateur (sous forme de repo_ids).
  • models (list[str]) — Liste des modèles aimés par l'utilisateur (sous forme de repo_ids).
  • spaces (list[str]) — Liste des espaces aimés par l'utilisateur (sous forme de repo_ids).

Contient des informations sur les utilisateurs que l'utilisateur a aimés sur le Hub.

WebhookInfo

classe huggingface_hub.WebhookInfo

< >

( id: strurl: str | Nonejob: JobSpec | Nonewatched: list[WebhookWatchedItem]domains: list[constants.WEBHOOK_DOMAIN_T]secret: str | Nonedisabled: bool )

Paramètres

  • id (str) — ID du webhook.
  • url (str, facultatif) — URL du webhook.
  • job (JobSpec, facultatif) — Spécifications du Job à déclencher.
  • watched (list[WebhookWatchedItem]) — Liste des éléments surveillés par le webhook, voir WebhookWatchedItem.
  • domains (list[WEBHOOK_DOMAIN_T]) — Liste des domaines surveillés par le webhook. Peut être l'un des éléments de ["repo", "discussion"].
  • secret (str, facultatif) — Secret du webhook.
  • disabled (bool) — Indique si le webhook est désactivé ou non.

Structure de données contenant des informations sur un webhook.

L'un des paramètres url ou job est spécifié, mais pas les deux.

WebhookWatchedItem

classe huggingface_hub.WebhookWatchedItem

< >

( type: Literal['bucket', 'dataset', 'model', 'org', 'space', 'user']name: str )

Paramètres

  • type (Literal["bucket", "dataset", "model", "org", "space", "user"]) — Type de l'élément à surveiller. Peut être l'un des éléments de ["bucket", "dataset", "model", "org", "space", "user"].
  • name (str) — Nom de l’élément à surveiller. Peut être le nom d’utilisateur, le nom de l’organisation, le nom du modèle, le nom du jeu de données, le nom de l’espace ou le nom du bucket.

Structure de données contenant des informations sur les éléments surveillés par un webhook.

CommitOperation

Voici les valeurs prises en charge pour CommitOperation() :

classe huggingface_hub.CommitOperationAdd

< >

( path_in_repo: strpath_or_fileobj: str | pathlib.Path | bytes | typing.BinaryIO )

Paramètres

  • path_in_repo (str) — Chemin de fichier relatif dans le dépôt, par exemple : "checkpoints/1fec34a/weights.bin"
  • path_or_fileobj (str, Path, bytes, ou BinaryIO) — Soit :
    • un chemin vers un fichier local (en tant que str ou pathlib.Path) à téléverser
    • un tampon d'octets (bytes) contenant le contenu du fichier à téléverser
    • un « objet fichier » (sous-classe de io.BufferedIOBase), généralement obtenu avec open(path, "rb"). Il doit prendre en charge les méthodes seek() et tell().

Lève

ValueError

  • ValueError — Si path_or_fileobj n'est pas de type str, Path, bytes ou io.BufferedIOBase.
  • ValueError — Si path_or_fileobj est un str ou un Path mais ne correspond pas à un fichier existant.
  • ValueError — Si path_or_fileobj est un io.BufferedIOBase mais qu’il ne prend pas en charge à la fois seek() et tell().

Structure de données contenant les informations nécessaires pour téléverser un fichier dans un dépôt sur le Hub.

as_file

< >

( with_tqdm: bool = False )

Paramètres

  • with_tqdm (bool, facultatif, par défaut False) — Si True, l’itération sur l’objet fichier affiche une barre de progression. Ne fonctionne que si l’objet de type fichier est un chemin vers un fichier. Les octets purs et les tampons ne sont pas pris en charge.

Un gestionnaire de contexte qui renvoie un objet de type fichier permettant de lire les données sous-jacentes derrière path_or_fileobj.

Exemple :

>>> operation = CommitOperationAdd(
...        path_in_repo="remote/dir/weights.h5",
...        path_or_fileobj="./local/weights.h5",
... )
CommitOperationAdd(path_in_repo='remote/dir/weights.h5', path_or_fileobj='./local/weights.h5')

>>> with operation.as_file() as file:
...     content = file.read()

>>> with operation.as_file(with_tqdm=True) as file:
...     while True:
...         data = file.read(1024)
...         if not data:
...              break
config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s]

>>> with operation.as_file(with_tqdm=True) as file:
...     httpx2.put(..., data=file)
config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s]

b64content

< >

( )

Le contenu encodé en base64 de path_or_fileobj

Retourne : bytes

classe huggingface_hub.CommitOperationDelete

< >

( path_in_repo: stris_folder: typing.Union[bool, typing.Literal['auto']] = 'auto' )

Paramètres

  • path_in_repo (str) — Chemin de fichier relatif dans le dépôt, par exemple : "checkpoints/1fec34a/weights.bin" pour un fichier ou "checkpoints/1fec34a/" pour un dossier.
  • is_folder (bool ou Literal["auto"], facultatif) — Indique si l'opération de suppression s'applique à un dossier ou non. Si la valeur est « auto », le type de chemin (fichier ou dossier) est deviné automatiquement en vérifiant si le chemin se termine par un « / » (dossier) ou non (fichier). Pour définir explicitement le type de chemin, vous pouvez définir is_folder=True ou is_folder=False.

Structure de données contenant les informations nécessaires pour supprimer un fichier ou un dossier d'un dépôt sur le Hub.

classe huggingface_hub.CommitOperationCopy

< >

( src_path_in_repo: strpath_in_repo: strsrc_revision: str | None = Nonesrc_repo_id: str | None = Nonesrc_repo_type: str | None = None_src_oid: str | None = None_dest_oid: str | None = None_is_duplicated: bool = False )

Paramètres

  • src_path_in_repo (str) — Chemin relatif dans le dépôt du fichier à copier, par exemple "checkpoints/1fec34a/weights.bin".
  • path_in_repo (str) — Chemin de fichier relatif dans le dépôt où copier le fichier, par exemple "checkpoints/1fec34a/weights_copy.bin".
  • src_revision (str, facultatif) — La révision git du fichier à copier. Peut être n’importe quelle révision git valide. Par défaut, la révision du commit cible.
  • src_repo_id (str, facultatif) — Le dépôt source à copier (par ex. "username/source-model"). Par défaut, le dépôt de destination (copie intra-dépôt).
  • src_repo_type (str, facultatif) — Le type du dépôt source ("model", "dataset" ou "space"). Requis lorsque src_repo_id est défini.

Structure de données contenant les informations nécessaires pour copier un fichier dans un dépôt sur le Hub.

Les fichiers LFS et les fichiers classiques sont pris en charge. Les fichiers LFS sont copiés côté serveur, tandis que les fichiers classiques sont téléchargés puis réenvoyés dans le cadre de l'engagement.

Les copies inter-dépôts sont prises en charge en définissant src_repo_id et src_repo_type. Pour les copies LFS inter-dépôts, les objets LFS sont dupliqués dans le dépôt de destination avant la création du commit. Cela est géré automatiquement par create_commit(). Notez que les copies inter-dépôts ne fonctionnent que dans la même zone de stockage ; la copie entre zones n'est pas prise en charge.

Note : vous pouvez combiner un CommitOperationCopy et un CommitOperationDelete pour renommer un fichier LFS sur le Hub.

CommitScheduler

classe huggingface_hub.CommitScheduler

< >

( repo_id: strfolder_path: str | pathlib.Pathevery: int | float = 5path_in_repo: str | None = Nonerepo_type: str | None = Nonerevision: str | None = Noneprivate: bool | None = Nonetoken: str | None = Noneallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonesquash_history: bool = Falsehf_api: typing.Optional[ForwardRef('HfApi')] = None )

Paramètres

  • repo_id (str) — L’identifiant du dépôt à commiter.
  • folder_path (str ou Path) — Chemin vers le dossier local à téléverser régulièrement.
  • every (int ou float, facultatif) — Le nombre de minutes entre chaque commit. La valeur par défaut est de 5 minutes.
  • path_in_repo (str, facultatif) — Chemin relatif du répertoire dans le dépôt, par exemple : "checkpoints/". Par défaut, le dossier racine du dépôt est utilisé.
  • repo_type (str, facultatif) — Le type de dépôt auquel effectuer l’engagement. La valeur par défaut est model.
  • revision (str, facultatif) — La révision du dépôt à laquelle effectuer le commit. Par défaut, main.
  • private (bool, facultatif) — Indique s'il faut rendre le dépôt privé. Si None (par défaut), le dépôt sera public sauf si le paramètre par défaut de l'organisation est privé. Cette valeur est ignorée si le dépôt existe déjà.
  • token (str, facultatif) — Le jeton à utiliser pour committer dans le dépôt. Par défaut, le jeton enregistré sur la machine est utilisé.
  • allow_patterns (list[str] ou str, facultatif) — Si fourni, seuls les fichiers correspondant à au moins un motif sont téléversés.
  • ignore_patterns (list[str] ou str, facultatif) — Si fourni, les fichiers correspondant à l’un des motifs ne sont pas téléversés.
  • squash_history (bool, facultatif) — Indique s'il faut écraser l'historique du dépôt après chaque commit. La valeur par défaut est False. L'écrasement des commits est utile pour éviter une dégradation des performances du dépôt lorsqu'il devient trop volumineux.
  • hf_api (HfApi, facultatif) — Le client HfApi à utiliser pour commiter sur le Hub. Peut être configuré avec des paramètres personnalisés (user agent, token,…).

Planificateur pour téléverser un dossier local sur le Hub à intervalles réguliers (par exemple, pousser vers le hub toutes les 5 minutes).

La méthode recommandée pour utiliser le planificateur est de l’employer en tant que gestionnaire de contexte. Cela garantit que le planificateur est correctement arrêté et que le dernier commit est déclenché à la fin du script. Le planificateur peut également être arrêté manuellement à l’aide de la méthode stop. Consultez le guide de téléversement pour en savoir plus sur son utilisation.

Exemple :

>>> from pathlib import Path
>>> from huggingface_hub import CommitScheduler

# Scheduler uploads every 10 minutes
>>> csv_path = Path("watched_folder/data.csv")
>>> CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path=csv_path.parent, every=10)

>>> with csv_path.open("a") as f:
...     f.write("first line")

# Some time later (...)
>>> with csv_path.open("a") as f:
...     f.write("second line")

Exemple utilisant un gestionnaire de contexte :

>>> from pathlib import Path
>>> from huggingface_hub import CommitScheduler

>>> with CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path="watched_folder", every=10) as scheduler:
...     csv_path = Path("watched_folder/data.csv")
...     with csv_path.open("a") as f:
...         f.write("first line")
...     (...)
...     with csv_path.open("a") as f:
...         f.write("second line")

# Scheduler is now stopped and last commit have been triggered

push_to_hub

< >

( )

Poussez le dossier vers le Hub et renvoyez les informations de commit.

Cette méthode n'est pas destinée à être appelée directement. Elle est exécutée en arrière-plan par le planificateur, en respectant un mécanisme de file d'attente pour éviter les engagements simultanés. Un appel direct à la méthode pourrait entraîner des problèmes de concurrence.

Le comportement par défaut de push_to_hub est de considérer le dossier comme étant en mode ajout uniquement. Il liste tous les fichiers du dossier et ne téléverse que les fichiers modifiés. Si aucune modification n'est détectée, la méthode se termine sans rien commettre. Si vous souhaitez modifier ce comportement, vous pouvez hériter de CommitScheduler et redéfinir cette méthode. Cela peut être utile, par exemple, pour compresser les données ensemble dans un seul fichier avant la commutation. Pour plus de détails et d'exemples, consultez notre guide d'intégration.

stop

< >

( )

Arrêtez le planificateur.

Un planificateur arrêté ne peut pas être redémarré. Principalement à des fins de tests.

déclencheur

< >

( )

Déclencher un push_to_hub et retourner un futur.

Cette méthode est appelée automatiquement toutes les every minutes. Vous pouvez également l’appeler manuellement pour déclencher un commit immédiatement, sans attendre le commit planifié suivant.

Update on GitHub

←Variables d'environnement CLI→