login()

​

関数 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 0x109961240>
) → bool

W&B にログインします。

通常はこれを使用する必要はありません。認証が必要なほとんどの W&B の method は、暗黙的にログインできるためです。これは wandb login CLI に対応するプログラム向けの機能です。

これにより、このセッションのグローバル認証情報が更新されます (この call 以降、現在の Python プロセス内でのすべての wandb の使用に影響します) 。また、.netrc ファイルが更新される場合もあります。

identity_token_file 設定が、WANDB_IDENTITY_TOKEN_FILE 環境変数などを通じて設定されている場合、これは no-op です。

それ以外の場合、明示的に APIキー が指定されていれば、それが使用され、システムの .netrc ファイルに書き込まれます。キーが指定されていない場合でも、セッションがすでに認証済みであれば、セッションキーが検証に使用され (verify が True の場合) 、.netrc ファイルは更新されません。

上記のいずれにも該当しない場合、この関数は次のうち最初に見つかったものから APIキー を取得します。

• WANDB_API_KEY 環境変数
• システムまたは Workspace settings ファイル内の 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 が設定されている場合。

Raises:

• AuthenticationError: api_key のサーバー検証に失敗した場合。
• UsageError: api_key を設定できず、tty もない場合。