Compartilhar via

az ml model

  • Referência

Nota

Essa referência faz parte da extensão ml para a CLI do Azure (versão 2.15.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando az ml model. Saiba mais sobre extensões.

Gerenciar modelos do Azure ML.

Os modelos do Azure ML consistem nos arquivos binários que representam um modelo de machine learning e quaisquer metadados correspondentes. Esses modelos podem ser usados em implantações de ponto de extremidade para inferência em tempo real e em lote.

Comandos

Nome Description Tipo Status
az ml model archive

Arquive um modelo.

 Extensão GA
az ml model create

Crie um modelo.

 Extensão GA
az ml model download

Baixe todos os arquivos relacionados ao modelo.

 Extensão GA
az ml model list

Listar modelos em um workspace/registro. Se você estiver usando um registro, substitua --workspace-name my-workspace pela opção --registry-name <registry-name>.

 Extensão GA
az ml model package

Empacotar um modelo em um ambiente.

 Extensão Visualizar
az ml model restore

Restaurar um modelo arquivado.

 Extensão GA
az ml model share

Compartilhe um modelo específico do workspace para o registro.

 Extensão GA
az ml model show

Mostrar detalhes de um modelo em um workspace/registro. Se você estiver usando um registro, substitua --workspace-name my-workspace pela opção --registry-name <registry-name>.

 Extensão GA
az ml model update

Atualize um modelo em um workspace/registro.

 Extensão GA

az ml model archive

Arquive um modelo.

O arquivamento de um modelo o ocultará por padrão das consultas de lista (az ml model list). Você ainda pode continuar a referenciar e usar um modelo arquivado em seus fluxos de trabalho. Você pode arquivar um contêiner de modelo ou uma versão de modelo específica. O arquivamento de um contêiner de modelo arquivará todas as versões do modelo com esse nome especificado. Você pode restaurar um modelo arquivado usando az ml model restore. Se todo o contêiner do modelo for arquivado, você não poderá restaurar versões individuais do modelo. Você precisará restaurar o contêiner do modelo.

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

Exemplos

Arquivar um contêiner de modelo (arquiva todas as versões desse modelo)

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

Arquivar uma versão de modelo específica

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

Parâmetros Exigidos

--name -n

Nome do modelo.

Parâmetros Opcionais

--label -l

Rótulo do modelo.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--version -v

Versão do modelo.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model create

Crie um modelo.

Os modelos podem ser criados a partir de um arquivo local, diretório local, armazenamento de dados ou saídas de trabalho. O modelo criado será acompanhado no workspace/registro sob o nome e a versão especificados. Se você estiver usando um registro, substitua --workspace-name my-workspace pela opção --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]

Exemplos

Criar um modelo com base em um arquivo de especificação YAML

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

Criar um modelo de uma pasta local usando opções de comando

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

Criar um modelo usando o formato de URI de execução do mlflow 'runs:/<run-id>/<path-to-model-relative-to-the-root-of-the-artifact-location>' e opções de comando

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

Crie um modelo a partir de uma saída de trabalho nomeada usando o formato de URI do trabalho azureml 'azureml://jobs/<job-name>/outputs/<named-output>/paths/<path-to-model-relative-to-the-named-output-location>' e opções de comando. A saída nomeada padrão é artefatos

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

Criar um modelo de um armazenamento de dados 'azureml://datastores/<datastore-name>/paths/<path-to-model-relative-to-the-root-of-the-datastore-location>' usando opções de comando

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

Parâmetros Opcionais

--datastore

O armazenamento de dados para o qual carregar o artefato local.

--description

Descrição do modelo.

--file -f

Caminho local para o arquivo YAML que contém a especificação do modelo do Azure ML. Os documentos de referência yaml para o modelo podem ser encontrados em: https://aka.ms/ml-cli-v2-model-yaml-reference.

--name -n

Nome do modelo.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valor padrão: False
--path -p

Caminho para os arquivos de modelo. Pode ser um local ou um local remoto. Se especificado, --name/-n e --version/-v também devem ser fornecidos.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=value.

--stage -s

Estágio do modelo.

--tags

Pares chave-valor separados por espaço para as marcas do objeto.

--type -t

Tipo do modelo, os valores permitidos são custom_model, mlflow_model e triton_model. O tipo padrão é custom_model.

--version -v

Versão do modelo.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model download

Baixe todos os arquivos relacionados ao modelo.

Os arquivos serão baixados em uma pasta com o nome do modelo. Se você estiver usando um registro, substitua --workspace-name my-workspace pela opção --registry-name <registry-name>.

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

Exemplos

Baixar um modelo com o nome e a versão especificados

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

Baixar um modelo com o nome e a versão especificados em um caminho local especificado

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

Parâmetros Exigidos

--name -n

Nome do modelo.

--version -v

Versão do modelo.

Parâmetros Opcionais

--download-path -p

Caminho para baixar os arquivos de modelo, padrão para o diretório de trabalho atual.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model list

Listar modelos em um workspace/registro. Se você estiver usando um registro, substitua --workspace-name my-workspace pela opção --registry-name <registry-name>.

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

Exemplos

Listar todos os modelos em um workspace

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

Listar todas as versões do modelo para o nome especificado em um workspace

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

Liste todos os modelos em um workspace usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.

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

Parâmetros Opcionais

--archived-only

Listar somente modelos arquivados.

Valor padrão: False
--include-archived

Listar modelos arquivados e modelos ativos.

Valor padrão: False
--max-results -r

Número máximo de resultados a serem retornados.

--name -n

Nome do modelo. Se fornecido, todas as versões do modelo com esse nome serão retornadas.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--stage -s

Estágio do modelo.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model package

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Empacotar um modelo em um ambiente.

Quando um modelo é empacotado, um ambiente com todas as dependências é criado.

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

Exemplos

Empacotar um modelo com o nome e a versão especificados

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

Parâmetros Exigidos

--file -f

Caminho local para o arquivo YAML que contém a definição do pacote de modelo.

--name -n

Nome do modelo.

--version -v

Versão do modelo.

Parâmetros Opcionais

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model restore

Restaurar um modelo arquivado.

Quando um modelo arquivado é restaurado, ele não será mais oculto das consultas de lista (az ml model list). Se um contêiner de modelo inteiro for arquivado, você poderá restaurar esse contêiner arquivado. Isso restaurará todas as versões do modelo com esse nome especificado. Não é possível restaurar apenas uma versão de modelo específica se todo o contêiner do modelo for arquivado. Você precisará restaurar todo o contêiner. Se apenas uma versão de modelo individual tiver sido arquivada, você poderá restaurar essa versão específica.

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

Exemplos

Restaurar um contêiner de modelo arquivado (restaura todas as versões desse modelo)

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

Restaurar uma versão específica do modelo arquivado

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

Parâmetros Exigidos

--name -n

Nome do modelo.

Parâmetros Opcionais

--label -l

Rótulo do modelo.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--version -v

Versão do modelo.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model share

Compartilhe um modelo específico do workspace para o registro.

Copie um modelo existente de um workspace para um registro para reutilização entre workspaces.

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

Exemplos

Compartilhar um ambiente existente do workspace para o registro

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

Parâmetros Exigidos

--name -n

Nome do modelo.

--registry-name

Registro de destino.

--share-with-name

Nome do modelo com o qual será criado.

--share-with-version

Versão do modelo com o qual será criado.

--version -v

Versão do modelo.

Parâmetros Opcionais

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model show

Mostrar detalhes de um modelo em um workspace/registro. Se você estiver usando um registro, substitua --workspace-name my-workspace pela opção --registry-name <registry-name>.

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

Exemplos

Mostrar detalhes de um modelo com o nome e a versão especificados

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

Parâmetros Exigidos

--name -n

Nome do modelo.

Parâmetros Opcionais

--label -l

Rótulo do modelo.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--version -v

Versão do modelo.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

az ml model update

Atualize um modelo em um workspace/registro.

As propriedades 'description' e 'tags' podem ser atualizadas. Se você estiver usando um registro, substitua --workspace-name my-workspace pela opção --registry-name <registry-name>.

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

Exemplos

Atualizar os sabores de um modelo

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

Parâmetros Exigidos

--name -n

Nome do modelo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Valor padrão: []
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Valor padrão: False
--label -l

Rótulo do modelo.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Valor padrão: []
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Valor padrão: []
--stage -s

Estágio do modelo.

--version -v

Versão do modelo.

--workspace-name -w

Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.