Skip to main content
W&B Job を起動またはキューに投入します。https://wandb.me/launch を参照してください。

使用方法

wandb launch [OPTIONS]

オプション

オプション説明
--uri, -u起動するローカルパスまたは Git リポジトリの URI。指定された場合、このコマンドはその URI から job を作成します。
--job, -j起動する job の名前。指定された場合、Launch では URI は不要です。
--entry-point, -Eプロジェクト内のエントリーポイント。[既定値: main]。エントリーポイントが見つからない場合は、指定された名前のプロジェクトファイルをスクリプトとして実行しようとします。.py ファイルには python を使用し、.sh ファイルには環境変数 $SHELL で指定されたデフォルトシェルを使用します。指定された場合、config ファイルで渡された entrypoint の値を上書きします。
--build-contextソースコード内のビルドコンテキストへのパス。デフォルトはソースコードのルートです。-u と併用する場合にのみ使用できます。
--namerun を起動する際に使用する run の名前。指定しない場合は、ランダムな run 名で run を起動します。指定された場合、config ファイルで渡された name の値を上書きします。
--entity, -e新しい run の送信先となる対象 entity の名前。デフォルトでは、ローカルの wandb/settings フォルダで設定された entity が使用されます。指定された場合、config ファイルで渡された entity の値を上書きします。
--project, -p新しい run の送信先となる対象プロジェクトの名前。デフォルトでは、source URI で指定されたプロジェクト名、または GitHub の run の場合は Git リポジトリ名が使用されます。指定された場合、config ファイルで渡された project の値を上書きします。
--resource, -rrun の実行に使用する実行リソース。サポートされる値: local-process, local-container, kubernetes, sagemaker, gcp-vertex。リソース設定のないキューにプッシュする場合、このパラメータは必須です。指定された場合、config ファイルで渡された resource の値を上書きします。
--docker-image, -d使用したい特定の Docker イメージ。name:tag の形式で指定します。指定された場合、config ファイルで渡された docker イメージの値を上書きします。
--base-image, -Bjob のコードを実行するための Docker イメージ。--docker-image とは併用できません。
--config, -cLaunch の設定 (launch config) として渡す JSON ファイル(拡張子は必ず .json)または JSON 文字列へのパス。起動された run の設定内容を指定します。
--set-var, -vallow listing(許可リスト)が有効なキューに対して、テンプレート変数の値をキーと値のペアで設定します(例: --set-var key1=value1 --set-var key2=value2)。
--queue, -qプッシュ先の run キュー名。指定しない場合は、単一の run を直接起動します。引数なし(--queue)で指定された場合は、default キューがデフォルトになります。それ以外の場合、名前が指定された場合は、指定された project と entity の下にその run キューが存在している必要があります。
--asyncjob を非同期で実行するためのフラグ。デフォルトは false です。つまり、--async を指定しない限り、wandb launch は job の完了を待機します。このオプションは --queue とは互換性がありません。エージェントで実行する場合の非同期オプションは wandb launch-agent で設定してください。(既定値: False)
--resource-args, -Rコンピュートリソースに resource args として渡される JSON ファイル(拡張子は必ず .json)または JSON 文字列へのパス。提供すべき具体的な内容は、各実行バックエンドによって異なります。このファイルのレイアウトについてはドキュメントを参照してください。
--dockerfile, -Djob のビルドに使用される Dockerfile へのパス(job のルートからの相対パス)
--priority, -P--queue が指定された場合に、job の優先度を設定します。優先度の高い Launch の job から順に処理されます。優先度は高い順に critical, high, medium, low です。