Hugging Face's logo

Hub Python Library documentation

Autenticación

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Autenticación

La biblioteca huggingface_hub permite a los usuarios gestionar la autenticación en el Hub de forma programática. Esto incluye iniciar sesión, cerrar sesión, cambiar entre tokens y listar los tokens disponibles.

Para más detalles sobre la autenticación, consulte esta sección.

login

huggingface_hub.login

< >

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

Parámetros

  • token (str, opcional) — Token de acceso del usuario para generar desde https://huggingface.co/settings/token.
  • add_to_git_credential (bool, por defecto False) — Si es True, el token se configurará como credencial de git. Si no hay ningún helper de credenciales de git configurado, se mostrará una advertencia al usuario. Solo se utiliza cuando se proporciona token; se ignora en el flujo basado en el navegador.
  • skip_if_logged_in (bool, por defecto True) — Si es True, no se solicita un token si el usuario ya ha iniciado sesión. Establezca False para forzar un nuevo inicio de sesión. En la CLI, use --force en su lugar.

Lanza

ValueError o DeviceCodeError

  • ValueError — Si se pasa un token de organización. Solo los tokens de cuenta personal son válidos para iniciar sesión.
  • ValueError — Si el token no es válido.
  • DeviceCodeError — Si el inicio de sesión basado en el navegador falla (autorización denegada, código expirado, …).

Inicia sesión en la máquina para acceder al Hub.

El token se persiste en la caché y se configura como una credencial de git. Una vez completado, la máquina queda iniciada sesión y el token de acceso estará disponible en todos los componentes de huggingface_hub. Si no se proporciona token, se utiliza un flujo de OAuth basado en navegador para autenticarse: se abre una URL, se introduce un código corto y el token se recupera y guarda. En una terminal, también puedes optar por pegar un token de acceso existente.

Para iniciar sesión desde fuera de un script, también se puede usar hf auth login, que es un comando de línea de comandos que envuelve a login().

Cuando no se pasa el token, login() detecta automáticamente si el script se ejecuta en un cuaderno o no. Sin embargo, esta detección puede no ser precisa debido a la variedad de cuadernos que existen actualmente. En ese caso, siempre puedes forzar la interfaz de usuario usando notebook_login() o interpreter_login().

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

Parámetros

  • skip_if_logged_in (bool, por defecto True) — Si es True, no se solicita un token si el usuario ya ha iniciado sesión. Establezca False para forzar un nuevo inicio de sesión. En la CLI, use --force en su lugar.

Muestra un mensaje para iniciar sesión en el sitio web de HF y almacenar el token.

Esto es equivalente a login() sin pasar un token cuando no se ejecuta en un notebook. interpreter_login() es útil si deseas forzar el uso del prompt de terminal en lugar de un flujo de notebook.

Para más detalles, consulte login().

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

Parámetros

  • skip_if_logged_in (bool, por defecto True) — Si es True, no se solicita un token si el usuario ya ha iniciado sesión. Establezca False para forzar un nuevo inicio de sesión. En la CLI, use --force en su lugar.

Muestra un mensaje para iniciar sesión en el sitio web de HF y almacenar el token.

Esto es equivalente a login() sin pasar un token cuando se ejecuta en un notebook. notebook_login() es útil si deseas forzar el uso del flujo de notebook en lugar de un prompt en la terminal.

Para más detalles, consulte login().

logout

huggingface_hub.logout

< >

( token_name: str | None = None )

Parámetros

  • token_name (str, opcional) — Nombre del token de acceso del que se desea cerrar la sesión. Si es None, se cerrará la sesión de todos los tokens de acceso guardados.

Lanza

ValueError

  • ValueError — Si no se encuentra el nombre del token de acceso.

Desconecta la máquina del Hub.

El token se elimina de la máquina y se retira de git credential.

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

Parámetros

  • token_name (str) — Nombre del token de acceso al que cambiar.
  • add_to_git_credential (bool, valor predeterminado False) — Si True, el token se establecerá como credencial de git. Si no hay ningún helper de credenciales de git configurado, se mostrará una advertencia al usuario. Si token es None, el valor de add_to_git_credential se ignora y se solicitará nuevamente al usuario final.

Lanza

ValueError

  • ValueError — Si no se encuentra el nombre del token de acceso.

Cambiar a un token de acceso diferente.

auth_list

huggingface_hub.auth_list

< >

( )

Listar todos los tokens de acceso almacenados.

Update on GitHub

←Resumen Variables de entorno→