PipelineEndpoint Classe

Referência

Representa um fluxo de trabalho Pipeline 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 aprendizado de máquina, consulte https://aka.ms/pl-first-pipeline.

Inicializar PipelineEndpoint.

Herança: builtins.object

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 em que o PipelineEndpoint é 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 do PipelineEndpoint, que pode ser usada para enviar execuções de pipeline.
pipeline_version_list Obrigatório	list A lista de objetos PipelineIdVersion.
_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 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 enviar execuções de pipeline.

Comentários

Um PipelineEndpoint pode ser criado por meio de um Pipeline ou de um PublishedPipeline.

Veja o seguinte exemplo de publicação de um pipeline ou PublishedPipeline:


   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")

Envia um PipelineEndpoint 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 PipelineEndpoint:


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

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 ao qual o pipeline está sendo enviado.
pipeline_version: a versão do pipeline a ser executada.

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


   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 o seguinte:


   from azureml.pipeline.core import PipelineEndpoint

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

Veja o seguinte notebook para saber como criar e usar PipelineEndpoints: https://aka.ms/pl-ver-endpoint.

Métodos

add	Adiciona o pipeline especificado ao PipelineEndpoint.
add_default	Adiciona o pipeline especificado ao PipelineEndpoint e define a versão padrão para a versão de pipeline adicionada.
archive	Arquiva o PipelineEndpoint.
disable	Define o PipelineEndpoint como 'Desabilitado' e indisponível para execução.
enable	Define o PipelineEndpoint como 'Ativo' e disponível para execução.
get	Obtém o PipelineEndpoint por nome ou ID; gera uma exceção quando algum dos dois não é fornecido.
get_all	Obter todos os PipelineEndpoints ativos no workspace atual. Obter todos os PipelineEndpoints ativos. OBSERVAÇÃO: esse método está sendo preterido e será substituído por PipelineEndpoint.list().
get_all_pipelines	Obtém a lista de pipelines no PipelineEndpoint. OBSERVAÇÃO: esse método está sendo preterido e será substituído por list_pipelines()
get_all_versions	Obtém a lista de pipelines e as versões correspondentes em PipelineEndpoint. OBSERVAÇÃO: esse método está sendo preterido e será substituído por list_versions()
get_default_version	Obtém a versão padrão do PipelineEndpoint.
get_pipeline	Obtém o pipeline de uma versão especificada ou o padrão; gera uma exceção quando a versão não é encontrada.
list	Lista os PipelineEndpoints ativos no workspace atual.
list_pipelines	Obtém uma lista de pipelines associados ao PipelineEndpoint.
list_versions	Obtém uma lista de pipelines e versões correspondentes do PipelineEndpoint.
publish	Criar um PipelineEndpoint com o nome e o pipeline/pipeline publicado especificados. O ponto de extremidade do pipeline é uma API REST que pode ser usada por aplicativos externos. Para obter informações sobre como autenticar ao chamar pontos de extremidade REST, consulte https://aka.ms/pl-restep-auth. Para saber como trabalhar com pontos de extremidade de pipeline, confira https://aka.ms/pl-first-pipeline. Gera uma exceção quando já existe um PipelineEndpoint com o nome fornecido.
reactivate	Reativar um PipelineEndpoint arquivado.
set_default	Define a versão padrão de PipelineEndpoint; gera uma exceção quando o pipeline especificado não é encontrado.
set_default_version	Define a versão padrão de PipelineEndpoint; gera uma exceção quando a versão especificada não é encontrada.
set_name	Define o nome do PipelineEndpoint.
submit	Envia um experimento de pipeline de determinada versão; se version for Nenhum, disparará a versão padrão do pipeline.

add

Adiciona o pipeline especificado ao PipelineEndpoint.

add(pipeline)

Parâmetros

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

add_default

Adiciona o pipeline especificado ao PipelineEndpoint e define 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 a ser adicionado como a versão padrão.

disable

Define o PipelineEndpoint como 'Desabilitado' e indisponível para execução.

disable()

enable

Define o PipelineEndpoint como 'Ativo' e disponível para execução.

enable()

get

Obtém o PipelineEndpoint por nome ou ID; gera uma exceção quando algum dos dois não é fornecido.

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace em que 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 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
PipelineEndpoint	O objeto PipelineEndpoint.

get_all

Obter todos os PipelineEndpoints ativos no workspace atual.

Obter todos os PipelineEndpoints ativos. OBSERVAÇÃO: esse método está sendo preterido e será substituído por 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 true, só retorna PipelineEndpoints ativos no momento. Valor padrão: True
_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
list	A lista de objetos PipelineEndpoint.

get_all_pipelines

Obtém a lista de pipelines no PipelineEndpoint.

OBSERVAÇÃO: esse método está sendo preterido e será substituído por list_pipelines()

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

Parâmetros

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

get_all_versions

Obtém a lista de pipelines e as versões correspondentes em PipelineEndpoint.

OBSERVAÇÃO: esse método está sendo preterido e será substituído por 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 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
list	A lista de objetos PipelineVersion.

get_default_version

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

Obtém o pipeline de uma versão especificada ou o padrão; gera uma exceção quando a versão não é 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

Lista os 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 true, só retorna PipelineEndpoints 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 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
list	A lista de objetos PipelineEndpoint.

list_pipelines

Obtém 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 apenas pipelines ativos devem ser retornados. Valor padrão: True
_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
list	A lista de objetos PublishedPipeline.

list_versions

Obtém 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 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
list	A lista de objetos PipelineVersion.

publish

Criar um PipelineEndpoint com o nome e o pipeline/pipeline publicado especificados.

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

Para saber como trabalhar com pontos de extremidade de pipeline, confira https://aka.ms/pl-first-pipeline.

Gera uma exceção quando já existe um PipelineEndpoint com o nome fornecido.

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace em que o PipelineEndpoint será criado.
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 o 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 do fluxo de trabalho. Valor padrão: None

Retornos

Tipo	Description
PipelineEndpoint	Um novo PipelineEndpoint.

Exceções

Tipo	Description
ValueError

reactivate

Reativar um PipelineEndpoint 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

Define a versão padrão de PipelineEndpoint; gera uma exceção quando o pipeline especificado não é 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

Define a versão padrão de PipelineEndpoint; gera uma exceção quando a versão especificada não é encontrada.

set_default_version(version)

Parâmetros

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

Exceções

Tipo	Description
ValueError

set_name

Define o nome do PipelineEndpoint.

set_name(name)

Parâmetros

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

submit

Envia um experimento de pipeline de determinada versão; se version for Nenhum, disparará 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, transmitidos como um dicionário de {nome: valor}. Consulte PipelineParameter para obter mais detalhes. Valor padrão: None
parent_run_id	str É 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 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 de pipeline enviada.

Exceções

Tipo	Description
ValueError

Atributos

default_version

Obtém a versão padrão do PipelineEndpoint.

Retornos

Tipo	Description
str	A versão padrão.

description

Obtém a descrição do PipelineEndpoint.

Retornos

Tipo	Description
str	A descrição.

endpoint

Obtém 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 o PipelineEndpoint executar o pipeline.

id

Obtém a ID do PipelineEndpoint.

Retornos

Tipo	Description
str	A ID do PipelineEndpoint.

name

Obtém o nome do PipelineEndpoint.

Retornos

Tipo	Description
str	O nome.

pipeline_version_list

Obtém a lista de versões do pipeline.

Retornos

Tipo	Description
list	A lista de objetos PipelineIdVersion.

status

Obtém o status do PipelineEndpoint.

Retornos

Tipo	Description
str	O status.

swaggerurl

Obtém 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	Swagger REST para o PipelineEndpoint executar o pipeline.

Compartilhar via

PipelineEndpoint Classe

Construtor

Parâmetros

Comentários

Métodos

add

Parâmetros

add_default

Parâmetros

archive

disable

enable

get

Parâmetros

Retornos

get_all

Parâmetros

Retornos

get_all_pipelines

Parâmetros

Retornos

get_all_versions

Parâmetros

Retornos

get_default_version

Retornos

get_pipeline

Parâmetros

Retornos

list

Parâmetros

Retornos

list_pipelines

Parâmetros

Retornos

list_versions

Parâmetros

Retornos

publish

Parâmetros

Retornos

Exceções

reactivate

Parâmetros

Retornos

set_default

Parâmetros

Exceções

set_default_version

Parâmetros

Exceções

set_name

Parâmetros

submit

Parâmetros

Retornos

Exceções

Atributos

default_version

Retornos

description

Retornos

endpoint

Retornos

id

Retornos

name

Retornos

pipeline_version_list

Retornos

status

Retornos

swaggerurl

Retornos

Comentários

Recursos adicionais