PublishedPipeline Classe

Referência

Representa um pipeline a ser enviado sem o código Python que o constrói.

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

Inicialize PublishedPipeline.

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

Herança: azureml.core._portal.HasPipelinePortal

PublishedPipeline

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 gráfico para este pipeline publicado.
description Obrigatório	str A descrição do pipeline publicado.
version Obrigatório	str A versão do pipeline publicado.
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 para envio de execuções para esse pipeline.
total_run_steps Obrigatório	int O número de etapas neste pipeline.
workspace Obrigatório	Workspace O workspace do pipeline publicado.
continue_on_step_failure Obrigatório	bool Se a execução de outras etapas no PipelineRun deverá ou não continuar se uma etapa falhar. O padrão é false.
_pipeline_provider Obrigatório	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> O provedor do pipeline publicado.
kwargs Obrigatório	dict 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 gráfico para este pipeline publicado.
description Obrigatório	str A descrição do pipeline publicado.
version Obrigatório	str A versão do pipeline publicado.
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 do pipeline publicado.
kwargs Obrigatório	dict Argumentos de palavra-chave personalizados, reservados para desenvolvimento futuro

Comentários

Um PublishedPipeline pode ser criado com um Pipeline ou um PipelineRun.

Veja o seguinte exemplo de como publicar de um pipeline:


   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 PipelineRun, use:


   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á ou não se uma etapa falhar. O valor padrão é False, o que significa que, quando uma etapa falhar, a execução do pipeline será parada, cancelando todas as etapas em execução.

Envia um PublishedPipeline usando submit. Ao chamar o envio, será criado um PipelineRun que, por sua vez, criará objetos StepRun para cada etapa do fluxo de trabalho.

Veja o seguinte exemplo de como enviar um PublishedPipeline:


   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. Eles incluem:

continue_on_step_failure: determina se a execução de outras etapas no PipelineRun deverá ou não continuar se uma etapa falhar. Apenas as etapas que não dependem da 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 a execução de pipeline, dicionário de {name: value}. Consulte PipelineParameter para obter mais detalhes.
parent_run_id: é possível fornecer uma ID de execução para definir a execução pai dessa execução de pipeline, que é refletida em RunHistory. A execução pai precisa pertencer ao mesmo experimento que o pipeline sendo enviado.

Veja o seguinte exemplo de envio de um PublishedPipeline com essas configurações:


   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 do 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 "repetibilidade gerenciada" em cenários de retreinamento e pontuação de lote, por exemplo. Para obter mais informações, consulte https://aka.ms/pl-first-pipeline.

Métodos

disable	Define o pipeline publicado como 'Desabilitado' e não disponível para ser executado.
enable	Define o pipeline publicado como 'Ativo' e disponível para ser executado.
get	Obtém o pipeline publicado.
get_all	Obtém todos os pipelines publicados no workspace atual. PRETERIDO: esse método está sendo preterido em favor do método list de PublishedPipeline.
get_graph	Obtém o gráfico do PublishedPipeline.
get_step_names	Obtém a lista de nomes de etapas no PublishedPipeline.
list	Obtém todos os pipelines publicados no workspace atual.
save	Salva o pipeline YAML em um arquivo. Atualmente, somente os pipelines que consistem em ModuleSteps têm suporte para a exportação de YAML.
submit	Envia o pipeline publicado. Isso é equivalente a usar submit. Retorna o PipelineRun enviado. Use esse objeto para monitorar e exibir os detalhes da execução.

disable

Define o pipeline publicado como 'Desabilitado' e não disponível para ser executado.

disable()

enable

Define o pipeline publicado como 'Ativo' e disponível para ser executado.

enable()

get

Obtém o pipeline publicado.

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace em que 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 do fluxo de trabalho. valor padrão: None
_service_endpoint	str O ponto de extremidade de serviço. valor padrão: None

Retornos

Tipo	Description
PublishedPipeline	Um objeto PublishedPipeline.

get_all

Obtém todos os pipelines publicados no workspace atual.

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

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace em que o pipeline publicado foi criado.
active_only	bool Se deseja ou não 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
list[PublishedPipeline]	Uma lista de objetos PublishedPipeline.

get_graph

Obtém o gráfico do PublishedPipeline.

get_graph(_workflow_provider=None)

Parâmetros

Nome	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor do fluxo de trabalho. valor padrão: None

Retornos

Tipo	Description
Graph	O gráfico.

get_step_names

Obtém 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 do fluxo de trabalho. valor padrão: None

Retornos

Tipo	Description
List[str]	A lista dos nomes das etapas no PublishedPipeline.

list

Obtém todos os pipelines publicados no workspace atual.

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace em que o pipeline publicado foi criado.
active_only	bool Se deseja ou não 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
list[PublishedPipeline]	Uma lista de objetos PublishedPipeline.

save

Salva o pipeline YAML em um arquivo.

Atualmente, somente os pipelines que consistem em ModuleSteps têm suporte para a exportação de YAML.

save(path=None, _workflow_provider=None)

Parâmetros

Nome	Description
path	str O caminho no qual salvar o YAML. Se o caminho for um diretório, o arquivo YAML do pipeline será salvo em path/pipeline_name.yml. Se o caminho for None, será usado o diretório atual. valor padrão: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor do fluxo de trabalho. valor padrão: None

Retornos

Tipo	Description
None

submit

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

Retorna o PipelineRun enviado. Use esse objeto para monitorar e exibir os 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	Workspace O workspace no qual enviar o pipeline publicado.
experiment_name Obrigatório	str O nome do experimento para o qual enviá-lo.
pipeline_parameters	dict Um dicionário de parâmetros para atribuir novos valores {nome do parâmetro, valor do parâmetro}. Consulte PipelineParameter para obter mais detalhes. valor padrão: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor do 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 A ID de execução opcional a ser definida para a execução pai desta execução de pipeline, que é refletida em RunHistory. A execução pai precisa pertencer ao mesmo experimento ao qual este pipeline está sendo enviado. valor padrão: None
continue_on_step_failure	bool Opcional. Determina se a execução de outras etapas no PipelineRun deverá ou não continuar se uma etapa falhar. Se fornecido, substituirá a configuração do pipeline. valor padrão: None

Retornos

Tipo	Description
PipelineRun	A execução de pipeline enviada.

Atributos

continue_on_step_failure

Obter o valor da configuração continue_on_step_failure.

Retornos

Tipo	Description
bool	O valor da configuração `continue_on_step_failure`.

description

Obter a descrição do pipeline publicado.

Retornos

Tipo	Description
str	A descrição do pipeline publicado.

endpoint

Obtém 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

Obter a ID do gráfico para este pipeline publicado.

Retornos

Tipo	Description
str	A ID do gráfico.

id

Obter a ID do pipeline publicado.

Retornos

Tipo	Description
str	A ID do pipeline publicado.

name

Obter o nome do pipeline publicado.

Retornos

Tipo	Description
str	O nome do pipeline publicado.

status

Obter o status do pipeline publicado.

Retornos

Tipo	Description
str	O status do pipeline publicado.

total_run_steps

Obter o número de etapas no pipeline.

Retornos

Tipo	Description
int	O número de etapas no pipeline.

version

Obter a versão do pipeline publicado.

Retornos

Tipo	Description
str	A versão do pipeline publicado.

Compartilhar via

PublishedPipeline Classe

Construtor

Parâmetros

Comentários

Métodos

disable

enable

get

Parâmetros

Retornos

get_all

Parâmetros

Retornos

get_graph

Parâmetros

Retornos

get_step_names

Parâmetros

Retornos

list

Parâmetros

Retornos

save

Parâmetros

Retornos

submit

Parâmetros

Retornos

Atributos

continue_on_step_failure

Retornos

description

Retornos

endpoint

Retornos

graph_id

Retornos

id

Retornos

name

Retornos

status

Retornos

total_run_steps

Retornos

version

Retornos

Comentários

Comentários

Recursos adicionais