Hub Python 庫文件
身份驗證
並獲得增強的文件體驗
開始使用
身份驗證
huggingface_hub 庫允許使用者以程式設計方式管理 Hub 的身份驗證。這包括登入、登出、切換令牌和列出可用令牌。
有關身份驗證的更多詳細資訊，請檢視此部分。
登入
huggingface_hub.login
< 源 >( 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，則會透過小部件（在筆記本中）或透過終端提示使用者。
要從指令碼外部登入，也可以使用 hf auth login，這是一個包裝了 login() 的 CLI 命令。
login() 是 notebook_login() 的替代方法，因為它包裝並擴充套件了其功能。
當未傳入令牌時，login() 將自動檢測指令碼是否在筆記本中執行。然而，由於當今存在的各種筆記本，此檢測可能不準確。在這種情況下，您始終可以使用 notebook_login() 或 interpreter_login() 強制使用 UI。
直譯器登入
huggingface_hub.interpreter_login
< 源 >( new_session: bool = True write_permission: bool = False )
顯示提示以登入 HF 網站並存儲令牌。
這等效於未在筆記本中執行時不傳入令牌的 login()。interpreter_login() 在您想要強制使用終端提示而不是筆記本小部件時很有用。
有關更多詳細資訊，請參閱 login()。
notebook_login
huggingface_hub.notebook_login
< 源 >( new_session: bool = True write_permission: bool = False )
顯示小部件以登入 HF 網站並存儲令牌。
這等效於在筆記本中執行時不傳入令牌的 login()。notebook_login() 在您想要強制使用筆記本小部件而不是終端提示時很有用。
有關更多詳細資訊，請參閱 login()。
登出
huggingface_hub.logout
< 源 >( token_name: typing.Optional[str] = None )
將機器從 Hub 登出。
令牌將從機器中刪除，並從 git 憑據中移除。
auth_switch
huggingface_hub.auth_switch
< 源 >( token_name: str add_to_git_credential: bool = False )
引數
- token_name (
str) — 要切換到的訪問令牌的名稱。 - add_to_git_credential (
bool, 預設為False) — 如果為True，則會將令牌設定為 git 憑據。如果未配置 git 憑據助手，則會向用戶顯示警告。如果token為None，則add_to_git_credential的值將被忽略，並再次提示終端使用者。
引發
ValueError
ValueError— 如果找不到訪問令牌名稱。
切換到不同的訪問令牌。
auth_list
列出所有已儲存的訪問令牌。