メインコンテンツへスキップ
GitHub ソース

​
function login

login(
    key: 'str | None' = None,
    relogin: 'bool | None' = None,
    host: 'str | None' = None,
    force: 'bool | None' = None,
    timeout: 'int | None' = None,
    verify: 'bool' = False,
    referrer: 'str | None' = None,
    anonymous: 'DoNotSet' = <object object at 0x102561240>
) → bool
W&B にログインします。 通常はこのメソッドを使う必要はありません。認証が必要なほとんどの W&B メソッドは、暗黙的にログインを行います。これは wandb login CLI のプログラムからの呼び出しに相当します。 このメソッドはセッションのグローバルな認証情報を更新します（この呼び出し以降、現在の Python プロセス内のすべての wandb の利用に影響します）。さらに .netrc ファイルを更新する場合もあります。 WANDB_IDENTITY_TOKEN_FILE 環境変数などで identity_token_file 設定が指定されている場合、このメソッドは何も行いません（no-op です）。 それ以外の場合で、明示的な APIキー が渡された場合は、そのキーを使用し、システムの .netrc ファイルに書き込みます。キーが指定されておらず、すでにセッションが認証済みの場合は、セッションキーを検証に使用します（verify が True の場合）。このとき .netrc ファイルは更新されません。 上記いずれにも当てはまらない場合は、次のいずれか最初に見つかった場所から APIキー を取得します:
  • WANDB_API_KEY 環境変数
  • システムまたはワークスペース設定ファイル内の api_key 設定
  • .netrc ファイル（/.netrc、/_netrc、または NETRC 環境変数で指定されたパス）
  • 対話プロンプト（利用可能な場合）
引数:
  • key: 使用する APIキー。
  • relogin: true の場合、.netrc や環境変数などを読み飛ばし、対話プロンプトから APIキー を取得します。
  • host: 接続先の W&B サーバー URL。
  • force: true の場合、対話プロンプトでオフラインモードの選択を禁止します。
  • timeout: 対話プロンプトでユーザー入力を待機する秒数。対話プロンプトが誤って非対話環境で表示されてしまった場合のフェイルセーフとして使用できます。
  • verify: 認証情報を W&B サーバーで検証し、失敗した場合は AuthenticationError を送出します。
  • referrer: 分析用に、URL ログインリクエストで使用するリファラー。
戻り値:
  • bool: key が設定されていれば True。
例外:
  • AuthenticationError: api_key のサーバーでの検証に失敗した場合。
  • UsageError: api_key を設定できず、かつ tty が存在しない場合。