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 PipelineParameter diferentes valores e entradas.

Inicialize PublishedPipeline.

Ponto de extremidade :p aram A URL do ponto de extremidade REST para enviar o pipeline é executada 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 espaço de trabalho 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

Name	Description
name Necessário	str O nome do pipeline publicado.
graph_id Necessário	str A ID do gráfico para este pipeline publicado.
description Necessário	str A descrição do pipeline publicado.
version Necessário	str A versão de pipeline publicada.
published_pipeline_id Necessário	str A ID do pipeline publicado.
status Necessário	str O status do pipeline publicado ('Ativo' ou 'Desativado').
endpoint Necessário	str A URL do ponto de extremidade REST a ser enviada é executada para esse pipeline.
total_run_steps Necessário	int O número de etapas neste pipeline.
workspace Necessário	Workspace O espaço de trabalho do pipeline publicado.
continue_on_step_failure Necessário	bool Se a execução de outras etapas no PipelineRun deve continuar se uma etapa falhar. O padrão é "false".
_pipeline_provider Necessário	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> O provedor de pipeline publicado.
kwargs Necessário	dict Argumentos de palavras-chave personalizados, reservados para desenvolvimento futuro
name Necessário	str O nome do pipeline publicado.
graph_id Necessário	str A ID do gráfico para este pipeline publicado.
description Necessário	str A descrição do pipeline publicado.
version Necessário	str A versão de pipeline publicada.
published_pipeline_id Necessário	str A ID do pipeline publicado.
status Necessário	str Status do pipeline publicado ('Ativo' ou 'Desativado').
_pipeline_provider Necessário	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> O provedor de pipeline publicado.
kwargs Necessário	dict Argumentos de palavras-chave personalizados, reservados para desenvolvimento futuro

Observações

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

Um exemplo para publicar a partir 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 a partir de um uso 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)

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

Envie um PublishedPipeline usando submito . Quando o envio é chamado, é criado um PipelineRun que, por sua vez, cria StepRun objetos para cada etapa do 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 são, entre outros:

continue_on_step_failure: Se a execução de outras etapas no PipelineRun deve continuar se uma etapa falhar, opcional. Somente 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 substitui a configuração no Pipeline.
pipeline_parameters: Parâmetros para execução de pipeline, dicionário de {name: value}. Consulte 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 em 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 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 endpoint permite a "repetibilidade gerenciada" em cenários de pontuação e retreinamento em lote, por exemplo. Para obter mais informações, consulte https://aka.ms/pl-first-pipeline.

Métodos

disable	Defina o pipeline publicado como 'Desativado' e indisponível para execução.
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 espaço de trabalho atual. DEPRECATED: Este método está sendo preterido em favor do método PublishedPipeline list .
get_graph	Obtenha o gráfico do PublishedPipeline.
get_step_names	Obtenha a lista de nomes de etapas no PublishedPipeline.
list	Obtenha todos os pipelines publicados no espaço de trabalho atual.
save	Salve o Pipeline YAML em um arquivo. Atualmente, apenas pipelines que consistem em ModuleSteps são suportados para exportação YAML.
submit	Envie o pipeline publicado. Isso equivale a usar submito . Devolve o ficheiro PipelineRun. Use este objeto para monitorar e exibir detalhes da execução.

disable

Defina o pipeline publicado como 'Desativado' e indisponível para execução.

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

Name	Description
workspace Necessário	Workspace O espaço de trabalho no qual o pipeline publicado foi criado.
id Necessário	str A ID do pipeline publicado.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor de fluxo de trabalho. Default value: None
_service_endpoint	str O ponto de extremidade do serviço. Default value: None

Devoluções

Tipo	Description
PublishedPipeline	Um objeto PublishedPipeline.

get_all

Obtenha todos os pipelines publicados no espaço de trabalho atual.

DEPRECATED: 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

Name	Description
workspace Necessário	Workspace O espaço de trabalho no qual o pipeline publicado foi criado.
active_only	bool Se deve retornar apenas os pipelines publicados que estão ativos no momento. Default value: True
_service_endpoint	str O ponto de extremidade do serviço. Default value: None

Devoluções

Tipo	Description
list[PublishedPipeline]	Uma lista de objetos PublishedPipeline.

get_graph

Obtenha o gráfico do PublishedPipeline.

get_graph(_workflow_provider=None)

Parâmetros

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor de fluxo de trabalho. Default value: None

Devoluções

Tipo	Description
Graph	O gráfico.

get_step_names

Obtenha a lista de nomes de etapas no PublishedPipeline.

get_step_names(_workflow_provider=None)

Parâmetros

Name	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor de fluxo de trabalho. Default value: None

Devoluções

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

list

Obtenha todos os pipelines publicados no espaço de trabalho atual.

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

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho no qual o pipeline publicado foi criado.
active_only	bool Se deve retornar apenas os pipelines publicados que estão ativos no momento. Default value: True
_service_endpoint	str O ponto de extremidade do serviço. Default value: None

Devoluções

Tipo	Description
list[PublishedPipeline]	Uma lista de objetos PublishedPipeline.

save

Salve o Pipeline YAML em um arquivo.

Atualmente, apenas pipelines que consistem em ModuleSteps são suportados para exportação YAML.

save(path=None, _workflow_provider=None)

Parâmetros

Name	Description
path	str O caminho para salvar o YAML para. 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. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor de fluxo de trabalho. Default value: None

Devoluções

Tipo	Description
None

submit

Envie o pipeline publicado. Isso equivale a usar submito .

Devolve o ficheiro 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

Name	Description
workspace Necessário	Workspace O espaço de trabalho no qual enviar o pipeline publicado.
experiment_name Necessário	str O nome do experimento ao qual se submeter.
pipeline_parameters	dict Um dicionário de parâmetros para atribuir novos valores {param name, param value}. Consulte PipelineParameter para obter mais detalhes. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O provedor de fluxo de trabalho. Default value: None
_service_endpoint	str O ponto de extremidade do serviço. Default value: None
parent_run_id	str ID de execução opcional a ser definida para a execução pai dessa execução de pipeline, que é refletida em RunHistory. A execução pai deve pertencer ao mesmo experimento ao qual esse pipeline está sendo enviado. Default value: None
continue_on_step_failure	bool Se a execução de outras etapas no PipelineRun deve continuar se uma etapa falhar, opcional. Se fornecido, substituirá a configuração no Pipeline. Default value: None

Devoluções

Tipo	Description
PipelineRun	O pipeline enviado é executado.

Atributos

continue_on_step_failure

Obtenha o valor da continue_on_step_failure configuração.

Devoluções

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

description

Obtenha a descrição do pipeline publicado.

Devoluções

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

endpoint

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

Devoluções

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

graph_id

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

Devoluções

Tipo	Description
str	O ID do gráfico.

id

Obtenha o ID de pipeline publicado.

Devoluções

Tipo	Description
str	A ID do pipeline publicado.

name

Obtenha o nome do pipeline publicado.

Devoluções

Tipo	Description
str	O nome do pipeline publicado.

status

Obtenha o status do pipeline publicado.

Devoluções

Tipo	Description
str	O status do pipeline publicado.

total_run_steps

Obtenha o número de etapas no pipeline.

Devoluções

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

version

Obtenha a versão do pipeline publicado.

Devoluções

Tipo	Description
str	A versão do pipeline publicado.

Feedback

Esta página foi útil?

Partilhar via

PublishedPipeline Classe

Construtor

Parâmetros

Observações

Métodos

disable

enable

get

Parâmetros

Devoluções

get_all

Parâmetros

Devoluções

get_graph

Parâmetros

Devoluções

get_step_names

Parâmetros

Devoluções

list

Parâmetros

Devoluções

save

Parâmetros

Devoluções

submit

Parâmetros

Devoluções

Atributos

continue_on_step_failure

Devoluções

description

Devoluções

endpoint

Devoluções

graph_id

Devoluções

id

Devoluções

name

Devoluções

status

Devoluções

total_run_steps

Devoluções

version

Devoluções

Feedback