使い方
launch [OPTIONS]
説明
オプション
| Flag | Type | Description |
|---|---|---|
--uri, -u | STR | launch する対象のローカルパスまたは git repo URI。指定すると、このコマンドは指定した URI からジョブを作成します。デフォルト: None |
--job, -j | STR | launch するジョブの名。指定した場合、launch に URI は不要です。デフォルト: None |
--entry-point, -E | STR | project 内のエントリポイント。[default: main]。エントリポイントが見つからない場合は、指定した名の project ファイルをスクリプトとして実行しようとします。このとき、.py ファイルは python で、.sh ファイルはデフォルトのシェル (環境変数 $SHELL で指定) で実行します。指定した場合、設定ファイルで渡された entrypoint の値を上書きします。デフォルト: None |
--build-context | STR | ソースコード内の build context へのパス。デフォルトではソースコードのルートを使用します。-u とのみ互換性があります。デフォルト: None |
--name | STR | run の launch に使用する run 名。指定しない場合は、ランダムな run 名で run を launch します。指定した場合、設定ファイルで渡された name を上書きします。デフォルト: None |
--entity, -e | STR | 新しい run の送信先となる entity の名。デフォルトでは、ローカルの wandb/settings フォルダーで設定された entity を使用します。指定した場合、設定ファイルで渡された entity の値を上書きします。デフォルト: None |
--project, -p | STR | 新しい run の送信先となる project の名。デフォルトでは、ソース URI で指定された project 名、または GitHub runs の場合は git repo 名を使用します。指定した場合、設定ファイルで渡された project の値を上書きします。デフォルト: None |
--resource, -r | STR | run に使用する実行リソース。サポートされる値: 'local-process', 'local-container', 'kubernetes', 'sagemaker', 'gcp-vertex'。リソース設定のないキューにプッシュする場合、これは必須パラメーターです。指定した場合、設定ファイルで渡された resource の値を上書きします。デフォルト: None |
--docker-image, -d | STR | 使用する特定の Docker image。形式は name:tag です。指定した場合、設定ファイルで渡された docker image の値を上書きします。デフォルト: None |
--base-image, -B | STR | ジョブコードを実行する Docker image。--docker-image とは同時に使用できません。デフォルト: None |
--config, -c | STR | launch 設定として渡す JSON ファイル (末尾が .json である必要があります) へのパス、または JSON 文字列。launch された run の設定方法を指定します。デフォルト: None |
--set-var, -v | STR | 許可リストが有効なキューに対して、テンプレート変数の値をキーと値のペアとして設定します (例: --set-var key1=value1 --set-var key2=value2) 。デフォルト: None |
--queue, -q | STR | プッシュ先の run キューの名。指定しない場合は single run を直接 launch します。引数なしで指定した場合 (--queue) 、キュー 'default' が使用されます。名前を指定した場合、指定した run キューは、指定した project および entity 配下に存在している必要があります。デフォルト: None |
--async | BOOL Flag | ジョブを非同期で実行するためのフラグ。デフォルトは false です。つまり、--async を指定しない限り、wandb launch はジョブが完了するまで待機します。このオプションは --queue と同時に使用できません。エージェントで実行する場合の非同期オプションは wandb launch-agent で設定してください。デフォルト: False |
--resource-args, -R | STR | コンピュートリソースに resource args として渡す JSON ファイル (末尾が .json である必要があります) へのパス、または JSON 文字列。指定する内容は実行バックエンドごとに異なります。このファイルのレイアウトについてはドキュメントを参照してください。デフォルト: None |
--dockerfile, -D | STR | ジョブの build に使用する Dockerfile へのパス。ジョブのルートからの相対パスです。デフォルト: None |
--priority, -P | Choice | --queue を指定した場合に、ジョブの優先度を設定します。優先度の高い launch ジョブほど先に処理されます。優先度は高い順に critical、high、medium、low です。デフォルト: None |