Hugging Face's logo

Hub Python Library documentation

Authentification

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Authentification

La bibliothèque huggingface_hub permet aux utilisateurs de gérer l’authentification vers le Hub de manière programmatique. Cela inclut la connexion, la déconnexion, le changement entre jetons et l’affichage des jetons disponibles.

Pour plus de détails sur l'authentification, consultez cette section.

login

huggingface_hub.login

< >

( token: str | None = Noneadd_to_git_credential: bool = Falseskip_if_logged_in: bool = True )

Paramètres

  • token (str, facultatif) — Jeton d'accès utilisateur à générer depuis https://huggingface.co/settings/token.
  • add_to_git_credential (bool, par défaut False) — Si True, le jeton est défini comme identifiant git. Si aucun assistant d’identifiants git n’est configuré, un avertissement est affiché à l’utilisateur. Utilisé uniquement lorsque token est fourni ; ignoré par le flux basé sur le navigateur.
  • skip_if_logged_in (bool, par défaut True) — Si True, ne demande pas de jeton si l’utilisateur est déjà connecté. Définissez False pour forcer la reconnexion. En CLI, utilisez --force à la place.

Lève

ValueError ou DeviceCodeError

  • ValueError — Si un jeton d’organisation est transmis. Seuls les jetons de compte personnel sont valides pour la connexion.
  • ValueError — Si le jeton est invalide.
  • DeviceCodeError — Si la connexion via le navigateur échoue (autorisation refusée, code expiré, …).

Connectez la machine pour accéder au Hub.

Le token est persisté dans le cache et défini comme une authentification git. Une fois terminé, la machine est connectée et le jeton d’accès sera disponible dans tous les composants de huggingface_hub. Si token n’est pas fourni, un flux OAuth basé sur le navigateur est utilisé pour l’authentification : ouvrir une URL, saisir un code court, puis le jeton est récupéré et enregistré. Dans un terminal, vous pouvez également choisir de coller un jeton d’accès existant à la place.

Pour se connecter en dehors d'un script, on peut également utiliser hf auth login, qui est une commande cli encapsulant login().

Lorsque le jeton n’est pas transmis, login() détecte automatiquement si le script s’exécute dans un notebook ou non. Toutefois, cette détection peut s’avérer imprécise en raison de la variété des notebooks existants aujourd’hui. Dans ce cas, vous pouvez toujours forcer l’interface utilisateur en utilisant notebook_login() ou interpreter_login().

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

Paramètres

  • skip_if_logged_in (bool, par défaut True) — Si True, ne demande pas de jeton si l’utilisateur est déjà connecté. Définissez False pour forcer la reconnexion. En CLI, utilisez --force à la place.

Affiche une invite pour se connecter au site Web HF et stocker le jeton.

Cela équivaut à login() sans passer de jeton lorsqu’il n’est pas exécuté dans un notebook. interpreter_login() est utile si vous souhaitez forcer l’utilisation du prompt du terminal au lieu d’un flux notebook.

Pour plus de détails, voir login().

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

Paramètres

  • skip_if_logged_in (bool, par défaut True) — Si True, ne demande pas de jeton si l’utilisateur est déjà connecté. Définissez False pour forcer la reconnexion. En CLI, utilisez --force à la place.

Affiche une invite pour se connecter au site Web HF et stocker le jeton.

Cela équivaut à login() sans passer de jeton lorsqu’il est exécuté dans un notebook. notebook_login() est utile si vous souhaitez forcer l’utilisation du flux notebook plutôt qu’un prompt dans le terminal.

Pour plus de détails, voir login().

Se déconnecter

huggingface_hub.logout

< >

( token_name: str | None = None )

Paramètres

  • token_name (str, facultatif) — Nom du jeton d’accès pour lequel effectuer la déconnexion. Si None, la déconnexion s’appliquera à tous les jetons d’accès enregistrés.

Lève

ValueError

  • ValueError — Si le nom du jeton d'accès n'est pas trouvé.

Déconnectez la machine du Hub.

Le jeton est supprimé de la machine et retiré des identifiants git.

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

Paramètres

  • token_name (str) — Nom du jeton d'accès vers lequel basculer.
  • add_to_git_credential (bool, par défaut False) — Si True, le jeton est défini comme identifiant git. Si aucun assistant d’identifiants git n’est configuré, un avertissement est affiché à l’utilisateur. Si token est None, la valeur de add_to_git_credential est ignorée et l’utilisateur final est à nouveau invité à la saisir.

Lève

ValueError

  • ValueError — Si le nom du jeton d'accès n'est pas trouvé.

Passer à un jeton d'accès différent.

auth_list

huggingface_hub.auth_list

< >

( )

Liste tous les jetons d'accès stockés.

Update on GitHub

←Aperçu Variables d'environnement→