> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-serverless-sft-revamp.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

#  start_thought
login()

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_login.py" />

### <kbd>function</kbd> `login`

```python theme={null}
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 0x100745f80>
) → bool
```

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

認証を必要とするほとんどの W\&B メソッドは暗黙的にログインを実行できるため、通常このメソッドを直接使用する必要はありません。これは CLI の `wandb login` に対応するプログラム用のメソッドです。

このメソッドはセッションのグローバルな認証情報を更新し（この呼び出し以降、現在の Python プロセス内のすべての wandb の使用に影響します）、必要に応じて .netrc ファイルも更新します。

`WANDB_IDENTITY_TOKEN_FILE` 環境変数などを通じて `identity_token_file` 設定が指定されている場合、このメソッドは何もしません。

それ以外の場合で、明示的な APIキー が提供されたときは、そのキーが使用され、システムの .netrc ファイルに書き込まれます。キーが提供されず、すでにセッションが認証済みである場合は、そのセッションのキーが検証に使用され（`verify` が True の場合）、.netrc ファイルは更新されません。

上記のいずれにも当てはまらない場合、以下の優先順位で APIキー を取得します：

* `WANDB_API_KEY` 環境変数
* システムまたは Workspace 設定ファイルの `api_key` 設定
* .netrc ファイル（`~/.netrc`、`~/_netrc`、または `NETRC` 環境変数で指定されたパス）
* インタラクティブなプロンプト（利用可能な場合）

**Args:**

* `key`: 使用する APIキー。
* `relogin`: True の場合、.netrc や 環境変数などの読み取りをスキップし、インタラクティブなプロンプトから APIキー を取得します。
* `host`: 接続する W\&B サーバー の URL。
* `force`: True の場合、インタラクティブなプロンプトでオフラインモードを選択できないようにします。
* `timeout`: インタラクティブなプロンプトでユーザーの入力を待機する秒数。非インタラクティブな 環境 で誤ってプロンプトが表示された場合のフェイルセーフとして使用できます。
* `verify`: W\&B サーバー で認証情報を検証し、失敗した場合は `AuthenticationError` を発生させます。
* `referrer`: 分析用の URL ログインリクエストで使用するリファラー。

**Returns:**

* `bool`: `key` が設定されているかどうか。

**Raises:**

* `AuthenticationError`: `api_key` の サーバー での検証に失敗した場合。
* `UsageError`: `api_key` が設定できず、かつ tty が利用できない場合。
