Hub Python 函式庫文件
身份驗證
並獲得增強的文件體驗
開始使用
身份驗證
huggingface_hub 程式庫允許使用者以程式化方式管理 Hub 的身份驗證。這包括登入、登出、在不同權杖（token）之間切換，以及列出可用的權杖。
如需更多關於身份驗證的詳細資訊，請參閱此章節。
login
huggingface_hub.login
< 原始碼 >( token: str | None = None add_to_git_credential: bool = False skip_if_logged_in: bool = True )
參數
- token (
str, 選擇性) — 可從 https://huggingface.co/settings/token 產生的使用者存取權杖。 - add_to_git_credential (
bool, 預設為False) — 若設為True，權杖將被設定為 git 憑證。如果未配置 git 憑證輔助工具，系統會向使用者顯示警告。若token為None，則忽略add_to_git_credential的值，並會再次向終端使用者請求輸入。 - skip_if_logged_in (
bool, 預設為True) — 若設為True，且使用者已登入，則不會提示輸入權杖。設為False可強制重新登入。在 CLI 中，請改用--force。
引發
ValueError 或 ImportError
ValueError— 若傳入組織權杖。僅個人帳戶權杖可用於登入。ValueError— 若權杖無效。ImportError— 若在筆記本中執行但未安裝ipywidgets。
將機器登入以存取 Hub。
token 會被保存在快取中並設定為 git 憑證。完成後，機器即完成登入，且該存取權杖將可用於所有 huggingface_hub 元件。若未提供 token，系統會透過視窗（在筆記本中）或終端機提示使用者輸入。
若要從指令碼外部登入，也可以使用 hf auth login，這是一個封裝了 login() 的 CLI 指令。
[!TIP]login() 是 notebook_login() 的直接替代方法，因為它封裝並擴展了其功能。
當未傳遞權杖時，login() 會自動偵測指令碼是否在筆記本中執行。然而，由於現今筆記本類型繁多，此偵測可能不夠準確。若是這種情況，您可以隨時使用 notebook_login() 或 interpreter_login() 來強制使用 UI。
interpreter_login
huggingface_hub.interpreter_login
< 原始碼 >( skip_if_logged_in: bool = True )
顯示登入 HF 網站並儲存權杖的提示。
這等同於在非筆記本環境中執行且未傳遞權杖的 login()。如果您想強制使用終端機提示而非筆記本視窗，interpreter_login() 會非常有用。
詳情請參閱 login()。
notebook_login
huggingface_hub.notebook_login
< 原始碼 >( skip_if_logged_in: bool = True )
顯示一個用於登入 HF 網站並儲存權杖的視窗。
這等同於在筆記本中執行且未傳遞權杖的 login()。如果您想強制使用筆記本視窗而非終端機提示，notebook_login() 會非常有用。
詳情請參閱 login()。
logout
huggingface_hub.logout
< 原始碼 >( token_name: str | None = 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
列出所有已儲存的存取權杖。