az ml model

注意

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

管理 Azure ML 模型。

Azure ML 模型是由二進位檔所組成，代表機器學習模型和任何對應的元數據。 這些模型可用於端點部署，以進行即時和批次推斷。

命令

名稱	Description	類型	狀態
az ml model archive	封存模型。	副檔名	GA
az ml model create	建立模型。	副檔名	GA
az ml model download	下載所有模型相關檔案。	副檔名	GA
az ml model list	列出工作區/登錄中的模型。 如果您使用登錄，請將 取代 --workspace-name my-workspace 為 --registry-name <registry-name> 選項。	副檔名	GA
az ml model package	將模型封裝到環境中。	副檔名	預覽​​
az ml model restore	還原封存的模型。	副檔名	GA
az ml model share	從工作區共用特定模型到登錄。	副檔名	GA
az ml model show	在工作區/登錄中顯示模型的詳細數據。 如果您使用登錄，請將 取代 --workspace-name my-workspace 為 --registry-name <registry-name> 選項。	副檔名	GA
az ml model update	更新工作區/登錄中的模型。	副檔名	GA

az ml model archive

封存模型。

封存模型預設會隱藏在清單查詢中（az ml model list）。 您仍然可以繼續參考並使用工作流程中的封存模型。 您可以封存模型容器或特定模型版本。 封存模型容器將會封存該指定名稱下模型的所有版本。 您可以使用 來還原封存的模型 az ml model restore。 如果整個模型容器已封存，則您無法還原模型的個別版本 - 您必須還原模型容器。

az ml model archive --name
                    [--label]
                    [--registry-name]
                    [--resource-group]
                    [--version]
                    [--workspace-name]

範例

封存模型容器（封存該模型的所有版本）

az ml model archive --name my-model --resource-group my-resource-group --workspace-name my-workspace

封存特定模型版本

az ml model archive --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

模型的名稱。

選擇性參數

--label -l

模型的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--version -v

模型的版本。

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

建立模型。

您可以從本機檔案、本機目錄、資料存放區或作業輸出建立模型。 建立的模型將會在工作區/登錄的指定名稱和版本下追蹤。 如果您使用登錄，請將 取代 --workspace-name my-workspace 為 --registry-name <registry-name> 選項。

az ml model create [--datastore]
                   [--description]
                   [--file]
                   [--name]
                   [--no-wait]
                   [--path]
                   [--registry-name]
                   [--resource-group]
                   [--set]
                   [--stage]
                   [--tags]
                   [--type]
                   [--version]
                   [--workspace-name]

範例

從 YAML 規格檔案建立模型

az ml model create --file model.yml --resource-group my-resource-group --workspace-name my-workspace

使用命令選項從本機資料夾建立模型

az ml model create --name my-model --version 1 --path ./my-model --resource-group my-resource-group --workspace-name my-workspace

使用 mlflow 執行 URI 格式 'run：/<run-id>/<path-to-model-relative-to-the-root-of-the-artifact-location>' 和命令選項建立模型

az ml model create --name my-model --version 1 --path runs:/c42d2507-4953-4a7c-a4c1-2b5bfe0ac64e/model/ --type mlflow_model --resource-group my-resource-group --workspace-name my-workspace

使用 azureml 作業 URI 格式 'azureml://jobs/<job-name>/outputs/<named-output>/path/<path-to-model-relative-to-the-named-output-location>' 和命令選項，從具名作業輸出建立模型。 預設的具名輸出是成品

az ml model create --name my-model --version 1 --path azureml://jobs/c42d2507-4953-4a7c-a4c1-2b5bfe0ac64e/outputs/artifacts/paths/model/ --resource-group my-resource-group --workspace-name my-workspace

使用命令選項從資料存放區 『azureml://datastores/<datastore-name>/path/<path-to-model-relative-to-the-root-of-the-datastore-location>' 建立模型

az ml model create --name my-model --version 1 --path azureml://datastores/myblobstore/paths/models/cifar10/cifar.pt --resource-group my-resource-group --workspace-name my-workspace

選擇性參數

--datastore

要上傳本機成品的數據存放區。

--description

模型的描述。

--file -f

包含 Azure ML 模型規格之 YAML 檔案的本機路徑。 如需模型的 YAML 參考檔，請參閱： https://aka.ms/ml-cli-v2-model-yaml-reference。

--name -n

模型的名稱。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--path -p

模型檔案的路徑。 這可以是本機或遠端位置。 如果指定，也必須提供 --name/-n 和 --version/-v。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--set

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

--stage -s

模型的階段。

--tags

對象標記的空間分隔索引鍵/值組。

--type -t

模型的類型、允許的值是custom_model、mlflow_model和triton_model。 默認類型為 custom_model。

--version -v

模型的版本。

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

下載所有模型相關檔案。

檔案將會下載到以模型名稱命名的資料夾。 如果您使用登錄，請將 取代 --workspace-name my-workspace 為 --registry-name <registry-name> 選項。

az ml model download --name
                     --version
                     [--download-path]
                     [--registry-name]
                     [--resource-group]
                     [--workspace-name]

範例

下載具有指定名稱和版本的模型

az ml model download --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

將具有指定名稱和版本的模型下載至指定的本機路徑

az ml model download --name my-model --version 1  --download-path local_path --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

模型的名稱。

--version -v

模型的版本。

選擇性參數

--download-path -p

下載模型檔案的路徑，預設為目前的工作目錄。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

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

列出工作區/登錄中的模型。 如果您使用登錄，請將 取代 --workspace-name my-workspace 為 --registry-name <registry-name> 選項。

az ml model list [--archived-only]
                 [--include-archived]
                 [--max-results]
                 [--name]
                 [--registry-name]
                 [--resource-group]
                 [--stage]
                 [--workspace-name]

範例

列出工作區中的所有模型

az ml model list --resource-group my-resource-group --workspace-name my-workspace

列出工作區中指定名稱的所有模型版本

az ml model list --name my-model --resource-group my-resource-group --workspace-name my-workspace

使用 --query 自變數列出工作區中的所有模型，以在命令的結果上執行 JMESPath 查詢。

az ml model list --query "[].{Name:name}"  --output table --resource-group my-resource-group --workspace-name my-workspace

選擇性參數

--archived-only

僅列出封存的模型。

預設值: False

--include-archived

列出封存的模型和使用中模型。

預設值: False

--max-results -r

要傳回的結果數目上限。

--name -n

模型的名稱。 如果提供，則會傳回此名稱下的所有模型版本。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--stage -s

模型的階段。

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

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

將模型封裝到環境中。

封裝模型時，會建立具有所有相依性的環境。

az ml model package --file
                    --name
                    --version
                    [--registry-name]
                    [--resource-group]
                    [--workspace-name]

範例

使用指定的名稱和版本封裝模型

az ml model package --name my-model --version my-version --resource-group my-resource-group --workspace-name my-workspace --file my-package.yml

必要參數

--file -f

包含模型套件定義的 YAML 檔案本機路徑。

--name -n

模型的名稱。

--version -v

模型的版本。

選擇性參數

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

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

還原封存的模型。

還原封存模型時，不會再從清單查詢中隱藏它 。az ml model list。 如果整個模型容器已封存，您可以還原該封存的容器。 這會還原該指定名稱下的所有模型版本。 如果整個模型容器已封存，您就不能只還原特定模型版本，您必須還原整個容器。 如果只封存個別的模型版本，您可以還原該特定版本。

az ml model restore --name
                    [--label]
                    [--registry-name]
                    [--resource-group]
                    [--version]
                    [--workspace-name]

範例

還原封存的模型容器（還原該模型的所有版本）

az ml model restore --name my-model --resource-group my-resource-group --workspace-name my-workspace

還原特定的封存模型版本

az ml model restore --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

模型的名稱。

選擇性參數

--label -l

模型的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--version -v

模型的版本。

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

從工作區共用特定模型到登錄。

將現有的模型從工作區複製到登錄，以便重複使用跨工作區。

az ml model share --name
                  --registry-name
                  --share-with-name
                  --share-with-version
                  --version
                  [--resource-group]
                  [--workspace-name]

範例

將現有的環境從工作區共用至登錄

az ml model share --name my-model --version my-version --resource-group my-resource-group --workspace-name my-workspace --share-with-name new-name-in-registry --share-with-version new-version-in-registry --registry-name my-registry

必要參數

--name -n

模型的名稱。

--registry-name

目的地登錄。

--share-with-name

要用來建立的模型名稱。

--share-with-version

要建立的模型版本。

--version -v

模型的版本。

選擇性參數

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

在工作區/登錄中顯示模型的詳細數據。 如果您使用登錄，請將 取代 --workspace-name my-workspace 為 --registry-name <registry-name> 選項。

az ml model show --name
                 [--label]
                 [--registry-name]
                 [--resource-group]
                 [--version]
                 [--workspace-name]

範例

顯示具有指定名稱和版本之模型的詳細數據

az ml model show --name my-model --version 1 --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

模型的名稱。

選擇性參數

--label -l

模型的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--resource-group -g

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

--version -v

模型的版本。

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

更新工作區/登錄中的模型。

可以更新 'description' 和 'tags' 屬性。 如果您使用登錄，請將 取代 --workspace-name my-workspace 為 --registry-name <registry-name> 選項。

az ml model update --name
                   --resource-group
                   [--add]
                   [--force-string]
                   [--label]
                   [--registry-name]
                   [--remove]
                   [--set]
                   [--stage]
                   [--version]
                   [--workspace-name]

範例

更新模型的口味

az ml model update --name my-model --version 1 --set flavors.python_function.python_version=3.8 --resource-group my-resource-group --workspace-name my-workspace

必要參數

--name -n

模型的名稱。

--resource-group -g

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

選擇性參數

--add

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

預設值: []

--force-string

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

預設值: False

--label -l

模型的標籤。

--registry-name

如果提供，命令會以登錄為目標，而不是工作區。 因此，不需要資源群組和工作區。

--remove

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

預設值: []

--set

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

預設值: []

--stage -s

模型的階段。

--version -v

模型的版本。

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