関数 wandb.login()
W&B にログインします。 通常、このメソッドを使用する必要はありません。認証を必要とするほとんどの W&B メソッドは 暗黙的にログインできるためです。これはwandb login CLI のプログラム版です。
このメソッドは、セッションのグローバルな認証情報を更新します (この呼び出し以降の現在の Python プロセスにおけるすべての wandb の使用に影響します) 。
また、.netrc ファイルも更新される場合があります。
WANDB_IDENTITY_TOKEN_FILE 環境変数などを通じて
アイデンティティトークンファイルが設定されている場合、
セッションに使用されます (フェデレーションするアイデンティティ) 。APIキーは読み取られず、保存されません。
それ以外の場合、明示的な APIキーが提供されると、それが使用され、
システムの .netrc ファイルに書き込まれます。キーが提供されず、
セッションがすでに認証されている場合は、セッションキーが検証 (verify が
True の場合) に使用され、.netrc ファイルは更新されません。
上記のいずれも当てはまらない場合、APIキーは次の順序で取得されます：
- WANDB_API_KEY 環境変数
- システムまたは Workspace の設定ファイル内の api_key 設定
- .netrc ファイル (
/.netrc、/_netrc、または NETRC 環境変数で指定されたパス) - 利用可能で
promptが True の場合、インタラクティブプロンプト
引数
str | None
使用する APIキー。
bool | None
true の場合、.netrc や環境変数などを読み込まず、インタラクティブプロンプトから APIキー を取得します。
str | None
接続する W&B サーバーの URL。
bool | None
true の場合、インタラクティブプロンプトでオフラインモードの選択を禁止します。
int | None
インタラクティブプロンプトでユーザー入力を待機する秒数。非インタラクティブな環境で誤ってインタラクティブプロンプトが表示された場合のフェイルセーフとして使用できます。
bool
W&B サーバーで認証情報を検証し、失敗時に AuthenticationError を発生させます。これは APIキー だけでなくアイデンティティトークンにも適用されます。
str | None
分析のために URL ログインリクエストで使用するリファラー。
bool
APIキー が設定されていない場合にインタラクティブに APIキー を要求するかどうか。False の場合、False を返し、セッションと設定を変更しません。
DoNotSet
説明は提供されていません。
Returns
この呼び出しの後、セッションに認証情報がある場合に True を返します。送出される例外
AuthenticationError: 認証情報がサーバーでの検証に失敗した場合。UsageError: 認証情報が設定されておらず、promptが True で、APIキーを尋ねる端末がない場合。