関数 wandb.login()
W&B にログインします。 通常はこれを使用する必要はありません。認証が必要なほとんどの W&B の method は、暗黙的にログインできるためです。これはwandb login CLI に対応するプログラム向けの機能です。
これにより、このセッションのグローバル認証情報が更新されます (この call 以降、現在の Python プロセス内でのすべての wandb の使用に影響します) 。また、.netrc ファイルが更新される場合もあります。
アイデンティティトークンファイルが、WANDB_IDENTITY_TOKEN_FILE 環境変数などを通じて設定されている場合、セッション (フェデレーションアイデンティティ) にはそのファイルが使用され、APIキー の読み取りや保存は行われません。
それ以外の場合、明示的に APIキー が指定されていれば、それが使用され、システムの .netrc ファイルに書き込まれます。キーが指定されていない場合でも、セッションがすでに認証済みであれば、セッションキーが検証に使用され (verify が True の場合) 、.netrc ファイルは更新されません。
上記のいずれにも該当しない場合、この関数は次のうち最初に見つかったものから APIキー を取得します。
- WANDB_API_KEY 環境変数
- システムまたは Workspace settings ファイル内の api_key 設定
- .netrc ファイル (
/.netrc、/_netrc、または NETRC 環境変数で指定されたパス) - 対話型プロンプト (利用可能な場合)
引数
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ログインリクエストで使用するリファラー。
DoNotSet
説明はありません。
戻り値
bool: key が設定されている場合。
Raises
AuthenticationError: 認証情報のサーバー検証に失敗した場合。UsageError:api_keyを設定できず、tty もない場合。