Hugging Face's logo

Hub Python Library documentation

認証

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

認証

huggingface_hub ライブラリを使用すると、ユーザーは Hub への認証をプログラムで管理できます。これには、ログイン、ログアウト、トークンの切り替え、利用可能なトークンの一覧表示が含まれます。

認証の詳細については、このセクションを参照してください。

ログイン

huggingface_hub.login

< >

( token: str | None = Noneadd_to_git_credential: bool = Falseskip_if_logged_in: bool = True )

パラメータ

  • token (str, 任意) — https://huggingface.co/settings/token から生成するユーザーアクセストークン。
  • add_to_git_credential (bool、デフォルトはFalse) — Trueの場合、トークンはgit credentialとして設定されます。git credential helperが設定されていない場合、ユーザーに警告が表示されます。tokenが提供された場合のみ使用され、ブラウザベースのフローでは無視されます。
  • skip_if_logged_in (bool、デフォルトはTrue) — Trueの場合、ユーザーがすでにログイン済みの場合はトークンの入力を求めません。 Falseに設定すると、再ログインを強制します。CLIでは代わりに--forceを使用してください。

例外

ValueError または DeviceCodeError

  • ValueError — 組織トークンが渡された場合。ログインには個人アカウントのトークンのみ有効です。
  • ValueError — トークンが無効な場合。
  • DeviceCodeError — ブラウザベースのログインが失敗した場合（認可が拒否された、コードの有効期限が切れた、など）。

Hubにアクセスするには、マシンにログインします。

token はキャッシュに永続化され、git の認証情報として設定されます。完了すると、マシンがログイン状態になり、アクセストークンはすべての huggingface_hub コンポーネントで利用可能になります。token が指定されていない場合、ブラウザベースの OAuth フローを使用して認証が行われます。URL を開き、短いコードを入力すると、トークンが取得されて保存されます。ターミナルでは、既存のアクセストークンを貼り付けることも選択できます。

スクリプトの外からログインするには、login()をラップしたCLIコマンドであるhf auth loginを使用することもできます。

トークンが渡されない場合、login()はスクリプトがノートブック内で実行されているかどうかを自動的に検出します。ただし、現在存在するノートブックの多様性により、この検出が正確でない場合があります。その場合は、notebook_login()またはinterpreter_login()を使用してUIを強制指定できます。

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

パラメータ

  • skip_if_logged_in (bool、デフォルトはTrue) — Trueの場合、ユーザーがすでにログイン済みの場合はトークンの入力を求めません。 Falseに設定すると、再ログインを強制します。CLIでは代わりに--forceを使用してください。

HFウェブサイトへのログインを促すプロンプトを表示し、トークンを保存します。

ノートブック外で実行される場合、トークンを渡さずに login() を呼び出すことと同等です。ノートブックのフローではなく、ターミナルのプロンプトの使用を強制したい場合に interpreter_login() が役立ちます。

詳細については、login()を参照してください。

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

パラメータ

  • skip_if_logged_in (bool、デフォルトはTrue) — Trueの場合、ユーザーがすでにログイン済みの場合はトークンの入力を求めません。 Falseに設定すると、再ログインを強制します。CLIでは代わりに--forceを使用してください。

HFウェブサイトへのログインを促すプロンプトを表示し、トークンを保存します。

ノートブックで実行する場合、トークンを渡さずに login() を呼び出すことと同等です。ターミナルのプロンプトではなく、ノートブックフローの使用を強制したい場合に notebook_login() が役立ちます。

詳細については、login()を参照してください。

ログアウト

huggingface_hub.logout

< >

( token_name: str | None = None )

パラメータ

  • token_name (str, 任意) — ログアウトするアクセストークンの名前。None の場合、保存されているすべてのアクセストークンからログアウトします。

例外

ValueError

  • ValueError — アクセストークン名が見つからない場合。

Hubからマシンのログアウトを実行します。

Tokenはマシンから削除され、git credentialからも削除されます。

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

パラメータ

  • token_name (str) — 切り替えるアクセストークンの名前。
  • add_to_git_credential (bool、デフォルトはFalse) — Trueの場合、トークンはgit credentialとして設定されます。git credential helperが設定されていない場合、ユーザーに警告が表示されます。tokenがNoneの場合、add_to_git_credentialの値は無視され、エンドユーザーに再度プロンプトが表示されます。

例外

ValueError

  • ValueError — アクセストークン名が見つからない場合。

別のアクセストークンに切り替えます。

auth_list

huggingface_hub.auth_list

< >

( )

保存されているすべてのアクセストークンを一覧表示します。

Update on GitHub

←概要 環境変数→