メインコンテンツへスキップ
自動化された環境でスクリプトを実行する場合、スクリプトの実行前またはスクリプト内で環境変数を設定することで 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 オブジェクトおよび関連クラスに sweep ID トラッキングを追加する
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"

​
オプションの環境変数

リモートマシンでの認証設定などを行うには、以下のオプションの環境変数を使用します。
変数名使用法
WANDB_API_KEYアカウントに関連付けられた認証キーを設定します。 APIキー は User Settings で作成してください。リモートマシンで 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_CONSOLE標準出力 / 標準エラーの ログ 記録を無効にするには、これを “off” に設定します。サポートされている環境では、デフォルトで “on” に設定されています。
WANDB_DATA_DIRステージング中の アーティファクト をアップロードする場所。 platformdirs Python パッケージの user_data_dir の値を使用するため、デフォルトの場所はプラットフォームによって異なります。この ディレクトリー が存在し、実行 ユーザー が書き込み権限を持っていることを確認してください。
WANDB_DIR生成されたすべてのファイルを保存する場所。未設定の場合、デフォルトは トレーニングスクリプト 相対の wandb ディレクトリー です。この ディレクトリー が存在し、実行 ユーザー が書き込み権限を持っていることを確認してください。これはダウンロードされた アーティファクト の場所を制御しません。そちらは WANDB_ARTIFACT_DIR 環境変数を使用して設定できます。
WANDB_ARTIFACT_DIRダウンロードされたすべての アーティファクト を保存する場所。未設定の場合、デフォルトは トレーニングスクリプト 相対の artifacts ディレクトリー です。この ディレクトリー が存在し、実行 ユーザー が書き込み権限を持っていることを確認してください。これは生成された メタデータ ファイルの場所を制御しません。そちらは WANDB_DIR 環境変数を使用して設定できます。
WANDB_DISABLE_GITwandb が git リポジトリを探索し、最新のコミット / 差分を取得するのを防ぎます。
WANDB_DISABLE_CODEwandb が ノートブック や git の差分を保存しないようにするには、これを true に設定します。 git リポジトリ内にいる場合は、現在のコミットは引き続き保存されます。
WANDB_DOCKERRuns の復元を有効にするために、これを docker イメージのダイジェストに設定します。これは wandb docker コマンドで自動的に設定されます。イメージのダイジェストは wandb docker my/image/name:tag --digest を実行することで取得できます。
WANDB_ENTITYrun に関連付けられた entity。 トレーニングスクリプト の ディレクトリー で wandb init を実行した場合、 wandb という名前の ディレクトリー が作成され、ソース管理にチェックイン可能なデフォルトの entity が保存されます。そのファイルを作成したくない場合や、ファイルを上書きしたい場合は、環境変数を使用できます。
WANDB_ERROR_REPORTINGwandb が致命的なエラーをエラー追跡システムに ログ 記録しないようにするには、これを false に設定します。
WANDB_HOSTシステム提供のホスト名を使用したくない場合に、 wandb インターフェースで表示したいホスト名を設定します。
WANDB_IGNORE_GLOBS無視するファイル glob のカンマ区切りリスト。これらのファイルは クラウド に同期されません。
WANDB_JOB_NAMEwandb によって作成される ジョブ の名前を指定します。
WANDB_JOB_TYPE異なるタイプの Runs を示すために、“training” や “evaluation” などの ジョブタイプ を指定します。詳細は grouping を参照してください。
WANDB_MODEこれを “offline” に設定すると、 wandb は run の メタデータ をローカルに保存し、 サーバー に同期しません。 disabled に設定すると、 wandb は完全にオフになります。
WANDB_NAMErun の人間が判別可能な名前。設定されていない場合は、ランダムに生成されます。
WANDB_NOTEBOOK_NAMEjupyter で実行している場合、この変数で ノートブック の名前を設定できます。自動検出を試みます。
WANDB_NOTESrun に関する詳細なメモ。 Markdown が使用可能で、後で UI で編集することもできます。
WANDB_PROJECTrun に関連付けられた Project。これは wandb init でも設定できますが、環境変数の 値 が優先されます。
WANDB_RESUMEデフォルトでは never に設定されています。 auto に設定すると、 wandb は失敗した Runs を自動的に再開します。 must に設定すると、起動時にその run が存在することを強制します。常に独自のユニークな ID を生成したい場合は、これを allow に設定し、常に WANDB_RUN_ID を設定してください。
WANDB_RUN_GROUPRuns を自動的にグループ化するための 実験 名を指定します。詳細は grouping を参照してください。
WANDB_RUN_IDスクリプトの単一の run に対応する、（プロジェクト内で）グローバルにユニークな文字列を設定します。 64 文字以内である必要があります。英数字以外の文字はダッシュに変換されます。これは、失敗した場合に既存の run を再開するために使用できます。
WANDB_QUIET標準出力に記録されるステートメントを重要なものだけに制限するには、これを true に設定します。これが設定されている場合、すべての ログ は $WANDB_DIR/debug.log に書き込まれます。
WANDB_SILENTwandb の ログ ステートメントを消音にするには、これを true に設定します。これはスクリプト化された コマンド に便利です。これが設定されている場合、すべての ログ は $WANDB_DIR/debug.log に書き込まれます。
WANDB_SHOW_RUNオペレーティングシステムがサポートしている場合、 run の URL でブラウザを自動的に開くには、これを true に設定します。
WANDB_SWEEP_IDRun オブジェクトおよび関連クラスに sweep ID トラッキングを追加し、UI に表示します。
WANDB_TAGSrun に適用されるタグのカンマ区切りリスト。
WANDB_USERNAMErun に関連付けられた チーム メンバーの ユーザー 名。これは、自動化された Runs を チーム メンバーに帰属させるために、サービスアカウントの APIキー と組み合わせて使用できます。
WANDB_USER_EMAILrun に関連付けられた チーム メンバーのメールアドレス。これは、自動化された Runs を チーム メンバーに帰属させるために、サービスアカウントの APIキー と組み合わせて使用できます。

​
Singularity 環境

Singularity でコンテナを実行している場合、上記の変数の前に SINGULARITYENV_ を付けることで環境変数を渡すことができます。 Singularity の環境変数に関する詳細は こちら で確認できます。

​
AWS での実行

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