PipelineEndpoint Classe

Representa um Pipeline fluxo de trabalho que pode ser disparado de uma URL de ponto de extremidade exclusiva.

PipelineEndpoints pode ser usado para criar novas versões de um PublishedPipeline enquanto mantém o mesmo ponto de extremidade. PipelineEndpoints são nomeados exclusivamente em um workspace.

Usando o atributo de ponto de extremidade de um objeto PipelineEndpoint, você pode disparar novas execuções de pipeline de aplicativos externos com chamadas REST. Para obter informações sobre como autenticar ao chamar pontos de extremidade REST, consulte https://aka.ms/pl-restep-auth.

Para obter mais informações sobre como criar e executar pipelines de machine learning, consulte https://aka.ms/pl-first-pipeline.

Inicializar PipelineEndpoint.

Construtor

PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace no qual o PipelineEndpoint está definido.
id Obrigatório	str A ID do PipelineEndpoint.
name Obrigatório	str O nome do PipelineEndpoint.
description Obrigatório	str A descrição do PipelineEndpoint.
status Obrigatório	str O novo status do PipelineEndpoint: "Ativo" ou "Desabilitado".
default_version Obrigatório	str A versão padrão do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0".
endpoint Obrigatório	str A URL do ponto de extremidade REST para o PipelineEndpoint, que pode ser usada para enviar execuções de pipeline.
pipeline_version_list Obrigatório	list A lista de PipelineIdVersion objetos.
_pipeline_endpoint_provider Obrigatório	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> O provedor PipelineEndpoint.
_pipeline_endpoint_provider Obrigatório	O provedor PublishedPipeline.
workspace Obrigatório	Workspace O objeto de workspace ao qual este PipelineEndpoint pertencerá.
id Obrigatório	str A ID do PipelineEndpoint.
name Obrigatório	str O nome do PipelineEndpoint.
description Obrigatório	str A descrição do PipelineEndpoint.
status Obrigatório	str O novo status do PipelineEndpoint: "Ativo" ou "Desabilitado".
default_version Obrigatório	str A versão padrão do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0"
endpoint Obrigatório	str A URL do ponto de extremidade REST para PipelineEndpoint para enviar execuções de pipeline.
pipeline_version_list Obrigatório	list A lista de PipelineIdVersion
_pipeline_endpoint_provider Obrigatório	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> O provedor PipelineEndpoint.
_pipeline_endpoint_provider Obrigatório	O provedor PublishedPipeline.
swaggerendpoint Obrigatório	A URL do ponto de extremidade REST do Swagger para PipelineEndpoint para enviar execuções de pipeline.

Comentários

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

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

   from azureml.pipeline.core import PipelineEndpoint

   # The pipeline argument can be either a Pipeline or a PublishedPipeline
   pipeline_endpoint = PipelineEndpoint.publish(workspace=ws,
                                                name="PipelineEndpointName",
                                                pipeline=pipeline,
                                                description="New Pipeline Endpoint")

Enviar um PipelineEndpoint 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 de como enviar um PipelineEndpoint é o seguinte:

   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint)

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

• 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 ao qual este pipeline está sendo enviado.

• pipeline_version: a versão do pipeline a ser executada.

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

   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>",
                                    pipeline_version="0")

Para adicionar uma nova versão de um pipelineEndpoint, use:

   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_endpoint.add(published_pipeline)

Consulte o notebook a seguir para obter informações adicionais sobre como criar e usar PipelineEndpoints: https://aka.ms/pl-ver-endpoint.

Métodos

add	Adicione o pipeline especificado ao PipelineEndpoint.
add_default	Adicione o pipeline especificado ao PipelineEndpoint e defina a versão padrão para a versão de pipeline adicionada.
archive	Arquive o PipelineEndpoint.
disable	Defina o PipelineEndpoint como 'Desabilitado' e indisponível para ser executado.
enable	Defina o PipelineEndpoint como "Ativo" e disponível para execução.
get	Obtenha o PipelineEndpoint por nome ou ID, gerará exceção se um dos dois não for fornecido.
get_all	Obtenha todos os PipelineEndpoints ativos no workspace atual. Obtenha todos os PipelineEndpoints ativos. OBSERVAÇÃO: este método está sendo preterido em favor de PipelineEndpoint.list().
get_all_pipelines	Obter a lista de pipelines no PipelineEndpoint. OBSERVAÇÃO: Este método está sendo preterido em favor de list_pipelines()
get_all_versions	Obter lista de pipelines e versões correspondentes no PipelineEndpoint. OBSERVAÇÃO: Este método está sendo preterido em favor de list_versions()
get_default_version	Obtenha a versão padrão do PipelineEndpoint.
get_pipeline	Obter o pipeline de uma versão especificada ou o padrão; gerará uma exceção se a versão não for encontrada.
list	Liste PipelineEndpoints ativos no workspace atual.
list_pipelines	Obtenha uma lista de pipelines associados ao PipelineEndpoint.
list_versions	Obtenha uma lista de pipelines e versões correspondentes do PipelineEndpoint.
publish	Crie um PipelineEndpoint com o nome especificado e pipeline/pipeline publicado. O ponto de extremidade do pipeline é uma API REST que pode ser usada de aplicativos externos. Para obter informações sobre como autenticar ao chamar pontos de extremidade REST, consulte https://aka.ms/pl-restep-auth. Para obter mais informações sobre como trabalhar com pontos de extremidade de pipeline, consulte https://aka.ms/pl-first-pipeline. Gera exceção se um PipelineEndpoint com o nome fornecido já existir.
reactivate	Reativar um PipelineEndpoint que foi arquivado.
set_default	Defina a versão padrão do PipelineEndpoint e gerará uma exceção se o pipeline especificado não for encontrado.
set_default_version	Defina a versão padrão do PipelineEndpoint e gere uma exceção se a versão especificada não for encontrada.
set_name	Defina o nome de PipelineEndpoint.
submit	Enviar um teste de pipeline de determinada versão; se a versão não for nenhum dispara a versão padrão do pipeline.

add

Adicione o pipeline especificado ao PipelineEndpoint.

add(pipeline)

Parâmetros

Nome	Description
pipeline Obrigatório	PublishedPipeline Um pipeline publicado a ser adicionado.

add_default

Adicione o pipeline especificado ao PipelineEndpoint e defina a versão padrão para a versão de pipeline adicionada.

add_default(pipeline)

Parâmetros

Nome	Description
pipeline Obrigatório	PublishedPipeline Um pipeline publicado para adicionar como a versão padrão.

archive

Arquive o PipelineEndpoint.

archive()

disable

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

disable()

enable

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

enable()

get

Obtenha o PipelineEndpoint por nome ou ID, gerará exceção se um dos dois não for fornecido.

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace no qual o PipelineEndpoint foi criado.
id	str A ID do PipelineEndpoint. Valor padrão: None
name	str O nome do PipelineEndpoint. 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

Retornos

Tipo	Description
PipelineEndpoint	O objeto PipelineEndpoint.

get_all

Obtenha todos os PipelineEndpoints ativos no workspace atual.

Obtenha todos os PipelineEndpoints ativos. OBSERVAÇÃO: este método está sendo preterido em favor de PipelineEndpoint.list().

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace.
active_only	bool Se for true, retorne apenas PipelineEndpoints que estão ativos no momento. Valor padrão: True
_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
list	A lista de PipelineEndpoint objetos.

get_all_pipelines

Obter a lista de pipelines no PipelineEndpoint.

OBSERVAÇÃO: Este método está sendo preterido em favor de list_pipelines()

get_all_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parâmetros

Nome	Description
active_only	bool Sinalizar para retornar somente pipelines ativos. Valor padrão: True
_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
list	A lista de PublishedPipeline objetos.

get_all_versions

Obter lista de pipelines e versões correspondentes no PipelineEndpoint.

OBSERVAÇÃO: Este método está sendo preterido em favor de list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parâmetros

Nome	Description
_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
list	A lista de PipelineVersion objetos.

get_default_version

Obtenha a versão padrão do PipelineEndpoint.

get_default_version()

Retornos

Tipo	Description
str	A versão padrão do ponto de extremidade do pipeline.

get_pipeline

Obter o pipeline de uma versão especificada ou o padrão; gerará uma exceção se a versão não for encontrada.

get_pipeline(version=None)

Parâmetros

Nome	Description
version	str A versão do pipeline a ser retornada. Valor padrão: None

Retornos

Tipo	Description
PublishedPipeline	Um pipeline publicado.

list

Liste PipelineEndpoints ativos no workspace atual.

static list(workspace, active_only=True, max_results=100, _workflow_provider=None, _service_endpoint=None)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace.
active_only	bool Se for true, retorne apenas PipelineEndpoints que estão ativos no momento. Valor padrão: True
max_results	int linhas máximas de PipelineEndpoints retornados Valor padrão: 100
_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
list	A lista de PipelineEndpoint objetos.

list_pipelines

Obtenha uma lista de pipelines associados ao PipelineEndpoint.

list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parâmetros

Nome	Description
active_only	bool Indica se os pipelines ativos devem ser retornados apenas. Valor padrão: True
_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
list	A lista de PublishedPipeline objetos.

list_versions

Obtenha uma lista de pipelines e versões correspondentes do PipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parâmetros

Nome	Description
_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
list	A lista de PipelineVersion objetos.

publish

Crie um PipelineEndpoint com o nome especificado e pipeline/pipeline publicado.

O ponto de extremidade do pipeline é uma API REST que pode ser usada de aplicativos externos. Para obter informações sobre como autenticar ao chamar pontos de extremidade REST, consulte https://aka.ms/pl-restep-auth.

Para obter mais informações sobre como trabalhar com pontos de extremidade de pipeline, consulte https://aka.ms/pl-first-pipeline.

Gera exceção se um PipelineEndpoint com o nome fornecido já existir.

static publish(workspace, name, description, pipeline, _workflow_provider=None, _service_endpoint=None)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace no qual criar o PipelineEndpoint.
name Obrigatório	str O nome do PipelineEndpoint.
description Obrigatório	str A descrição do PipelineEndpoint.
pipeline Obrigatório	PublishedPipeline ou Pipeline O pipeline ou pipeline publicado.
_service_endpoint	str O ponto de extremidade de serviço. 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
PipelineEndpoint	Um novo PipelineEndpoint.

Exceções

Tipo	Description
ValueError

reactivate

Reativar um PipelineEndpoint que foi arquivado.

reactivate(name)

Parâmetros

Nome	Description
name Obrigatório	str O nome a ser definido.

Retornos

Tipo	Description
PipelineEndpoint	Um objeto PipelineEndpoint.

set_default

Defina a versão padrão do PipelineEndpoint e gerará uma exceção se o pipeline especificado não for encontrado.

set_default(pipeline)

Parâmetros

Nome	Description
pipeline Obrigatório	PublishedPipeline O pipeline publicado a ser definido como o padrão.

Exceções

Tipo	Description
ValueError

set_default_version

Defina a versão padrão do PipelineEndpoint e gere uma exceção se a versão especificada não for encontrada.

set_default_version(version)

Parâmetros

Nome	Description
version Obrigatório	str A versão a ser definida como a versão padrão no PipelineEndpoint.

Exceções

Tipo	Description
ValueError

set_name

Defina o nome de PipelineEndpoint.

set_name(name)

Parâmetros

Nome	Description
name Obrigatório	str O nome a ser definido.

submit

Enviar um teste de pipeline de determinada versão; se a versão não for nenhum dispara a versão padrão do pipeline.

submit(experiment_name, pipeline_parameters=None, parent_run_id=None, pipeline_version=None)

Parâmetros

Nome	Description
experiment_name Obrigatório	str O nome do experimento no qual enviar o pipeline.
pipeline_parameters	dict Parâmetros a serem usados na execução do pipeline, passados como um dicionário de {name: value}. Confira PipelineParameter para obter mais detalhes. Valor padrão: None
parent_run_id	str 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 ao qual o pipeline está sendo enviado. Valor padrão: None
pipeline_version	str A versão do pipeline a ser executada. Valor padrão: None

Retornos

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

Exceções

Tipo	Description
ValueError

Atributos

default_version

Obtenha a versão padrão do PipelineEndpoint.

Retornos

Tipo	Description
str	A versão padrão.

description

Obtenha a descrição do PipelineEndpoint.

Retornos

Tipo	Description
str	A descrição.

endpoint

Obtenha a URL do ponto de extremidade REST do PipelineEndpoint.

O ponto de extremidade pode ser usado para disparar execuções do pipeline.

Retornos

Tipo	Description
str	Ponto de extremidade REST para PipelineEndpoint para executar o pipeline.

id

Obtenha a ID do PipelineEndpoint.

Retornos

Tipo	Description
str	A ID do PipelineEndpoint.

name

Obtenha o nome do PipelineEndpoint.

Retornos

Tipo	Description
str	O nome.

pipeline_version_list

Obtenha a lista de versões do pipeline.

Retornos

Tipo	Description
list	A lista de PipelineIdVersion objetos.

status

Obtenha o status do PipelineEndpoint.

Retornos

Tipo	Description
str	O status.

swaggerurl

Obtenha a URL do Swagger REST do PipelineEndpoint.

A URL do Swagger pode ser o esquema de exibição do ponto de extremidade do pipeline.

Retornos

Tipo	Description
str	O Swagger REST para PipelineEndpoint executará o pipeline.