az ml run

注意

此參考是 Azure CLI 的 azure-cli-ml 延伸模組的一部分（2.0.28 版或更高版本）。 擴充功能會在您第一次執行 az ml run 命令時自動安裝。 深入了解擴充功能。

提交、更新和監視執行的命令。

命令

名稱	Description	類型	狀態
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	從已發佈的管線標識碼或管線 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

指定訂用帳戶標識碼。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

指定訂用帳戶標識碼。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

父執行標識碼。

--path

執行組態檔的根目錄路徑。

預設值: .

--pipeline-run-id

管線執行標識碼。

--resource-group -g

資源組名。

--status

執行的狀態。

接受的值: Completed, Failed, Finalizing, Preparing, Provisioning, Queued, Running, Starting

--subscription-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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

指定訂用帳戶標識碼。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

本機目錄以暫存要監視的張量板檔案。

--output-metadata-file -t

提供結構化物件輸出的選擇性輸出檔位置。

--path

執行組態檔的根目錄路徑。

預設值: .

--resource-group -g

資源組名。

--subscription-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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

指定訂用帳戶標識碼。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

Hyperdrive 組態檔的完整名稱。 檔案應該位於 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

指定訂用帳戶標識碼。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az ml run submit-pipeline

從已發佈的管線標識碼或管線 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

datapath 參數指派的名稱=資料存放區/路徑組逗號分隔清單。

--experiment-name -n

執行提交的實驗名稱。 如果未指定，請使用管線名稱。

--output-metadata-file -t

提供結構化物件輸出的選擇性輸出檔位置。

--output_file -f

以 JSON 格式寫入輸出的檔案。

--parameters -p

管線參數指派的名稱=值組逗號分隔清單。

--path

執行組態檔的根目錄路徑。

預設值: .

--pipeline-id -i

要提交之管線的標識碼（guid）。

--pipeline-yaml -y

定義管線的 YAML 檔案。

--resource-group -g

資源組名。

--subscription-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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

指定訂用帳戶標識碼。

--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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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]' 語法標記 entitiy。

--experiment-name -e

實驗名稱。

--output-metadata-file -t

提供結構化物件輸出的選擇性輸出檔位置。

--path

執行組態檔的根目錄路徑。

預設值: .

--resource-group -g

資源組名。

--subscription-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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。