Compartilhar via


Esquema YAML do componente de pipeline da CLI (v2)

APLICA-SE A: Extensão de ML da CLI do Azurev2 (atual)

O esquema JSON de origem pode ser encontrado em https://azuremlschemas.azureedge.net/latest/pipelineComponent.schema.json.

Observação

A sintaxe YAML detalhada neste documento baseia-se no esquema JSON da última versão da extensão de ML da CLI v2. Essa sintaxe só tem a garantia de funcionar com a última versão da extensão de ML da CLI v2. Encontre os esquemas para as versões mais antigas da extensão em https://azuremlschemasprod.azureedge.net/.

Sintaxe YAML

Chave Type Descrição Valores permitidos Valor padrão
$schema string O esquema YAML. Se você usar a extensão do Azure Machine Learning para VS Code para criar o arquivo YAML, a inclusão de $schema no início do arquivo permitirá invocar conclusões de esquema e recursos.
type const O tipo de componente. pipeline pipeline
name string Obrigatórios. Nome do componente. Deve começar com letra minúscula. Os caracteres permitidos são letras minúsculas, números e sublinhado (_). O comprimento máximo é de 255 caracteres.
version string A versão do componente. Se isso for omitido, o Azure Machine Learning vai gerar uma versão automaticamente.
display_name string Nome de exibição do componente na interface do usuário no estúdio. Pode ser não exclusivo dentro do workspace.
description string Descrição do componente.
tags objeto Dicionário de marcas para o componente.
jobs objeto Obrigatórios. Dicionário do conjunto de trabalhos individuais a serem executados como etapas no pipeline. Esses trabalhos são considerados trabalhos filho do trabalho do pipeline pai.

A chave é o nome da etapa no contexto do trabalho de pipeline. Esse nome é diferente do nome de trabalho exclusivo do trabalho filho. O valor é a especificação de trabalho, que pode seguir o esquema do trabalho de comando ou o esquema do trabalho de sweep. Atualmente, somente trabalhos de comando e de sweep podem ser executados em um pipeline.
inputs objeto Dicionário de entradas para o trabalho de pipeline. A chave é um nome para a entrada dentro do contexto do trabalho e o valor é o valor de entrada.

Essas entradas de pipeline podem ser referenciadas pelas entradas de um trabalho de etapa individual no pipeline por meio da expressão ${{ parent.inputs.<input_name> }}. Para obter mais informações sobre como associar as entradas de uma etapa de pipeline às entradas do trabalho de pipeline de nível superior, consulte a sintaxe Expression para associar entradas e saídas entre as etapas em um trabalho de pipeline.
inputs.<input_name> número, número inteiro, booliano, cadeia de caracteres ou objeto Um dos valores literais (de número de tipo, inteiro, booliano ou cadeia de caracteres) ou um objeto que contém uma especificação de dados de entrada de componente.
outputs objeto Dicionário de configurações de saída do trabalho de pipeline. A chave é um nome para a saída dentro do contexto do trabalho e o valor é a configuração de saída.

Essas saídas de pipeline podem ser referenciadas pelas saídas de um trabalho de etapa individual no pipeline por meio da expressão ${{ parents.outputs.<output_name> }}. Para obter mais informações sobre como associar as entradas de uma etapa de pipeline às entradas do trabalho de pipeline de nível superior, consulte a sintaxe Expression para associar entradas e saídas entre as etapas em um trabalho de pipeline.
outputs.<output_name> objeto Você pode deixar o objeto vazio. Nesse caso, a saída será do tipo uri_folder por padrão e o Azure Machine Learning vai gerar pelo sistema um local de saída para a saída com base no seguinte caminho de modelo: {settings.datastore}/azureml/{job-name}/{output-name}/. Os arquivos no diretório de saída serão gravados por meio da montagem de leitura/gravação. Se você desejar especificar um modo diferente para a saída, forneça um objeto que contenha a especificação de saída do componente.

Entrada do componente

Chave Type Descrição Valores permitidos Valor padrão
type string Obrigatórios. O tipo de entrada do componente. Saiba mais sobre acesso aos dados number, integer, boolean, string, uri_file, uri_folder, mltable, mlflow_model, custom_model
description string Descrição da entrada.
default número, número inteiro, booliano ou cadeia de caracteres O valor padrão para a entrada.
optional booleano Se a entrada for necessária. Se definido como true, você precisa usar o comando inclui entradas opcionais com $[[]] false
min número inteiro ou número O valor mínimo aceito para a entrada. Esse campo somente pode ser especificado se o campo type for number ou integer.
max número inteiro ou número O valor máximo aceito para a entrada. Esse campo somente pode ser especificado se o campo type for number ou integer.
enum array A lista de valores permitidos para a entrada. Somente aplicável se o campo type for string.

Saída do componente

Chave Type Descrição Valores permitidos Valor padrão
type string Obrigatórios. O tipo de saída do componente. uri_file, uri_folder, mltable, mlflow_model, custom_model
description string Descrição da saída.

Comentários

Os comandos az ml component podem ser usados para gerenciar os componentes do Azure Machine Learning.

Exemplos

Os exemplos estão disponíveis no repositório de exemplos do GitHub.

Próximas etapas