PublishedPipeline Classe

Referência

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

Além disso, uma PublishedPipeline pode ser utilizada para voltar a submeter uma Pipeline com valores e entradas diferentes PipelineParameter .

Inicializar PublishedPipeline.

:p os pontos finais O URL do ponto final REST para submeter execuções de pipeline para este pipeline. :type endpoint: str :p aram total_run_steps: O número de passos neste pipeline :tipo total_run_steps: área de trabalho int :p aram: a área de trabalho do pipeline publicado. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: Se pretende continuar a execução de outros passos no PipelineRun

se um passo falhar, a predefinição é falsa.

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

Name	Description
name Necessário	str O nome do pipeline publicado.
graph_id Necessário	str O 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 do pipeline publicada.
published_pipeline_id Necessário	str O ID do pipeline publicado.
status Necessário	str O estado do pipeline publicado ("Ativo" ou "Desativado").
endpoint Necessário	str O URL do ponto final REST a submeter é executado para este pipeline.
total_run_steps Necessário	int O número de passos neste pipeline.
workspace Necessário	Workspace A área de trabalho do pipeline publicado.
continue_on_step_failure Necessário	bool Se pretende continuar a execução de outros passos no PipelineExecutar se um passo falhar. A predefinição é false.
_pipeline_provider Necessário	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> O fornecedor de pipeline publicado.
kwargs Necessário	dict Argumentos de palavra-chave personalizados, reservados para desenvolvimento futuro
name Necessário	str O nome do pipeline publicado.
graph_id Necessário	str O 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 do pipeline publicada.
published_pipeline_id Necessário	str O ID do pipeline publicado.
status Necessário	str Estado do pipeline publicado ("Ativo" ou "Desativado").
_pipeline_provider Necessário	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> O fornecedor de pipeline publicado.
kwargs Necessário	dict Argumentos de palavra-chave personalizados, reservados para desenvolvimento futuro

Observações

Uma PublishedPipeline pode ser criada a partir de um Pipeline ou de um PipelineRun.

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 uma utilização 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 dos passos no Pipeline continuará se um passo falhar. O valor predefinido é Falso, o que significa que quando um passo falha, a execução do Pipeline irá parar, cancelando quaisquer passos em execução.

Submeta uma PublishedPipeline com submit. Quando a submissão é chamada, é criado um PipelineRun que, por sua vez, cria objetos StepRun para cada passo no fluxo de trabalho.

Um exemplo para submeter uma 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)

Existem várias definições opcionais que podem ser especificadas ao submeter uma PublishedPipeline. Incluem-se:

continue_on_step_failure: se pretende continuar a execução de outros passos no PipelineRun se um passo falhar, opcional. Apenas os passos que não têm dependência na saída do passo falhado continuarão a ser executados. Se for fornecido, esta definição de parâmetro substitui a definição no Pipeline.
pipeline_parameters: Parâmetros para a execução do pipeline, dicionário de {name: value}. Veja PipelineParameter para obter mais detalhes.
parent_run_id: pode fornecer um ID de execução para definir a execução principal desta execução de pipeline, que se reflete no RunHistory. A execução principal tem de pertencer à mesma experimentação que o pipeline que está a ser submetido.

Um exemplo para submeter uma PublishedPipeline com estas definiçõ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 final REST. Com o ponto final do pipeline, pode acionar uma execução do pipeline a partir de sistemas externos, como clientes não Python. Para obter informações sobre como autenticar ao chamar pontos finais REST, consulte https://aka.ms/pl-restep-auth.

A utilização do ponto final permite a "repetibilidade gerida" em cenários de classificação e reconversão de lotes, 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 na área de trabalho atual. PRETERIDO: este método está a ser preterido a favor do método PublishedPipeline list .
get_graph	Obtenha o gráfico de PublishedPipeline.
get_step_names	Obtenha a lista de nomes de passos em PublishedPipeline.
list	Obtenha todos os pipelines publicados na área de trabalho atual.
save	Guarde o YAML do Pipeline num ficheiro. Atualmente, apenas os pipelines que consistem em ModuleSteps são suportados para exportação YAML.
submit	Submeta o pipeline publicado. Isto é equivalente à utilização submitde . Devolve o submetido PipelineRun. Utilize este objeto para monitorizar e ver os 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 A área de trabalho na qual o pipeline publicado foi criado.
id Necessário	str O ID do pipeline publicado.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O fornecedor de fluxo de trabalho. Default value: None
_service_endpoint	str O ponto final de serviço. Default value: None

Devoluções

Tipo	Description
PublishedPipeline	Um objeto PublishedPipeline.

get_all

Obtenha todos os pipelines publicados na área de trabalho atual.

PRETERIDO: este método está a ser preterido a favor do método PublishedPipeline list .

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

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho em que o pipeline publicado foi criado.
active_only	bool Se pretende devolver apenas pipelines publicados que estão atualmente ativos. Default value: True
_service_endpoint	str O ponto final de serviço. Default value: None

Devoluções

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

get_graph

Obtenha o gráfico de PublishedPipeline.

get_graph(_workflow_provider=None)

Parâmetros

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

Devoluções

Tipo	Description
Graph	O gráfico.

get_step_names

Obtenha a lista de nomes de passos em PublishedPipeline.

get_step_names(_workflow_provider=None)

Parâmetros

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

Devoluções

Tipo	Description
List[str]	A lista dos nomes dos passos em PublishedPipeline.

list

Obtenha todos os pipelines publicados na área de trabalho atual.

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

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho na qual o pipeline publicado foi criado.
active_only	bool Se pretende devolver apenas pipelines publicados que estão atualmente ativos. Default value: True
_service_endpoint	str O ponto final de serviço. Default value: None

Devoluções

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

save

Guarde o YAML do Pipeline num ficheiro.

Atualmente, apenas os 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 o qual guardar o YAML. Se o caminho for um diretório, o ficheiro YAML do Pipeline é guardado em path/pipeline_name.yml. Se caminho for Nenhum, é utilizado o diretório atual. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O fornecedor de fluxo de trabalho. Default value: None

Devoluções

Tipo	Description
None

submit

Submeta o pipeline publicado. Isto é equivalente à utilização submitde .

Devolve o submetido PipelineRun. Utilize este objeto para monitorizar e ver 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

Name	Description
workspace Necessário	Workspace A área de trabalho na qual submeter o pipeline publicado.
experiment_name Necessário	str O nome da experimentação a submeter.
pipeline_parameters	dict Um dicionário de parâmetros para atribuir novos valores {param name, param value}. Veja PipelineParameter para obter mais detalhes. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> O fornecedor de fluxo de trabalho. Default value: None
_service_endpoint	str O ponto final de serviço. Default value: None
parent_run_id	str ID de execução opcional a definir para a execução principal desta execução de pipeline, que é refletida no RunHistory. A execução principal tem de pertencer à mesma experimentação para a qual este pipeline está a ser submetido. Default value: None
continue_on_step_failure	bool Se pretende continuar a execução de outros passos no PipelineRun se um passo falhar, opcional. Se for fornecido, substituirá a definição no Pipeline. Default value: None

Devoluções

Tipo	Description
PipelineRun	A execução do pipeline submetido.

Atributos

continue_on_step_failure

Obtenha o valor da continue_on_step_failure definição.

Devoluções

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

description

Obtenha a descrição do pipeline publicado.

Devoluções

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

endpoint

Obtenha o URL do ponto final REST para executar um pipeline publicado.

Devoluções

Tipo	Description
str	O URL do ponto final REST para executar o pipeline publicado.

graph_id

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

Devoluções

Tipo	Description
str	O ID do gráfico.

id

Obtenha o ID do pipeline publicado.

Devoluções

Tipo	Description
str	O ID do pipeline publicado.

name

Obtenha o nome do pipeline publicado.

Devoluções

Tipo	Description
str	O nome do pipeline publicado.

status

Obtenha o estado do pipeline publicado.

Devoluções

Tipo	Description
str	O estado do pipeline publicado.

total_run_steps

Obtenha o número de passos no pipeline.

Devoluções

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

version

Obtenha a versão do pipeline publicado.

Devoluções

Tipo	Description
str	A versão do pipeline publicado.

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

Comentários

Recursos adicionais