Hub Python 庫文件
身份驗證
並獲得增強的文件體驗
開始使用
認證
該 huggingface_hub 庫允許使用者以程式設計方式管理 Hub 的認證。這包括登入、登出、切換令牌以及列出可用令牌。
有關身份驗證的更多詳細資訊，請檢視此部分。
login
huggingface_hub.login
< source >( token: typing.Optional[str] = None add_to_git_credential: bool = False skip_if_logged_in: bool = False )
引數
- token (
str, optional) — 用於生成使用者的訪問令牌，來自 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, 預設為False) — 如果為True，則在使用者已登入時不會提示輸入令牌。
引發
ValueError 或 ImportError
ValueError— 如果傳遞了組織令牌。只有個人賬戶令牌才能登入。ValueError— 如果令牌無效。ImportError— 如果在 notebook 中執行但未安裝ipywidgets。
登入機器以訪問 Hub。
token 會持久化在快取中並設定為 git 憑證。完成後，機器將登入，並且訪問令牌將可用於所有 huggingface_hub 元件。如果未提供 token，則會透過小部件（在 notebook 中）或透過終端提示使用者。
要從指令碼外部登入，還可以使用 hf auth login，這是一個包裝了 login() 的 cli 命令。
[!TIP]login() 是 notebook_login() 的一個即插即用替換方法，因為它包裝並擴充套件了其功能。
當未傳遞令牌時，login() 會自動檢測指令碼是否在 notebook 中執行。但是，由於當今 notebook 的多樣性，此檢測可能不準確。在這種情況下，您始終可以使用 notebook_login() 或 interpreter_login() 來強制使用 UI。
interpreter_login
huggingface_hub.interpreter_login
< source >( skip_if_logged_in: bool = False )
顯示一個提示，用於登入 HF 網站並存儲令牌。
這等同於在 notebook 中執行時不傳遞令牌的 login()。如果您想強制使用終端提示而不是 notebook 小部件，interpreter_login() 會很有用。
有關更多詳細資訊，請參閱 login()。
notebook_login
huggingface_hub.notebook_login
< source >( skip_if_logged_in: bool = False )
顯示一個用於登入 HF 網站並存儲令牌的小部件。
這等同於在 notebook 中執行時不傳遞令牌的 login()。如果您想強制使用 notebook 小部件而不是終端中的提示，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，令牌將被設定為 git 憑證。如果未配置 git 憑證助手，將向用戶顯示警告。如果token為None，add_to_git_credential的值將被忽略，並且將再次提示終端使用者。
引發
ValueError
ValueError— 如果找不到訪問令牌名稱。
切換到不同的訪問令牌。
auth_list
列出所有已儲存的訪問令牌。