PipelineEndpoint Classe

Representa um Pipeline fluxo de trabalho que pode ser acionado a partir 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 dentro de um espaço de trabalho.

Usando o atributo endpoint 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 aprendizado de máquina, consulte https://aka.ms/pl-first-pipeline.

Inicialize o 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

Name	Description
workspace Necessário	Workspace O espaço de trabalho no qual o PipelineEndpoint está definido.
id Necessário	str A ID do PipelineEndpoint.
name Necessário	str O nome do PipelineEndpoint.
description Necessário	str A descrição do PipelineEndpoint.
status Necessário	str O novo status do PipelineEndpoint: 'Ativo' ou 'Desativado'.
default_version Necessário	str A versão padrão do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0".
endpoint Necessá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 Necessário	list A lista de PipelineIdVersion objetos.
_pipeline_endpoint_provider Necessário	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> O provedor PipelineEndpoint.
_pipeline_endpoint_provider Necessário	O provedor PublishedPipeline.
workspace Necessário	Workspace O objeto de espaço de trabalho ao qual este PipelineEndpoint pertencerá.
id Necessário	str A ID do PipelineEndpoint.
name Necessário	str O nome do PipelineEndpoint.
description Necessário	str A descrição do PipelineEndpoint.
status Necessário	str O novo status do PipelineEndpoint: 'Ativo' ou 'Desativado'.
default_version Necessário	str A versão padrão do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0"
endpoint Necessário	str A URL do ponto de extremidade REST para PipelineEndpoint enviar execuções de pipeline.
pipeline_version_list Necessário	list A lista de PipelineIdVersion
_pipeline_endpoint_provider Necessário	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> O provedor PipelineEndpoint.
_pipeline_endpoint_provider Necessário	O provedor PublishedPipeline.
swaggerendpoint Necessário	A URL do ponto de extremidade REST do Swagger para PipelineEndpoint enviar execuções de pipeline.

Observações

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

Um exemplo para publicar a partir 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")

Envie um PipelineEndpoint 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 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 são, entre outros:

• 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 ao qual esse 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 bloco de anotações 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 como a versão do pipeline adicionada.
archive	Arquive o PipelineEndpoint.
disable	Defina o PipelineEndpoint como 'Desativado' 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, lança exceção se um deles não for fornecido.
get_all	Obtenha todos os PipelineEndpoints ativos no espaço de trabalho atual. Obtenha todos os PipelineEndpoints ativos. Observação : esse método está sendo preterido em favor de PipelineEndpoint.list().
get_all_pipelines	Obtenha uma lista de pipelines no PipelineEndpoint. NOTA: Este método está a ser preterido a favor de list_pipelines()
get_all_versions	Obtenha uma lista de pipelines e versões correspondentes em PipelineEndpoint. Observação : esse 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; lança uma exceção se a versão não for encontrada.
list	Liste PipelineEndpoints ativos no espaço de trabalho 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 de pipeline é uma API REST que pode ser usada a partir 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. Lança exceção se já existir um PipelineEndpoint com o nome fornecido.
reactivate	Reative um PipelineEndpoint que foi arquivado.
set_default	Defina a versão padrão do PipelineEndpoint, lança uma exceção se o pipeline especificado não for encontrado.
set_default_version	Defina a versão padrão de PipelineEndpoint, lança uma exceção se a versão especificada não for encontrada.
set_name	Defina o nome de PipelineEndpoint.
submit	Enviar um experimento de pipeline de determinada versão; se version for none aciona a versão padrão do pipeline.

add

Adicione o pipeline especificado ao PipelineEndpoint.

add(pipeline)

Parâmetros

Name	Description
pipeline Necessário	PublishedPipeline Um pipeline publicado para adicionar.

add_default

Adicione o pipeline especificado ao PipelineEndpoint e defina a versão padrão como a versão do pipeline adicionada.

add_default(pipeline)

Parâmetros

Name	Description
pipeline Necessário	PublishedPipeline Um pipeline publicado para adicionar como a versão padrão.

archive

Arquive o PipelineEndpoint.

archive()

disable

Defina o PipelineEndpoint como 'Desativado' 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, lança exceção se um deles não for fornecido.

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

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho no qual o PipelineEndpoint foi criado.
id	str A ID do PipelineEndpoint. Default value: None
name	str O nome do PipelineEndpoint. 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

Devoluções

Tipo	Description
PipelineEndpoint	O objeto PipelineEndpoint.

get_all

Obtenha todos os PipelineEndpoints ativos no espaço de trabalho atual.

Obtenha todos os PipelineEndpoints ativos. Observação : esse 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

Name	Description
workspace Necessário	Workspace O espaço de trabalho.
active_only	bool Se verdadeiro, retorne apenas PipelineEndpoints que estão ativos no momento. Default value: True
_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
list	A lista de PipelineEndpoint objetos.

get_all_pipelines

Obtenha uma lista de pipelines no PipelineEndpoint.

NOTA: Este método está a ser preterido a favor de list_pipelines()

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

Parâmetros

Name	Description
active_only	bool Sinalizar para retornar somente pipelines ativos. Default value: True
_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
list	A lista de PublishedPipeline objetos.

get_all_versions

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

Observação : esse método está sendo preterido em favor de list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parâmetros

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

get_default_version

Obtenha a versão padrão do PipelineEndpoint.

get_default_version()

Devoluções

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; lança uma exceção se a versão não for encontrada.

get_pipeline(version=None)

Parâmetros

Name	Description
version	str A versão do pipeline a ser retornada. Default value: None

Devoluções

Tipo	Description
PublishedPipeline	Um pipeline publicado.

list

Liste PipelineEndpoints ativos no espaço de trabalho atual.

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

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho.
active_only	bool Se verdadeiro, retorne apenas PipelineEndpoints que estão ativos no momento. Default value: True
max_results	int linhas máximas de PipelineEndpoints retornados Default value: 100
_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
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

Name	Description
active_only	bool Indica se os pipelines ativos devem ser retornados. Default value: True
_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
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

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

publish

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

O ponto de extremidade de pipeline é uma API REST que pode ser usada a partir 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.

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

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

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho para criar o PipelineEndpoint em.
name Necessário	str O nome do PipelineEndpoint.
description Necessário	str A descrição do PipelineEndpoint.
pipeline Necessário	PublishedPipeline ou Pipeline O pipeline ou pipeline publicado.
_service_endpoint	str O ponto de extremidade do serviço. 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
PipelineEndpoint	Um novo PipelineEndpoint.

Exceções

Tipo	Description
ValueError

reactivate

Reative um PipelineEndpoint que foi arquivado.

reactivate(name)

Parâmetros

Name	Description
name Necessário	str O nome a definir.

Devoluções

Tipo	Description
PipelineEndpoint	Um objeto PipelineEndpoint.

set_default

Defina a versão padrão do PipelineEndpoint, lança uma exceção se o pipeline especificado não for encontrado.

set_default(pipeline)

Parâmetros

Name	Description
pipeline Necessário	PublishedPipeline O pipeline publicado para definir como padrão.

Exceções

Tipo	Description
ValueError

set_default_version

Defina a versão padrão de PipelineEndpoint, lança uma exceção se a versão especificada não for encontrada.

set_default_version(version)

Parâmetros

Name	Description
version Necessá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

Name	Description
name Necessário	str O nome a definir.

submit

Enviar um experimento de pipeline de determinada versão; se version for none aciona a versão padrão do pipeline.

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

Parâmetros

Name	Description
experiment_name Necessário	str O nome do experimento para enviar o pipeline.
pipeline_parameters	dict Parâmetros a serem usados na execução do pipeline, passados como um dicionário de {name: value}. Consulte PipelineParameter para obter mais detalhes. Default value: 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 em RunHistory. A execução principal deve pertencer à mesma experimentação à qual o pipeline está a ser submetido. Default value: None
pipeline_version	str A versão do pipeline a ser executada. Default value: None

Devoluções

Tipo	Description
PipelineRun	O pipeline enviado é executado.

Exceções

Tipo	Description
ValueError

Atributos

default_version

Obtenha a versão padrão do PipelineEndpoint.

Devoluções

Tipo	Description
str	A versão padrão.

description

Obtenha a descrição do PipelineEndpoint.

Devoluções

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.

Devoluções

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

id

Obtenha a ID do PipelineEndpoint.

Devoluções

Tipo	Description
str	A ID do PipelineEndpoint.

name

Obtenha o nome do PipelineEndpoint.

Devoluções

Tipo	Description
str	O nome.

pipeline_version_list

Obtenha a lista de versões do pipeline.

Devoluções

Tipo	Description
list	A lista de PipelineIdVersion objetos.

status

Obtenha o status do PipelineEndpoint.

Devoluções

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.

Devoluções

Tipo	Description
str	SWAGGER REST para PipelineEndpoint executar pipeline.