az ml run

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.0.28 以降) の azure-cli-ml 拡張機能の一部です。 拡張機能は、az ml run コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

実行を送信、更新、および監視するためのコマンド。

コマンド

名前 説明 型 Status
az ml run cancel

実行を取り消します。

 拡張子 GA
az ml run download-logs

ログ ファイルをダウンロードします。

 拡張子 GA
az ml run list

実行の一覧を表示します。

 拡張子 GA
az ml run monitor-logs

既存の実行のログを監視します。

 拡張子 GA
az ml run monitor-tensorboard

tensorboard を使用して既存の実行を監視します。

 拡張子 GA
az ml run show

実行を表示します。

 拡張子 GA
az ml run submit-hyperdrive

実行構成を使用してハイパー パラメーター スイープを送信します。

 拡張子 GA
az ml run submit-pipeline

発行されたパイプライン ID またはパイプライン YAML ファイルから、実行用のパイプラインを送信します。

 拡張子 GA
az ml run submit-script

実行するスクリプトを送信します。

 拡張子 GA
az ml run update

タグを追加して実行を更新します。

 拡張子 GA

az ml run cancel

実行を取り消します。

az ml run cancel --run
                 [--experiment-name]
                 [--output-metadata-file]
                 [--path]
                 [--resource-group]
                 [--subscription-id]
                 [--workspace-name]

必須のパラメーター

--run -r

実験の実行の runId。

省略可能のパラメーター

--experiment-name -e

実験名。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run download-logs

ログ ファイルをダウンロードします。

az ml run download-logs --output-dir
                        --run
                        [--experiment-name]
                        [--output-metadata-file]
                        [--path]
                        [--resource-group]
                        [--subscription-id]
                        [--workspace-name]

必須のパラメーター

--output-dir -d

ログ ファイルをダウンロードする出力ディレクトリ。

--run -r

実験の実行の runId。

省略可能のパラメーター

--experiment-name -e

実験名。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run list

実行の一覧を表示します。

az ml run list [--compute-target-name]
               [--experiment-name]
               [--last]
               [--minimal]
               [--output-metadata-file]
               [--parent-run-id]
               [--path]
               [--pipeline-run-id]
               [--resource-group]
               [--status {Completed, Failed, Finalizing, Preparing, Provisioning, Queued, Running, Starting}]
               [--subscription-id]
               [--tags]
               [--workspace-name]

省略可能のパラメーター

--compute-target-name

コンピューティング 先の名前。

--experiment-name -e

実験名。

--last

最新の N 個の要素をフェッチします。

既定値: 10
--minimal

実行出力の最小プロパティを指定するフラグ。

既定値: False
--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--parent-run-id

親実行 ID。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--pipeline-run-id

パイプライン実行 ID。

--resource-group -g

リソース グループ名。

--status

実行の状態。

承認された値: Completed, Failed, Finalizing, Preparing, Provisioning, Queued, Running, Starting
--subscription-id

サブスクリプション ID を指定します。

--tags

'key[=value]' 構文を使用した実行のタグ。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run monitor-logs

既存の実行のログを監視します。

az ml run monitor-logs --run
                       [--experiment-name]
                       [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--workspace-name]

必須のパラメーター

--run -r

実験の実行の runId。

省略可能のパラメーター

--experiment-name -e

実験名。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run monitor-tensorboard

tensorboard を使用して既存の実行を監視します。

az ml run monitor-tensorboard --run
                              [--experiment-name]
                              [--local-directory]
                              [--output-metadata-file]
                              [--path]
                              [--resource-group]
                              [--subscription-id]
                              [--workspace-name]

必須のパラメーター

--run -r

実験の実行の runId。

省略可能のパラメーター

--experiment-name -e

実験名。

--local-directory

監視対象の tensorboard ファイルをステージングするローカル ディレクトリ。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run show

実行を表示します。

az ml run show --run
               [--experiment-name]
               [--output-metadata-file]
               [--path]
               [--resource-group]
               [--subscription-id]
               [--workspace-name]

必須のパラメーター

--run -r

実験の実行の runId。

省略可能のパラメーター

--experiment-name -e

実験名。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run submit-hyperdrive

実行構成を使用してハイパー パラメーター スイープを送信します。

az ml run submit-hyperdrive --hyperdrive-configuration-name
                            [--async]
                            [--conda-dependencies]
                            [--ct]
                            [--experiment-name]
                            [--output-metadata-file]
                            [--path]
                            [--resource-group]
                            [--run-configuration-name]
                            [--source-directory]
                            [--subscription-id]
                            [--workspace-name]
                            [<USER_SCRIPT_AND_ARGUMENTS>]

必須のパラメーター

--hyperdrive-configuration-name

ハイパードライブ構成ファイルの完全な名前。 ファイルは、path パラメーターで指定されたディレクトリのサブフォルダー内に存在する必要があります。

省略可能のパラメーター

--async

出力ストリーミングを無効にします。

既定値: False
--conda-dependencies -d

既定の Conda 依存関係ファイルをオーバーライドします。

--ct --target

実行に使用するコンピューティング 先の名前。

--experiment-name -e

実験名。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--run-configuration-name -c

実行構成ファイルの名前 (拡張子なし)。 ファイルは、path パラメーターで指定されたディレクトリのサブフォルダー内に存在する必要があります。

--source-directory

ソース コード ファイルを含むローカル ディレクトリ。 ソース ディレクトリが指定されていない場合は、既定で path に設定されます。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

<USER_SCRIPT_AND_ARGUMENTS>

スクリプト名やスクリプト引数などの実行送信引数。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run submit-pipeline

発行されたパイプライン ID またはパイプライン YAML ファイルから、実行用のパイプラインを送信します。

az ml run submit-pipeline [--datapaths]
                          [--experiment-name]
                          [--output-metadata-file]
                          [--output_file]
                          [--parameters]
                          [--path]
                          [--pipeline-id]
                          [--pipeline-yaml]
                          [--resource-group]
                          [--subscription-id]
                          [--workspace-name]

省略可能のパラメーター

--datapaths -d

データパス パラメーターの割り当ての name=datastore/path ペアのコンマ区切りのリスト。

--experiment-name -n

実行送信の実験名。 指定されていない場合は、パイプライン名を使用します。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--output_file -f

JSON 形式で出力を書き込むファイル。

--parameters -p

パイプライン パラメーターの割り当ての名前と値のペアのコンマ区切りのリスト。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--pipeline-id -i

送信するパイプラインの ID (guid)。

--pipeline-yaml -y

パイプラインを定義する YAML ファイル。

--resource-group -g

リソース グループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run submit-script

実行するスクリプトを送信します。

az ml run submit-script [--async]
                        [--conda-dependencies]
                        [--ct]
                        [--experiment-name]
                        [--output-metadata-file]
                        [--path]
                        [--resource-group]
                        [--run-configuration-name]
                        [--source-directory]
                        [--subscription-id]
                        [--workspace-name]
                        [<USER_SCRIPT_AND_ARGUMENTS>]

省略可能のパラメーター

--async

出力ストリーミングを無効にします。

既定値: False
--conda-dependencies -d

既定の Conda 依存関係ファイルをオーバーライドします。

--ct --target

実行に使用するコンピューティング 先の名前。

--experiment-name -e

実験名。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--run-configuration-name -c

実行構成ファイルの名前 (拡張子なし)。 ファイルは、path パラメーターで指定されたディレクトリのサブフォルダー内に存在する必要があります。

--source-directory

ソース コード ファイルを含むローカル ディレクトリ。 ソース ディレクトリが指定されていない場合は、既定で path に設定されます。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

<USER_SCRIPT_AND_ARGUMENTS>

スクリプト名やスクリプト引数などの実行送信引数。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml run update

タグを追加して実行を更新します。

az ml run update --run
                 [--add-tag]
                 [--experiment-name]
                 [--output-metadata-file]
                 [--path]
                 [--resource-group]
                 [--subscription-id]
                 [--workspace-name]

必須のパラメーター

--run -r

実験の実行の runId。

省略可能のパラメーター

--add-tag

'key[=value]' 構文でエンティティにタグを付けてください。

--experiment-name -e

実験名。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルート ディレクトリへのパス。

既定値: .
--resource-group -g

リソース グループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。