関数 wandb.init()
新しい run を開始し、W&B でトラッキングしてログします。 ML トレーニングパイプラインでは、トレーニングスクリプトと評価スクリプトの先頭にwandb.init() を追加すると、それぞれが W&B 上で
個別の run として追跡されます。
wandb.init() は run にデータをログするための新しいバックグラウンドプロセスを起動し、
デフォルトで https://wandb.ai にデータを同期します。そのため、結果をリアルタイムで確認できます。
データのログが完了したら、run.finish() を呼び出して run を終了します。
または、run をコンテキストマネージャーとして使用すると、run.finish() が自動的に呼び出されます:
with wandb.init() as run:
… # run.finish() はブロックの終わりで実行されます
run.finish() を呼び出さなかった場合は、スクリプトの終了時に run も終了します。
run ID には、次の特殊文字は使用できません: / \ # ? % :
Args
str | None
run のログ先となるユーザー名またはチーム名です。entity はあらかじめ存在している必要があるため、run のログを開始する前に UI でアカウントまたはチームを作成してください。指定しない場合、run はデフォルトの entity にログされます。デフォルトの entity を変更するには、設定画面を開き、「Default team」の「Default location to create new projects」を更新してください。
str | None
この run をログするプロジェクト名です。指定しない場合、git ルートや現在のプログラムファイルの確認など、システムに基づくヒューリスティックでプロジェクト名を推測します。プロジェクト名を推測できない場合、project はデフォルトで
"uncategorized" になります。StrPath | None
実験のログとメタデータファイルを保存するディレクトリの絶対パスです。指定しない場合、デフォルトは
./wandb ディレクトリです。なお、この設定は download() を呼び出したときにアーティファクトが保存される場所には影響しません。str | None
この run の一意の ID で、再開時に使用されます。project 内で一意である必要があり、run を削除した後に再利用することはできません。短い説明的な名を付けるには
name フィールドを、run 間で比較するためのハイパーパラメーターを保存するには config を使用してください。str | None
この run の短い表示名です。UI に表示され、run を識別しやすくします。デフォルトでは、ランダムな 2 語の名が生成されるため、表と チャート の間で run を簡単に相互参照できます。run 名を簡潔にしておくと、チャートの凡例や表が読みやすくなります。ハイパーパラメーターの保存には、
config フィールドの使用を推奨します。str | None
run の詳細な説明で、Git のコミットメッセージに相当します。この 引数 を使用して、後からこの run の目的や設定を思い出すのに役立つコンテキストや詳細を取得してください。
Sequence[str] | None
UI でこの run にラベルを付けるためのタグのリストです。タグは、run の整理や、「ベースライン」や「本番」のような一時的な識別子の付与に役立ちます。UI では、タグの追加や削除、タグによるフィルターを簡単に行えます。run を再開する場合、ここで指定したタグで既存のタグが置き換えられます。再開した run に現在のタグを上書きせずにタグを追加するには、
run = wandb.init() を呼び出した後に run.tags += ("new_tag",) を使用してください。dict[str, Any] | str | None
wandb.config を設定します。これは、モデルのハイパーパラメーターやデータの前処理設定など、run への入力パラメーターを保存するための辞書のようなオブジェクトです。設定は UI の概要ページに表示され、これらのパラメーターに基づいて run をグループ化、フィルター、並べ替えできます。キーにはピリオド (.) を含めないでください。また、値は 10 MB 未満である必要があります。辞書、argparse.Namespace、または absl.flags.FLAGS を指定した場合、キーと値のペアはそのまま wandb.config に読み込まれます。文字列を指定した場合は YAML ファイルへのパスとして解釈され、そのファイルから設定値が wandb.config に読み込まれます。list[str] | None
wandb.config から除外するキーのリストです。list[str] | None
wandb.config に含めるキーのリストです。bool | None
設定値を一度設定した後に変更できるかどうかを制御します。デフォルトでは、設定値を上書きすると例外が発生します。学習率など、トレーニング中に変化する変数を追跡するには、代わりに
wandb.log() の使用を検討してください。デフォルト値は、スクリプトでは False、ノートブック環境では True です。str | None
個々の run をより大きな実験の一部としてまとめるためのグループ名を指定します。交差検証や、異なるテストセットでモデルをトレーニング・評価する複数のジョブを実行する場合などに便利です。グループ化すると、関連する run を UI でまとめて管理でき、1 つの実験として結果を簡単に切り替えて確認できます。
str | None
run のタイプを指定します。より大規模な実験の一部としてグループ内で run を整理する場合に特に便利です。たとえば、グループ内の run に “train” や “eval” などのジョブタイプでラベルを付けることができます。ジョブタイプを定義しておくと、UI で類似の run を簡単にフィルターおよびグループ化でき、直接比較しやすくなります。
Literal['online', 'offline', 'disabled', 'shared'] | None
run データの管理方法を指定します。次のオプションがあります。
"online"(デフォルト): ネットワーク接続が利用可能な場合に W&B とのライブ同期を有効にし、 可視化をリアルタイムで更新します。"offline": エアギャップ環境やオフライン環境に適しています。データは ローカルに保存され、後で同期できます。run フォルダーを 削除せずに保持してください。"disabled": W&B のすべての機能を無効にし、run のメソッドを no-op にします。主に、テスト時に W&B の操作をスキップするために使用します。"shared": (実験的機能です)。複数のプロセス (異なるマシン上のプロセスも含む) から同じ run に同時にログできます。 この方法では、プライマリノードと 1 つ以上のワーカーノードを使用して 同じ run にデータをログします。プライマリノードで run を初期化し、各ワーカーノードでは、プライマリノードで使用した run ID を指定して run を初期化します。
bool | None
スクリプトの実行に W&B へのログインを必須とするかどうかを指定します。
True の場合、ユーザーは W&B にログインしている必要があり、ログインしていなければスクリプトは続行されません。False (デフォルト) の場合、ログインしていなくてもスクリプトは続行され、未ログイン時はオフラインモードに切り替わります。bool | Literal[None, 'default', 'return_previous', 'finish_previous', 'create_new']
“reinit” 設定の省略形です。run が実行中のときの
wandb.init() の動作を指定します。"default": ノートブックでは “finish_previous” を、それ以外では “return_previous” を使用します。"return_previous": まだ終了していない run のうち、最も新しく作成されたものを 返します。wandb.runは更新されません。 “create_new” オプションを参照してください。"finish_previous": 実行中のすべての run を終了してから、新しい run を返します。"create_new": 他の実行中の run に影響を与えずに新しい run を作成します。wandb.runや、wandb.logなどのトップレベル関数は更新されません。 そのため、グローバル run に依存する一部の古いインテグレーションは 動作しません。
bool | Literal['allow', 'never', 'must', 'auto'] | None
指定した
id の run を再開する際の動作を制御します。
使用可能なオプションは次のとおりです。"allow": 指定したidの run が存在する場合は最後のステップから 再開し、存在しない場合は新しい run を作成します。"never": 指定したidの run が存在する場合はエラーが 発生し、存在しない場合は新しい run を作成します。"must": 指定したidの run が存在する場合は最後のステップから 再開し、存在しない場合はエラーが発生します。"auto": このマシンで前回の run がクラッシュしていた場合は自動的に 再開し、それ以外の場合は新しい run を開始します。True: 非推奨です。代わりに"auto"を使用してください。False: 非推奨です。常に新しい run を開始するには、デフォルトの動作 (resumeを未設定のままにする) を使用してください。resumeを設定した場合、fork_fromとresume_fromは 使用できません。resumeが未設定の場合は、常に新しい run が開始されます。
str | None
run の再開位置として、以前の run 内の時点を
{run_id}?_step={step} の形式で指定します。これにより、run にログされた履歴を途中のステップで切り詰め、そのステップからログを再開できます。対象の run は同じ project 内にある必要があります。id 引数も指定した場合は、resume_from 引数が優先されます。resume、resume_from、fork_from は併用できず、一度に指定できるのはいずれか 1 つだけです。なお、この機能はベータ版であり、今後変更される可能性があります。str | None
新しい run のフォーク元となる、以前の run 内のポイントを
{id}?_step={step} の形式で指定します。これにより、対象 run の履歴内の指定したステップからログを再開する新しい run が作成されます。対象の run は現在の project に属している必要があります。id 引数も指定する場合は、fork_from 引数とは異なる値にする必要があります。同じ値の場合はエラーが発生します。resume、resume_from、fork_from は併用できず、一度に使用できるのはいずれか 1 つのみです。この機能はベータ版であり、今後変更される可能性があります。bool | None
メインスクリプトまたはノートブックを W&B に保存できるようにします。これにより実験の再現性が高まり、UI 上で run 間のコードを比較できるようになります。デフォルトでは無効ですが、設定ページでデフォルトを有効に変更できます。
bool | None
非推奨です。代わりに
sync_tensorboard を使用してください。bool | None
TensorBoard または TensorBoardX から W&B へのログの自動同期を有効にし、W&B UI で表示するための関連イベントファイルを保存します。
bool | None
OpenAI Gym の使用時に、環境の動画を自動的にログします。
Settings | dict[str, Any] | None
run の詳細設定を含む辞書または
wandb.Settings オブジェクトを指定します。DoNotSet
説明はありません。
Returns
Run オブジェクト。
送出される例外
Error: run の初期化中に不明なエラーまたは内部エラーが発生した場合。AuthenticationError: ユーザーが有効な認証情報を指定しなかった場合。CommError: WandB サーバーとの通信中に問題が発生した場合。UsageError: ユーザーが無効な引数を指定した場合。KeyboardInterrupt: ユーザーが run を中断した場合。
サンプル
wandb.init() は Run オブジェクトを返します。Run オブジェクトを使用してデータをログし、
アーティファクトを保存し、run のライフサイクルを管理します。