Hugging Face's logo

Hub Python Library documentation

Autenticação

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

Autenticação

A biblioteca huggingface_hub permite que os usuários gerenciem programaticamente a autenticação no Hub. Isso inclui fazer login, fazer logout, alternar entre tokens e listar os tokens disponíveis.

Para mais detalhes sobre autenticação, consulte esta seção.

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 acesso do usuário para gerar em https://huggingface.co/settings/token.
  • add_to_git_credential (bool, padrão False) — Se True, o token será definido como credencial do git. Se nenhum helper de credencial do git estiver configurado, um aviso será exibido ao usuário. Usado apenas quando token é fornecido; ignorado pelo fluxo baseado em navegador.
  • skip_if_logged_in (bool, padrão True) — Se True, não solicita o token se o usuário já estiver conectado. Defina como False para forçar o relogin. Na CLI, use --force em vez disso.

Exceções

ValueError ou DeviceCodeError

  • ValueError — Se um token de organização for passado. Apenas tokens de conta pessoal são válidos para fazer login.
  • ValueError — Se o token for inválido.
  • DeviceCodeError — Se o login baseado em navegador falhar (autorização negada, código expirado, …).

Faça login na máquina para acessar o Hub.

O token é persistido no cache e definido como uma credencial do git. Concluído isso, a máquina fica conectada e o token de acesso estará disponível em todos os componentes do huggingface_hub. Se token não for fornecido, um fluxo OAuth baseado em navegador é usado para autenticar: abra uma URL, insira um código curto e o token será recuperado e salvo. Em um terminal, você também pode optar por colar um token de acesso existente.

Para fazer login fora de um script, também é possível usar hf auth login, que é um comando de cli que encapsula login().

Quando o token não é passado, login() detecta automaticamente se o script está sendo executado em um notebook ou não. No entanto, essa detecção pode não ser precisa devido à variedade de notebooks existentes atualmente. Nesse caso, você pode sempre forçar a interface usando notebook_login() ou interpreter_login().

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

Parâmetros

  • skip_if_logged_in (bool, padrão True) — Se True, não solicita o token se o usuário já estiver conectado. Defina como False para forçar o relogin. Na CLI, use --force em vez disso.

Exibe um prompt para fazer login no site do HF e armazenar o token.

Isso é equivalente a login() sem passar um token quando não executado em um notebook. interpreter_login() é útil se você quiser forçar o uso do prompt do terminal em vez de um fluxo de notebook.

Para mais detalhes, consulte login().

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

Parâmetros

  • skip_if_logged_in (bool, padrão True) — Se True, não solicita o token se o usuário já estiver conectado. Defina como False para forçar o relogin. Na CLI, use --force em vez disso.

Exibe um prompt para fazer login no site do HF e armazenar o token.

Isso é equivalente a login() sem passar um token quando executado em um notebook. notebook_login() é útil se você quiser forçar o uso do fluxo de notebook em vez de um prompt no terminal.

Para mais detalhes, consulte login().

logout

huggingface_hub.logout

< >

( token_name: str | None = None )

Parâmetros

  • token_name (str, opcional) — Nome do token de acesso do qual se deseja fazer logout. Se None, fará logout de todos os tokens de acesso salvos.

Exceções

ValueError

  • ValueError — Se o nome do token de acesso não for encontrado.

Desconecte a máquina do Hub.

O token é excluído da máquina e removido do git credential.

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

Parâmetros

  • token_name (str) — Nome do token de acesso para o qual alternar.
  • add_to_git_credential (bool, padrão False) — Se True, o token será definido como credencial do git. Se nenhum helper de credencial do git estiver configurado, um aviso será exibido ao usuário. Se token for None, o valor de add_to_git_credential será ignorado e o usuário final será solicitado novamente.

Exceções

ValueError

  • ValueError — Se o nome do token de acesso não for encontrado.

Alterne para um token de acesso diferente.

auth_list

huggingface_hub.auth_list

< >

( )

Liste todos os tokens de acesso armazenados.

Update on GitHub

←Visão geral Variáveis de ambiente→