Compartilhar via


PublishedPipeline Classe

Representa um Pipeline a ser enviado sem o código Python que o construiu.

Além disso, um PublishedPipeline pode ser usado para reenviar um Pipeline com valores e entradas diferentes PipelineParameter .

Inicializar PublishedPipeline.

:p o ponto de extremidade REST A URL do ponto de extremidade REST para enviar execuções de pipeline para esse pipeline. :type endpoint: str :p aram total_run_steps: o número de etapas neste pipeline :type total_run_steps: int :p aram workspace: o workspace do pipeline publicado. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: Se deve continuar a execução de outras etapas no PipelineRun

se uma etapa falhar, o padrão será false.

Construtor

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Parâmetros

Nome Description
name
Obrigatório
str

O nome do pipeline publicado.

graph_id
Obrigatório
str

A ID do grafo para este pipeline publicado.

description
Obrigatório
str

A descrição do pipeline publicado.

version
Obrigatório
str

A versão do pipeline publicada.

published_pipeline_id
Obrigatório
str

A ID do pipeline publicado.

status
Obrigatório
str

O status do pipeline publicado ('Ativo' ou 'Desabilitado').

endpoint
Obrigatório
str

A URL do ponto de extremidade REST a ser enviada é executada para este pipeline.

total_run_steps
Obrigatório
int

O número de etapas neste pipeline.

workspace
Obrigatório

O workspace do pipeline publicado.

continue_on_step_failure
Obrigatório

Se deve continuar a execução de outras etapas no PipelineRun se uma etapa falhar. O padrão é false.

_pipeline_provider
Obrigatório
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

O provedor de pipeline publicado.

kwargs
Obrigatório

Argumentos de palavra-chave personalizados, reservados para desenvolvimento futuro

name
Obrigatório
str

O nome do pipeline publicado.

graph_id
Obrigatório
str

A ID do grafo para este pipeline publicado.

description
Obrigatório
str

A descrição do pipeline publicado.

version
Obrigatório
str

A versão do pipeline publicada.

published_pipeline_id
Obrigatório
str

A ID do pipeline publicado.

status
Obrigatório
str

Status do pipeline publicado ('Ativo' ou 'Desabilitado').

_pipeline_provider
Obrigatório
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

O provedor de pipeline publicado.

kwargs
Obrigatório

Argumentos de palavra-chave personalizados, reservados para desenvolvimento futuro

Comentários

Um PublishedPipeline pode ser criado a partir de um Pipeline ou um PipelineRun.

Um exemplo a ser publicado de um Pipeline é o seguinte:


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

Para publicar de um uso de PipelineRun:


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

Observação: o parâmetro continue_on_step_failure especifica se a execução das etapas no Pipeline continuará se uma etapa falhar. O valor padrão é False, ou seja, quando uma etapa falha, a execução do Pipeline será interrompida, cancelando todas as etapas em execução.

Enviar um PublishedPipeline usando submit. Quando o envio é chamado, é criado um PipelineRun que, por sua vez, cria StepRun objetos para cada etapa no fluxo de trabalho.

Um exemplo para enviar um PublishedPipeline é o seguinte:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

Há várias configurações opcionais que podem ser especificadas ao enviar um PublishedPipeline. Estes incluem:

  • continue_on_step_failure: se deve continuar a execução de outras etapas no PipelineRun se uma etapa falhar, opcional. Somente as etapas que não têm dependência na saída da etapa com falha continuarão a execução. Se fornecida, essa configuração de parâmetro substituirá a configuração no Pipeline.

  • pipeline_parameters: parâmetros para execução de pipeline, dicionário de {name: value}. Confira PipelineParameter para obter mais detalhes.

  • parent_run_id: você pode fornecer uma ID de execução para definir a execução pai dessa execução de pipeline, que é refletida no RunHistory. A execução pai deve pertencer ao mesmo experimento que o pipeline que está sendo enviado.

Um exemplo para enviar um PublishedPipeline usando essas configurações é o seguinte:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

Todos os pipelines publicados têm um ponto de extremidade REST. Com o ponto de extremidade de pipeline, você pode disparar uma execução do pipeline de sistemas externos, como clientes não Python. Para obter informações sobre como autenticar ao chamar pontos de extremidade REST, consulte https://aka.ms/pl-restep-auth.

O uso do ponto de extremidade permite a "repetição gerenciada" em cenários de pontuação e retreinamento em lotes, por exemplo. Para obter mais informações, consulte https://aka.ms/pl-first-pipeline.

Métodos

disable

Defina o pipeline publicado como 'Desabilitado' e indisponível para ser executado.

enable

Defina o pipeline publicado como "Ativo" e disponível para execução.

get

Obtenha o pipeline publicado.

get_all

Obtenha todos os pipelines publicados no workspace atual.

PRETERIDO: este método está sendo preterido em favor do método PublishedPipeline list .

get_graph

Obtenha o grafo do PublishedPipeline.

get_step_names

Obtenha a lista de nomes de etapas no PublishedPipeline.

list

Obtenha todos os pipelines publicados no workspace atual.

save

Salve o YAML do Pipeline em um arquivo.

Atualmente, há suporte apenas para pipelines que consistem em ModuleSteps para exportação de YAML.

submit

Envie o pipeline publicado. Isso é equivalente a usar submit.

Retorna o enviado PipelineRun. Use este objeto para monitorar e exibir detalhes da execução.

disable

Defina o pipeline publicado como 'Desabilitado' e indisponível para ser executado.

disable()

enable

Defina o pipeline publicado como "Ativo" e disponível para execução.

enable()

get

Obtenha o pipeline publicado.

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

Parâmetros

Nome Description
workspace
Obrigatório

O workspace no qual o pipeline publicado foi criado.

id
Obrigatório
str

A ID do pipeline publicado.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

O provedor de fluxo de trabalho.

Valor padrão: None
_service_endpoint
str

O ponto de extremidade de serviço.

Valor padrão: None

Retornos

Tipo Description

Um objeto PublishedPipeline.

get_all

Obtenha todos os pipelines publicados no workspace atual.

PRETERIDO: este método está sendo preterido em favor do método PublishedPipeline list .

static get_all(workspace, active_only=True, _service_endpoint=None)

Parâmetros

Nome Description
workspace
Obrigatório

O workspace no qual o pipeline publicado foi criado.

active_only

Se deve retornar apenas pipelines publicados que estão ativos no momento.

Valor padrão: True
_service_endpoint
str

O ponto de extremidade de serviço.

Valor padrão: None

Retornos

Tipo Description

Uma lista de objetos PublishedPipeline.

get_graph

Obtenha o grafo do PublishedPipeline.

get_graph(_workflow_provider=None)

Parâmetros

Nome Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

O grafo.

get_step_names

Obtenha a lista de nomes de etapas no PublishedPipeline.

get_step_names(_workflow_provider=None)

Parâmetros

Nome Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

A lista dos nomes das etapas no PublishedPipeline.

list

Obtenha todos os pipelines publicados no workspace atual.

static list(workspace, active_only=True, _service_endpoint=None)

Parâmetros

Nome Description
workspace
Obrigatório

O workspace no qual o pipeline publicado foi criado.

active_only

Se deve retornar apenas pipelines publicados que estão ativos no momento.

Valor padrão: True
_service_endpoint
str

O ponto de extremidade de serviço.

Valor padrão: None

Retornos

Tipo Description

Uma lista de objetos PublishedPipeline.

save

Salve o YAML do Pipeline em um arquivo.

Atualmente, há suporte apenas para pipelines que consistem em ModuleSteps para exportação de YAML.

save(path=None, _workflow_provider=None)

Parâmetros

Nome Description
path
str

O caminho para o qual salvar o YAML. Se o caminho for um diretório, o arquivo YAML do Pipeline será salvo no caminho/pipeline_name.yml. Se o caminho for Nenhum, o diretório atual será usado.

Valor padrão: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

submit

Envie o pipeline publicado. Isso é equivalente a usar submit.

Retorna o enviado PipelineRun. Use este objeto para monitorar e exibir detalhes da execução.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Parâmetros

Nome Description
workspace
Obrigatório

O workspace no qual enviar o pipeline publicado.

experiment_name
Obrigatório
str

O nome do experimento ao qual enviar.

pipeline_parameters

Um dicionário de parâmetros para atribuir novos valores {nome do parâmetro, valor de parâmetro}. Confira PipelineParameter para obter mais detalhes.

Valor padrão: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

O provedor de fluxo de trabalho.

Valor padrão: None
_service_endpoint
str

O ponto de extremidade de serviço.

Valor padrão: None
parent_run_id
str

ID de execução opcional a ser definida para a execução pai desta execução de pipeline, que é refletida no RunHistory. A execução pai deve pertencer ao mesmo experimento ao qual este pipeline está sendo enviado.

Valor padrão: None
continue_on_step_failure

Se deseja continuar a execução de outras etapas no PipelineRun se uma etapa falhar, opcional. Se fornecido, substituirá a configuração no Pipeline.

Valor padrão: None

Retornos

Tipo Description

A execução do pipeline enviado.

Atributos

continue_on_step_failure

Obtenha o valor da continue_on_step_failure configuração.

Retornos

Tipo Description

O valor da continue_on_step_failure configuração.

description

Obtenha a descrição do pipeline publicado.

Retornos

Tipo Description
str

A descrição do pipeline publicado.

endpoint

Obtenha a URL do ponto de extremidade REST para executar um pipeline publicado.

Retornos

Tipo Description
str

A URL do ponto de extremidade REST para executar o pipeline publicado.

graph_id

Obtenha a ID do grafo para este pipeline publicado.

Retornos

Tipo Description
str

A ID do grafo.

id

Obtenha a ID do pipeline publicada.

Retornos

Tipo Description
str

A ID do pipeline publicado.

name

Obtenha o nome do pipeline publicado.

Retornos

Tipo Description
str

O nome do pipeline publicado.

status

Obtenha o status do pipeline publicado.

Retornos

Tipo Description
str

O status do pipeline publicado.

total_run_steps

Obtenha o número de etapas no pipeline.

Retornos

Tipo Description
int

O número de etapas no pipeline.

version

Obtenha a versão do pipeline publicado.

Retornos

Tipo Description
str

A versão do pipeline publicado.