az ml job

  • 參考

注意

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

管理 Azure ML 作業。

Azure ML 作業會針對指定的計算目標執行工作。 您可以將作業設定為在 Azure 上相應放大模型定型。 Azure ML 支援具有不同功能的不同作業類型。 例如，最基本的作業是命令作業，會在 Docker 容器中執行命令，並可用於單一節點和分散式定型。 掃掠作業會在指定的搜尋空間上執行超參數掃掠，以微調模型的超參數。

作業也會為您的 ML 實驗和工作流程啟用系統追蹤。 建立作業之後，Azure ML 會維護作業的執行記錄，其中包含在作業期間產生的元數據、任何計量、記錄和成品、執行的程序代碼，以及所使用的 Azure ML 環境。 您可以在 Azure Machine Learning 工作室中檢視所有作業的執行記錄。

命令

名稱 Description 類型 狀態
az ml job archive

封存作業。

 副檔名 GA
az ml job cancel

取消作業。

 副檔名 GA
az ml job connect-ssh

設定 ssh 連線，並透過 Tundra 將要求傳送至使用者容器內執行的 SSH 服務。

 副檔名 GA
az ml job create

建立 作業。

 副檔名 GA
az ml job download

下載所有作業相關的檔案。

 副檔名 GA
az ml job list

列出工作區中的作業。

 副檔名 GA
az ml job restore

還原封存的作業。

 副檔名 GA
az ml job show

顯示作業的詳細數據。

 副檔名 GA
az ml job show-services

顯示每個節點作業的服務。

 副檔名 GA
az ml job stream

將作業記錄串流至主控台。

 副檔名 GA
az ml job update

更新作業。

 副檔名 GA
az ml job validate

驗證作業。 此命令目前僅適用於管線作業。

 副檔名 GA

az ml job archive

封存作業。

封存作業預設會隱藏於清單查詢中（az ml job list）。 您仍然可以繼續在工作流程中參考和使用封存工作。 只能封存已完成的工作。

az ml job archive --name
                  --resource-group
                  --workspace-name

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

全域參數
--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 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

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

全域參數
--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 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

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--node-index -i

要透過 ssh 連線之節點的索引。

預設值: 0
--private-key-file-path -f

私鑰檔案的路徑。

全域參數
--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 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

必要參數

--file -f

包含 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。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--name -n

作業的名稱。

--save-as -a

將寫入 YAML 格式所建立作業狀態的檔案。

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--skip-validation

在建立資源時略過驗證。 請注意，相依資源不會略過其在建立中的驗證。

預設值: False
--stream -s

指出是否要將作業的記錄串流至主控台。

預設值: False
--web -e

在網頁瀏覽器中，在 Azure ML Studio 中顯示作業的執行詳細數據。

預設值: False
全域參數
--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 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

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--all

下載作業的所有輸出。

預設值: False
--download-path -p

下載作業檔案的路徑。 如果省略，作業檔案將會下載到目前的目錄。

--output-name

要下載的使用者定義輸出名稱。 這應該會對應至作業輸出字典中的索引鍵。 如果省略，則會下載作業的預設成品輸出檔案。

全域參數
--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 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

必要參數

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--all-results

傳回所有結果。

接受的值: false, true
預設值: False
--archived-only

僅列出封存的作業。

預設值: False
--include-archived

列出封存的作業和作用中作業。

預設值: False
--max-results -r

要傳回的結果數目上限。 預設值為 50。

預設值: 50
--parent-job-name -p

父作業的名稱。 會列出parent_job_name符合指定名稱的所有作業。

全域參數
--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 job restore

還原封存的作業。

還原封存作業時，不會再從清單查詢中隱藏它 。az ml job list。

az ml job restore --name
                  --resource-group
                  --workspace-name

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

全域參數
--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 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

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--web -e

在網頁瀏覽器中，在 Azure ML Studio 中顯示作業的執行詳細數據。

預設值: False
全域參數
--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 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

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--node-index -i

服務必須顯示之節點的索引。

預設值: 0
全域參數
--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 job stream

將作業記錄串流至主控台。

az ml job stream --name
                 --resource-group
                 --workspace-name

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

全域參數
--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 job update

更新作業。

只能更新 'tags' 和 'properties' 屬性。

az ml job update --name
                 --resource-group
                 --workspace-name
                 [--add]
                 [--force-string]
                 [--remove]
                 [--set]
                 [--web]

必要參數

--name -n

作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。

預設值: []
--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

預設值: False
--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

預設值: []
--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。

預設值: []
--web -e

在網頁瀏覽器中，在 Azure ML Studio 中顯示作業的執行詳細數據。

預設值: False
全域參數
--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 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

必要參數

--file -f

包含 Azure ML 作業規格之 YAML 檔案的本機路徑。 作業的 YAML 參考檔位於： https://aka.ms/ml-cli-v2-job-pipeline-yaml-reference。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--workspace-name -w

Azure ML 工作區的名稱。 您可以使用 來設定預設工作區 az configure --defaults workspace=<name>。

選擇性參數

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

全域參數
--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 來取得完整偵錯記錄。