az ml job
Note
This reference is part of the ml extension for the Azure CLI (version 2.15.0 or higher). 拡張機能は、az ml job コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.
Azure ML ジョブを管理します。
Azure ML ジョブは、指定されたコンピューティング 先に対してタスクを実行します。 Azure でモデル トレーニングをスケールアウトするようにジョブを構成できます。 Azure ML では、さまざまな機能を備えたさまざまなジョブの種類がサポートされています。 たとえば、最も基本的なジョブであるコマンド ジョブは、Docker コンテナーでコマンドを実行し、単一ノードおよび分散トレーニングに利用できます。 スイープ ジョブは、モデルのハイパーパラメーターを調整するために、指定された検索空間に対してハイパーパラメーター スイープを実行します。
ジョブを使用すると、ML の実験とワークフローの体系的な追跡も可能になります。 ジョブが作成されると、Azure ML は、メタデータ、ジョブ中に生成されたメトリック、ログ、成果物、実行されたコード、使用される Azure ML 環境を含むジョブの実行レコードを保持します。 Azure ML スタジオで、ジョブのすべての実行レコードを表示できます。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az ml job archive |
ジョブをアーカイブします。 |
Extension | GA |
az ml job cancel |
ジョブを取り消します。 |
Extension | GA |
az ml job connect-ssh |
SSH 接続を設定し、Tundra を介してユーザーのコンテナー内で実行されている SSH サービスに要求を送信します。 |
Extension | GA |
az ml job create |
ジョブを作成します。 |
Extension | GA |
az ml job download |
ジョブ関連のすべてのファイルをダウンロードします。 |
Extension | GA |
az ml job list |
ワークスペース内のジョブを一覧表示します。 |
Extension | GA |
az ml job restore |
アーカイブされたジョブを復元します。 |
Extension | GA |
az ml job show |
ジョブの詳細を表示します。 |
Extension | GA |
az ml job show-services |
ノードごとのジョブのサービスを表示します。 |
Extension | GA |
az ml job stream |
ジョブ ログをコンソールにストリーミングします。 |
Extension | GA |
az ml job update |
ジョブを更新します。 |
Extension | GA |
az ml job validate |
ジョブを検証します。 このコマンドは、現時点でのみパイプライン ジョブに対して機能します。 |
Extension | GA |
az ml job archive
ジョブをアーカイブします。
ジョブをアーカイブすると、既定ではリスト クエリ (az ml job list
) に表示されなくなります。 引き続きワークフローでアーカイブされたジョブを参照して使用できます。 完了したジョブのみをアーカイブできます。
az ml job archive --name
--resource-group
--workspace-name
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job cancel
ジョブを取り消します。
az ml job cancel --name
--resource-group
--workspace-name
例
名前でジョブを取り消す
az ml job cancel --name my-job-id --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job connect-ssh
SSH 接続を設定し、Tundra を介してユーザーのコンテナー内で実行されている SSH サービスに要求を送信します。
az ml job connect-ssh --name
--resource-group
--workspace-name
[--node-index]
[--private-key-file-path]
例
SSH 接続を設定し、SSH サービスに要求を送信します。
az ml job connect-ssh --name my-job-id --node-index 0 --private-key-file-path "C:/Temp/.ssh/id_rsa" --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ssh 経由で接続するノードのインデックス。
プロパティ | 値 |
---|---|
規定値: | 0 |
秘密キー ファイルファイルへのパス。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job create
ジョブを作成します。
ジョブを作成するには、通常、実行するコード、依存関係をカプセル化する環境、ジョブを実行するコンピューティング ターゲット、およびジョブ固有の追加設定を構成する必要があります。 ジョブが作成されると、指定されたコンピューティング リソースに対して実行のために送信されます。
az ml job create --file
--resource-group
--workspace-name
[--name]
[--save-as]
[--set]
[--skip-validation]
[--stream]
[--web]
例
YAML 仕様ファイルからジョブを作成する
az ml job create --file job.yml --resource-group my-resource-group --workspace-name my-workspace
YAML 仕様ファイルからジョブを作成し、Azure ML Studio ポータルでジョブの実行の詳細を開く
az ml job create --file job.yml --web --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
Azure ML ジョブ仕様を含む YAML ファイルへのローカル パス。 ジョブの YAML リファレンス ドキュメントは、https://aka.ms/ml-cli-v2-job-command-yaml-reference、https://aka.ms/ml-cli-v2-job-sweep-yaml-reference、https://aka.ms/ml-cli-v2-job-pipeline-yaml-referenceにあります。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ジョブの名前。
作成されたジョブの状態を YAML 形式で書き込むファイル。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=value。
リソースの作成で検証をスキップします。 依存リソースは、作成時に検証をスキップしないことに注意してください。
プロパティ | 値 |
---|---|
規定値: | False |
ジョブのログをコンソールにストリーミングするかどうかを示します。
プロパティ | 値 |
---|---|
規定値: | False |
Web ブラウザーで Azure ML Studio でジョブの実行の詳細を表示します。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job download
ジョブ関連のすべてのファイルをダウンロードします。
ファイルは、ジョブの名前にちなんだフォルダーにダウンロードされます。
az ml job download --name
--resource-group
--workspace-name
[--all]
[--download-path]
[--output-name]
例
ジョブのログと出力を現在の作業ディレクトリにダウンロードする
az ml job download --name my-job --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ジョブのすべての出力をダウンロードします。
プロパティ | 値 |
---|---|
規定値: | False |
ジョブ ファイルをダウンロードするパス。 省略すると、ジョブ ファイルが現在のディレクトリにダウンロードされます。
ダウンロードするユーザー定義出力の名前。 これは、ジョブの出力ディクショナリ内のキーに対応している必要があります。 省略すると、ジョブの既定の成果物出力ファイルがダウンロードされます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job list
ワークスペース内のジョブを一覧表示します。
az ml job list --resource-group
--workspace-name
[--all-results {false, true}]
[--archived-only]
[--include-archived]
[--max-results]
[--parent-job-name]
例
--query 引数を使用してワークスペース内のすべてのジョブの状態を一覧表示し、コマンドの結果に対して JMESPath クエリを実行します。
az ml job list --query "[].{Name:name,Jobstatus:status}" --output table --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
すべての結果を返します。
プロパティ | 値 |
---|---|
規定値: | False |
指定可能な値: | false, true |
アーカイブされたジョブのみを一覧表示します。
プロパティ | 値 |
---|---|
規定値: | False |
アーカイブされたジョブとアクティブなジョブを一覧表示します。
プロパティ | 値 |
---|---|
規定値: | False |
返される結果の最大数。 既定値は 50 です。
プロパティ | 値 |
---|---|
規定値: | 50 |
親ジョブの名前。 parent_job_nameが指定された名前と一致するすべてのジョブを一覧表示します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job restore
アーカイブされたジョブを復元します。
アーカイブされたジョブが復元されると、リスト クエリ (az ml job list
) から非表示になることはなくなります。
az ml job restore --name
--resource-group
--workspace-name
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job show
ジョブの詳細を表示します。
az ml job show --name
--resource-group
--workspace-name
[--web]
例
--query 引数を使用して、コマンドの結果に対して JMESPath クエリを実行するジョブの状態を表示します。
az ml job show --name my-job-id --query "{Name:name,Jobstatus:status}" --output table --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Web ブラウザーで Azure ML Studio でジョブの実行の詳細を表示します。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job show-services
ノードごとのジョブのサービスを表示します。
az ml job show-services --name
--resource-group
--workspace-name
[--node-index]
例
--query 引数を使用してノードごとのジョブのサービスを表示し、コマンドの結果に対して JMESPath クエリを実行します。
az ml job show-services --name my-job-id --node-index 0 --query "{Name:name,Jobstatus:status}" --output table --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
サービスを表示する必要があるノードのインデックス。
プロパティ | 値 |
---|---|
規定値: | 0 |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job stream
ジョブ ログをコンソールにストリーミングします。
az ml job stream --name
--resource-group
--workspace-name
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job update
ジョブを更新します。
'tags' プロパティと 'properties' プロパティのみを更新できます。
az ml job update --name
--resource-group
--workspace-name
[--add]
[--force-string]
[--remove]
[--set]
[--web]
必須のパラメーター
ジョブの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | False |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
Web ブラウザーで Azure ML Studio でジョブの実行の詳細を表示します。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az ml job validate
ジョブを検証します。 このコマンドは、現時点でのみパイプライン ジョブに対して機能します。
このコマンドは、YAML 仕様ファイルを検証してジョブの作成に有効かどうかを確認し、検出されたすべての問題を返します。 検証には、主にスキーマのローカル チェックが含まれます。たとえば、不足しているフィールド、バージョンが指定されていない環境、存在しないローカル パスを参照するコードが含まれます。また、ターゲット ワークスペースに参照先のコンピューティング 先が存在するかどうかを確認します。 検証結果は、エラーと警告の両方を含め、コンソールに出力されます。 エラーのみが原因で検証が失敗します。 渡された検証ジョブを送信できます。 このコマンドは、現時点でのみパイプライン ジョブに対して機能します。
az ml job validate --file
--resource-group
--workspace-name
[--set]
例
YAML 仕様ファイルを検証して、ジョブの作成に有効かどうかを確認します。
az ml job validate --file job.yml --resource-group my-resource-group --workspace-name my-workspace
必須のパラメーター
Azure ML ジョブ仕様を含む YAML ファイルへのローカル パス。 ジョブの YAML リファレンス ドキュメントは、https://aka.ms/ml-cli-v2-job-pipeline-yaml-referenceにあります。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure ML ワークスペースの名前。
az configure --defaults workspace=<name>
を使用して既定のワークスペースを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=value。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |