Hub Python 库文档
身份验证
并获得增强的文档体验
开始使用
身份验证
huggingface_hub 库允许用户以编程方式管理 Hub 的身份验证。这包括登录、注销、在令牌之间切换以及列出可用令牌。
有关身份验证的更多详细信息，请查看此部分。
login
huggingface_hub.login
< source >( token: typing.Optional[str] = None add_to_git_credential: bool = False new_session: bool = True write_permission: bool = False )
参数
- token (
str, 可选) — 从 https://huggingface.co/settings/token 生成的用户访问令牌。 - add_to_git_credential (
bool, 默认为False) — 如果为True，令牌将设置为 git 凭据。如果未配置 git 凭据助手，将向用户显示警告。如果token为None，则add_to_git_credential的值将被忽略，并将再次提示最终用户。 - new_session (
bool, 默认为True) — 如果为True，即使机器上已保存令牌，也会请求令牌。 - write_permission (
bool) — 已忽略和弃用的参数。
引发
ValueError 或 ImportError
ValueError— 如果传递了组织令牌。只有个人帐户令牌才能有效登录。ValueError— 如果令牌无效。ImportError— 如果在笔记本中运行，但未安装ipywidgets。
登录机器以访问 Hub。
token 持久保存在缓存中，并设置为 git 凭据。完成后，机器将登录，并且访问令牌将在所有 huggingface_hub 组件中可用。如果未提供 token，将通过小部件（在笔记本中）或通过终端提示用户。
要从脚本外部登录，还可以使用 huggingface-cli login，这是一个包装 login() 的 cli 命令。
login() 是 notebook_login() 的直接替代方法，因为它包装并扩展了其功能。
当未传递令牌时，login() 将自动检测脚本是否在笔记本中运行。但是，由于现在存在的笔记本种类繁多，因此这种检测可能不准确。如果是这种情况，您可以始终使用 notebook_login() 或 interpreter_login() 来强制使用 UI。
interpreter_login
huggingface_hub.interpreter_login
< source >( new_session: bool = True write_permission: bool = False )
显示一个提示，以登录到 HF 网站并存储令牌。
这等效于在非笔记本中运行时，不传递令牌的 login()。interpreter_login() 在您想要强制使用终端提示而不是笔记本小部件时很有用。
有关更多详细信息，请参阅 login()。
notebook_login
huggingface_hub.notebook_login
< source >( new_session: bool = True write_permission: bool = False )
显示一个小部件，以登录到 HF 网站并存储令牌。
这等效于在笔记本中运行时，不传递令牌的 login()。notebook_login() 在您想要强制使用笔记本小部件而不是终端中的提示时很有用。
有关更多详细信息，请参阅 login()。
logout
huggingface_hub.logout
< source >( token_name: typing.Optional[str] = None )
将机器从 Hub 注销。
令牌将从机器中删除，并从 git 凭据中移除。
auth_switch
huggingface_hub.auth_switch
< source >( token_name: str add_to_git_credential: bool = False )
参数
- token_name (
str) — 要切换到的访问令牌的名称。 - add_to_git_credential (
bool, 默认为False) — 如果为True，token 将被设置为 git 凭据。如果未配置 git 凭据助手，将向用户显示警告。如果token为None，则add_to_git_credential的值将被忽略，并将再次提示最终用户。
引发
ValueError
ValueError— 如果找不到访问令牌名称。
切换到不同的访问令牌。
auth_list
列出所有已存储的访问令牌。