Partilhar via

az ml component

  • 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 será instalada automaticamente na primeira vez que você executar um comando az ml component. Saiba mais sobre extensões.

Gerencie componentes do Azure ML.

O componente Azure ML define a configuração do componente para trabalhos de pipeline. Você pode configurar as portas de entrada/saída, ambiente de execução e comando do componente. Depois que o componente for criado, você poderá fazer referência aos componentes no trabalho de pipeline para executá-los em contêineres do docker.

Comandos

Name Description Tipo Status
az ml component archive

Arquivar um componente.

 Extensão GA
az ml component create

Crie um componente.

 Extensão GA
az ml component list

Listar componentes em um espaço de trabalho.

 Extensão GA
az ml component restore

Restaure 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) suportam atualização.

 Extensão GA

az ml component archive

Arquivar um componente.

O arquivamento de um componente o ocultará por padrão das consultas de lista (az ml component list). Você ainda pode continuar a fazer referência e usar um componente arquivado em seus pipelines. Você pode arquivar um contêiner de componente ou uma versão específica do componente. O arquivamento de um contêiner de componente arquivará todas as versões do componente com esse nome próprio. Você pode restaurar um componente arquivado usando az ml component restoreo . Se todo o contêiner do componente for arquivado, você não poderá restaurar versões individuais do componente - será necessário 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 Obrigatórios

--name -n

Nome do componente.

Parâmetros Opcionais

--label -l

Rótulo do componente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--version -v

Versão do componente.

--workspace-name -w

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 a partir de 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 a partir 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 Obrigatórios

--file -f

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

Parâmetros Opcionais

--name -n

Nome do componente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

o 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=.

--skip-validation

Ignore a validação na criação do recurso. Observe que os recursos dependentes não ignorarão sua validação na criação.

Default value: False
--version -v

Versão do componente.

--workspace-name -w

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az ml component list

Listar componentes em um espaço de trabalho.

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

Exemplos

Listar todos os componentes em um espaço de trabalho

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

Listar todas as versões de componentes para o nome especificado em um espaço de trabalho

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

Liste todos os componentes em um espaço de trabalho 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 de componentes 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

--archived-only

Liste apenas componentes arquivados.

Default value: False
--include-archived

Listar componentes arquivados e componentes ativos.

Default value: False
--max-results -r

Número máximo de resultados a retornar.

--name -n

Nome do componente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--workspace-name -w

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az ml component restore

Restaure um componente arquivado.

Quando um componente arquivado é 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 sob esse nome fornecido. Não é possível restaurar apenas uma versão específica do componente se todo o contêiner do componente estiver arquivado - você precisará restaurar o contêiner inteiro. Se apenas uma versão de componente individual foi arquivada, você pode 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 Obrigatórios

--name -n

Nome do componente.

Parâmetros Opcionais

--label -l

Rótulo do componente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--version -v

Versão do componente.

--workspace-name -w

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 de 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 Obrigatórios

--name -n

Nome do componente.

Parâmetros Opcionais

--label -l

Rótulo do componente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--version -v

Versão do componente.

--workspace-name -w

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az ml component update

Atualize um componente. Atualmente, apenas alguns campos (descrição, display_name) suportam 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 Obrigatórios

--name -n

Nome do componente.

--resource-group -g

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

--workspace-name -w

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

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

Default value: []
--force-string

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

Default value: False
--label -l

Rótulo do componente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--remove

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

Default value: []
--set

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

Default value: []
--version -v

Versão do componente.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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