az ml component
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 component. Saiba mais sobre extensões.
Gerenciar componentes do Azure ML.
O componente do Azure ML define a configuração do componente para trabalhos de pipeline. Você pode configurar as portas de entrada/saída, o ambiente de execução e o comando do componente. Depois que o componente for criado, você poderá referenciar os componentes no trabalho de pipeline para executá-los em contêineres do Docker.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az ml component archive |
Arquive um componente. |
Extensão | GA |
az ml component create |
Crie um componente. |
Extensão | GA |
az ml component list |
Listar componentes em um workspace. |
Extensão | GA |
az ml component prepare-for-sign |
Prepare um componente para assinatura. |
Extensão | GA |
az ml component restore |
Restaurar um componente arquivado. |
Extensão | GA |
az ml component show |
Mostrar detalhes de um componente. |
Extensão | GA |
az ml component update |
Atualize um componente. Atualmente, apenas alguns campos (descrição, display_name) dão suporte à atualização. |
Extensão | GA |
az ml component archive
Arquive um componente.
O arquivamento de um componente o ocultará por padrão de consultas de lista (az ml component list
). Você ainda pode continuar a referenciar e usar um componente arquivado em seus pipelines. Você pode arquivar um contêiner de componentes ou uma versão de componente específica. O arquivamento de um contêiner de componente arquivará todas as versões do componente com esse nome especificado. Você pode restaurar um componente arquivado usando az ml component restore
. Se todo o contêiner de componentes for arquivado, você não poderá restaurar versões individuais do componente. Você precisará restaurar o contêiner do componente.
az ml component archive --name
[--label]
[--registry-name]
[--resource-group]
[--version]
[--workspace-name]
Exemplos
Arquivar um contêiner de componente (arquiva todas as versões desse componente)
az ml component archive --name my-component --resource-group my-resource-group --workspace-name my-workspace
Arquivar uma versão específica do componente
az ml component archive --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace
Parâmetros Exigidos
Nome do componente.
Parâmetros Opcionais
Rótulo do componente.
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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Versão do componente.
Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>
.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az ml component create
Crie um componente.
az ml component create --file
[--name]
[--registry-name]
[--resource-group]
[--set]
[--skip-validation]
[--version]
[--workspace-name]
Exemplos
Criar um componente com base em um arquivo de especificação YAML
az ml component create --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace
Criar um componente de um arquivo de especificação YAML com a versão especificada
az ml component create --file my_component.yml --version 1 --resource-group my-resource-group --workspace-name my-workspace
Criar um componente no registro a partir de um arquivo de especificação YAML
az ml component create --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group
Criar um componente no registro a partir de um arquivo de especificação YAML com a versão especificada
az ml component create --file my_component.yml --version 1 --registry-name my-registry-name --resource-group my-resource-group
Parâmetros Exigidos
Caminho local para o arquivo YAML que contém a especificação do componente do Azure ML. Os documentos de referência yaml para componente podem ser encontrados em: https://aka.ms/ml-cli-v2-component-command-yaml-reference.
Parâmetros Opcionais
Nome do componente.
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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=value.
Ignore a validação na criação do recurso. Observe que os recursos dependentes não ignorarão a validação na criação.
Versão do componente.
Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>
.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az ml component list
Listar componentes em um workspace.
az ml component list [--archived-only]
[--include-archived]
[--max-results]
[--name]
[--registry-name]
[--resource-group]
[--workspace-name]
Exemplos
Listar todos os componentes em um workspace
az ml component list --resource-group my-resource-group --workspace-name my-workspace
Listar todas as versões do componente para o nome especificado em um workspace
az ml component list --name my-component --resource-group my-resource-group --workspace-name my-workspace
Liste todos os componentes em um workspace usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.
az ml component list --query "[].{Name:name}" --output table --resource-group my-resource-group --workspace-name my-workspace
Listar todos os componentes em um registro
az ml component list --registry-name my-registry-name --resource-group my-resource-group
Listar todas as versões do componente para o nome especificado em um registro
az ml component list --name my-component --registry-name my-registry-name --resource-group my-resource-group
Liste todos os componentes em um registro usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.
az ml component list --query "[].{Name:name}" --output table --registry-name my-registry-name --resource-group my-resource-group
Parâmetros Opcionais
Listar somente componentes arquivados.
Listar componentes arquivados e componentes ativos.
Número máximo de resultados a serem retornados.
Nome do componente.
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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>
.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az ml component prepare-for-sign
Prepare um componente para assinatura.
Preparar um componente para o sinal gera dois arquivos: catalog.json e catalog.json.sig, esses arquivos contêm o SHA256 gerado para cada arquivo que está presente na pasta de destino. Se os arquivos já estiverem presentes, eles serão excluídos e novos arquivos serão criados com a assinatura atualizada.
az ml component prepare-for-sign --file
[--registry-name]
[--resource-group]
[--workspace-name]
Exemplos
Preparar um componente de um arquivo de especificação YAML para assinatura
az ml component prepare-for-sign --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace
Preparar um componente no registro de um arquivo de especificação YAML para assinatura
az ml component prepare-for-sign --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group
Parâmetros Exigidos
Caminho local para o arquivo YAML que contém a especificação do componente do Azure ML. Os documentos de referência yaml para componente podem ser encontrados em: https://aka.ms/ml-cli-v2-component-command-yaml-reference.
Parâmetros Opcionais
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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>
.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az ml component restore
Restaurar um componente arquivado.
Quando um componente arquivado for restaurado, ele não ficará mais oculto das consultas de lista (az ml component list
). Se um contêiner de componente inteiro for arquivado, você poderá restaurar esse contêiner arquivado. Isso restaurará todas as versões do componente com esse nome especificado. Não é possível restaurar apenas uma versão de componente específica se todo o contêiner de componentes for arquivado. Você precisará restaurar todo o contêiner. Se apenas uma versão de componente individual tiver sido arquivada, você poderá restaurar essa versão específica.
az ml component restore --name
[--label]
[--registry-name]
[--resource-group]
[--version]
[--workspace-name]
Exemplos
Restaurar um contêiner de componente arquivado (restaura todas as versões desse componente)
az ml component restore --name my-component --resource-group my-resource-group --workspace-name my-workspace
Restaurar uma versão específica do componente arquivado
az ml component restore --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace
Parâmetros Exigidos
Nome do componente.
Parâmetros Opcionais
Rótulo do componente.
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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Versão do componente.
Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>
.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az ml component show
Mostrar detalhes de um componente.
az ml component show --name
[--label]
[--registry-name]
[--resource-group]
[--version]
[--workspace-name]
Exemplos
Mostrar detalhes para um componente com o nome e a versão especificados
az ml component show --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace
Mostrar detalhes de um componente no Registro com o nome e a versão especificados
az ml component show --name my-component --version 1 --registry-name my-registry-name --resource-group my-resource-group
Parâmetros Exigidos
Nome do componente.
Parâmetros Opcionais
Rótulo do componente.
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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Versão do componente.
Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>
.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az ml component update
Atualize um componente. Atualmente, apenas alguns campos (descrição, display_name) dão suporte à atualização.
az ml component update --name
--resource-group
--workspace-name
[--add]
[--force-string]
[--label]
[--registry-name]
[--remove]
[--set]
[--version]
Exemplos
Atualizar a descrição de um componente
az ml component update -n my_component -v 1 --set description="new description" -g my-resource-group -w my-workspace
Parâmetros Exigidos
Nome do componente.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>
.
Parâmetros Opcionais
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>
.
Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.
Rótulo do componente.
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.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>
.
Versão do componente.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.