> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.

> W&B SDK の動作を、認証、project の設定、ログするモードなどを制御する環境変数で設定する方法について説明します。

# 環境変数

自動化された環境でスクリプトを実行する場合、スクリプトの実行前またはスクリプト内で設定した環境変数で W\&B を制御できます。

```bash theme={"system"}
# これはシークレットで、バージョン管理にチェックインすべきではありません
WANDB_API_KEY=$YOUR_API_KEY
# 名とメモはオプション
WANDB_NAME="My first run"
WANDB_NOTES="Smaller learning rate, more regularization."
```

```bash theme={"system"}
# wandb/settings ファイルをチェックインしない場合のみ必要
WANDB_ENTITY=$username
WANDB_PROJECT=$project
```

```python theme={"system"}
# スクリプトをクラウドに同期したくない場合
os.environ["WANDB_MODE"] = "offline"

# sweep ID のトラッキングを Run オブジェクトおよび関連するクラスに追加します
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"
```

<h2 id="optional-environment-variables">
  オプションの環境変数
</h2>

リモートマシンでの認証を設定するなどには、以下のオプションの環境変数を使用します。

| Variable 名 | Usage |
| - | - |
| `WANDB_API_KEY` | アカウントに関連付けられた認証キーを設定します。[ユーザー設定](https://forge.coreweave.com/settings)で APIキーを作成してください。リモートマシンで `wandb login` を実行していない場合は、設定が必要です。 |
| `WANDB_BASE_URL` | [wandb/local](/ja/products/wandb/platform/hosting) を使用している場合は、この環境変数を `http://YOUR_IP:YOUR_PORT` に設定してください |
| `WANDB_CACHE_DIR` | デフォルトは \~/.cache/wandb です。この環境変数で保存場所を変更できます |
| `WANDB_CONFIG_DIR` | デフォルトは \~/.config/wandb です。この環境変数で保存場所を変更できます |
| `WANDB_CONFIG_PATHS` | wandb.config に読み込む yaml ファイルのカンマ区切りリストです。[設定](/ja/products/wandb/track/config#file-based-configs)を参照してください。 |
| `WANDB_CONSOLE` | stdout / stderr のログを無効にするには "off" に設定します。対応する環境では、デフォルトは "on" です。 |
| `WANDB_DATA_DIR` | アップロードするアーティファクトの一時保存場所です。Python パッケージ `platformdirs` の `user_data_dir` の値を使用するため、デフォルトの場所はプラットフォームによって異なります。このディレクトリが存在し、実行ユーザーに書き込み権限があることを確認してください。 |
| `WANDB_DIR` | 生成されるすべてのファイルの保存場所です。未設定の場合、トレーニングスクリプトからの相対パスである `wandb` ディレクトリがデフォルトになります。このディレクトリが存在し、実行ユーザーに書き込み権限があることを確認してください。ダウンロードしたアーティファクトの保存場所は制御しません。その場所は環境変数 `WANDB_ARTIFACT_DIR` で設定できます。 |
| `WANDB_ARTIFACT_DIR` | ダウンロードしたすべてのアーティファクトの保存場所です。未設定の場合、トレーニングスクリプトからの相対パスである `artifacts` ディレクトリがデフォルトになります。このディレクトリが存在し、実行ユーザーに書き込み権限があることを確認してください。生成されるメタデータファイルの保存場所は制御しません。その場所は環境変数 `WANDB_DIR` で設定できます。 |
| `WANDB_DISABLE_GIT` | wandb による git リポジトリの検出と最新のコミット / 差分の取得を防ぎます。 |
| `WANDB_DISABLE_CODE` | wandb がノートブックや git の差分を保存しないようにするには true に設定します。git リポジトリ内であれば、現在のコミットは引き続き保存されます。 |
| `WANDB_DOCKER` | run を復元できるようにするには、docker イメージのダイジェストを設定します。これは wandb docker コマンドで自動的に設定されます。`wandb docker my/image/name:tag --digest` を実行すると、イメージのダイジェストを取得できます |
| `WANDB_ENTITY` | run に関連付けられた entity です。トレーニングスクリプトのディレクトリで `wandb init` を実行すると、*wandb* というディレクトリが作成され、ソース管理に登録できるデフォルトの entity が保存されます。そのファイルを作成したくない場合や、ファイルの設定を上書きしたい場合は、環境変数を使用できます。 |
| `WANDB_ERROR_REPORTING` | wandb がエラー追跡システムに致命的なエラーをログしないようにするには false に設定します。 |
| `WANDB_HOST` | システムが提供するホスト名を使用したくない場合は、wandb の画面に表示したいホスト名を設定します |
| `WANDB_IGNORE_GLOBS` | 無視するファイルの glob パターンをカンマ区切りのリストで設定します。これらのファイルはクラウドに同期されません。 |
| `WANDB_JOB_NAME` | `wandb` が作成するジョブの名前を指定します。 |
| `WANDB_JOB_TYPE` | run の種類を示すために、"training" や "evaluation" などのジョブの種類を指定します。詳細は[グループ化](/ja/products/wandb/runs/grouping)を参照してください。 |
| `WANDB_MODE` | "offline" に設定すると、wandb は run のメタデータをローカルに保存し、サーバーには同期しません。`disabled` に設定すると、wandb は完全に無効になります。 |
| `WANDB_NAME` | run の人が読みやすい名前です。未設定の場合は、ランダムに生成されます |
| `WANDB_NOTEBOOK_NAME` | jupyter で実行している場合は、この変数でノートブックの名前を設定できます。自動検出も試みます。 |
| `WANDB_NOTES` | run に関する詳細なメモです。Markdown を使用でき、後から UI で編集できます。 |
| `WANDB_PROJECT` | run に関連付けられた project です。`wandb init` でも設定できますが、環境変数の値が優先されます。 |
| `WANDB_RESUME` | デフォルトは *never* です。*auto* に設定すると、wandb は失敗した run を自動的に再開します。*must* に設定すると、起動時に run が存在することが必須になります。常に独自の一意の ID を生成したい場合は、*allow* に設定し、必ず `WANDB_RUN_ID` を設定してください。 |
| `WANDB_RUN_GROUP` | run を自動的にグループ化するための実験名を指定します。詳細は[グループ化](/ja/products/wandb/runs/grouping)を参照してください。 |
| `WANDB_RUN_ID` | スクリプトの単一の run に対応する、プロジェクト内で一意の文字列を設定します。64 文字以内である必要があります。単語構成文字以外の文字はすべてハイフンに変換されます。障害が発生した場合に、既存の run を再開するために使用できます。 |
| `WANDB_QUIET` | 標準出力にログされるメッセージを重要なものだけに制限するには `true` に設定します。設定すると、すべてのログが `$WANDB_DIR/debug.log` に書き込まれます。 |
| `WANDB_SILENT` | wandb のログメッセージを表示しないようにするには `true` に設定します。スクリプトからコマンドを実行する場合に便利です。設定すると、すべてのログが `$WANDB_DIR/debug.log` に書き込まれます。 |
| `WANDB_SHOW_RUN` | オペレーティングシステムが対応している場合に、run の URL をブラウザーで自動的に開くには `true` に設定します。 |
| `WANDB_SWEEP_ID` | `Run` オブジェクトと関連クラスに sweep ID の追跡を追加し、UI に表示します。 |
| `WANDB_TAGS` | run に適用するタグのカンマ区切りリスト。 |
| `WANDB_USERNAME` | run に関連付けられたチームメンバーのユーザー名。サービスアカウントの API キーと併用することで、自動化された run をチームメンバーに帰属させることができます。 |
| `WANDB_USER_EMAIL` | run に関連付けられたチームメンバーのメールアドレス。サービスアカウントの API キーと併用することで、自動化された run をチームメンバーに帰属させることができます。 |

<h2 id="singularity-environments">
  Singularity 環境
</h2>

[Singularity](https://singularity.lbl.gov/index.html) でコンテナーを実行する場合は、上記の変数の先頭に `SINGULARITYENV_` を付けることで環境変数を渡せます。Singularity の環境変数について詳しくは、[こちら](https://singularity.lbl.gov/docs-environment-metadata#environment)をご覧ください。

<h2 id="running-on-aws">
  AWS 上で実行する
</h2>

AWS でバッチジョブを実行している場合、W\&B の認証情報でマシンを簡単に認証できます。[ユーザー設定](https://forge.coreweave.com/settings) で APIキーを作成し、[AWS バッチジョブ spec](https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html#parameters) で `WANDB_API_KEY` 環境変数を設定します。


## Related topics

- [環境変数](/ja/support/models/tags/environment-variables.md)