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