メインコンテンツへスキップ
スクリプトを自動化された環境で実行する場合は、スクリプトの実行前またはスクリプト内で設定する環境変数によって W&B の動作を制御できます。 
# これは機密情報であり、バージョン管理にチェックインしないでください
WANDB_API_KEY=$YOUR_API_KEY
# 名前とメモは任意
WANDB_NAME="My first run"
WANDB_NOTES="Smaller learning rate, more regularization."

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

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

# runオブジェクトおよび関連クラスにスイープIDトラッキングを追加する
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"

​
オプションの環境変数

これらのオプションの環境変数を使用して、リモートマシンでの認証設定などを行います。
変数名用途
WANDB_API_KEYアカウントに紐づくAPIキーを設定します。User Settings でAPIキーを作成してください。リモートマシンで wandb login を実行していない場合は、この変数を必ず設定する必要があります。
WANDB_BASE_URLwandb/local を使用する場合は、この環境変数を http://YOUR_IP:YOUR_PORT に設定してください
WANDB_CACHE_DIRデフォルトは ~/.cache/wandb です。この環境変数を設定すると、この場所を上書きできます。
WANDB_CONFIG_DIRデフォルトは ~/.config/wandb です。この環境変数を設定すると、この場所を上書きできます。
WANDB_CONFIG_PATHSwandb.config に読み込む YAML ファイルのカンマ区切りリスト。config を参照してください。
WANDB_CONSOLEstdout / 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_GITwandb が Git リポジトリを探索し、最新のコミットや差分を取得するのを防ぎます。
WANDB_DISABLE_CODEノートブックや Git の diff を wandb に保存させないようにするには、これを true に設定します。Git リポジトリ内にいる場合は、現在のコミットは引き続き保存されます。
WANDB_DOCKERrun の復元を有効にするには、これを docker イメージのダイジェストに設定します。これは wandb の docker コマンドによって自動的に設定されます。wandb docker my/image/name:tag --digest を実行すると、イメージのダイジェストを取得できます。
WANDB_ENTITYrun に関連付けられたエンティティ。学習スクリプトのディレクトリで wandb init を実行すると、wandb という名前のディレクトリが作成され、デフォルトのエンティティが保存されます。このファイルはソースコード管理にチェックインできます。このファイルを作成したくない場合や、ファイルの内容を上書きしたい場合は、この環境変数を設定してください。
WANDB_ERROR_REPORTINGwandb が致命的なエラーをエラートラッキングシステムに記録しないようにするには、これを false に設定します。
WANDB_HOSTシステムが提供するホスト名を使用したくない場合に、wandb のインターフェース上で表示したいホスト名をここで設定します。
WANDB_IGNORE_GLOBS無視するファイルの glob パターンを、カンマ区切りのリストで指定します。ここで指定したファイルはクラウドに同期されません。
WANDB_JOB_NAMEwandb が作成するジョブの名前を指定します。
WANDB_JOB_TYPEjob type を指定します。たとえば “training” や “evaluation” を指定して、run の種類を示します。詳しくは grouping を参照してください。
WANDB_MODEこれを”offline”に設定すると、wandb は run のメタデータをローカルに保存し、サーバーと同期しなくなります。これを disabled に設定すると、wandb は完全に動作を停止します。
WANDB_NAMErun のわかりやすい名前です。設定しない場合はランダムに生成されます。
WANDB_NOTEBOOK_NAMEJupyter 上で実行している場合、この変数でノートブック名を設定できます。自動検出も試行します。
WANDB_NOTESrun に関するより長いメモです。Markdown を使用でき、後から UI で編集できます。
WANDB_PROJECTrun に関連付けられたプロジェクト。wandb init で設定することもできますが、環境変数で設定した値が優先されます。
WANDB_RESUMEデフォルト値は never です。auto に設定すると、wandb は失敗した run を自動的に再開します。must に設定すると、起動時に指定した run が必ず存在することを要求します。常に独自の一意な ID を生成したい場合は、これを allow に設定し、常に WANDB_RUN_ID を設定してください。
WANDB_RUN_GROUP実験名を指定すると、run が自動的にグループ化されます。詳しくは グループ化 を参照してください。
WANDB_RUN_IDスクリプトの 1 回の run に対応する、プロジェクト内でグローバルに一意な文字列を設定します。64 文字以内である必要があります。英数字とハイフン以外の文字はすべてハイフンに変換されます。障害発生時に既存の run を再開するために使用できます。
WANDB_QUIETこれを true に設定すると、標準出力に記録されるメッセージは重大なメッセージのみに制限されます。これが設定されている場合、すべてのログは $WANDB_DIR/debug.log に書き込まれます。
WANDB_SILENTtrue に設定すると、wandb のログ出力をすべて抑制します。スクリプトから実行するコマンドで便利です。これを設定すると、すべてのログは $WANDB_DIR/debug.log に書き込まれます。
WANDB_SHOW_RUNお使いのオペレーティングシステムがサポートしている場合は、これを true に設定すると、run の URL をブラウザで自動的に開きます。
WANDB_SWEEP_IDRun オブジェクトおよび関連クラスでスイープ ID を追跡し、UI に表示します。
WANDB_TAGSrun に適用するタグを、カンマ区切りのリストで指定します。
WANDB_USERNAMErun に関連付ける、チームメンバーのユーザー名です。サービスアカウントの APIキー と併用することで、自動実行された run をチームメンバーにひも付けることができます。
WANDB_USER_EMAILrun に関連付ける、チームメンバーのメールアドレスです。サービスアカウントの APIキー と併用することで、自動実行された run をチームメンバーにひも付けることができます。

​
Singularity 環境

Singularity でコンテナを実行している場合は、上記の環境変数の前に SINGULARITYENV_ を付けて指定できます。Singularity の環境変数の詳細については、こちらを参照してください。

​
AWS での実行

AWS でバッチジョブを実行している場合、マシンを W&B の認証情報で簡単に認証できます。User Settings で APIキー を作成し、WANDB_API_KEY 環境変数を AWS Batch ジョブ定義の仕様 に設定します。