Partilhar via

PipelineEndpoint Classe

  • Referência

Representa um Pipeline fluxo de trabalho que pode ser acionado a partir de um URL de ponto final exclusivo.

Os PipelineEndpoints podem ser utilizados para criar novas versões de um PublishedPipeline enquanto mantêm o mesmo ponto final. Os PipelineEndpoints têm um nome exclusivo numa área de trabalho.

Com o atributo de ponto final de um objeto PipelineEndpoint, pode acionar novas execuções de pipeline a partir de aplicações externas com chamadas REST. Para obter informações sobre como autenticar ao chamar pontos finais 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.

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

Name Description
workspace
Necessário
Workspace

A área de trabalho em que o PipelineEndpoint está definido.
id
Necessário
str

O 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 estado do PipelineEndpoint: "Ativo" ou "Desativado".
default_version
Necessário
str

A versão predefinida do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0".
endpoint
Necessário
str

O URL do ponto final REST do PipelineEndpoint, que pode ser utilizado para submeter 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 fornecedor PipelineEndpoint.
_pipeline_endpoint_provider
Necessário

O fornecedor PublishedPipeline.
workspace
Necessário
Workspace

O objeto de área de trabalho a que este PipelineEndpoint pertencerá.
id
Necessário
str

O 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 estado do PipelineEndpoint: "Ativo" ou "Desativado".
default_version
Necessário
str

A versão predefinida do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0"
endpoint
Necessário
str

O URL do ponto final REST para PipelineEndpoint submeter 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 fornecedor PipelineEndpoint.
_pipeline_endpoint_provider
Necessário

O fornecedor PublishedPipeline.
swaggerendpoint
Necessário

O URL do ponto final REST do Swagger para PipelineEndpoint submeter execuções de pipeline.

Observações

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

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

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


   from azureml.pipeline.core import PipelineEndpoint

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

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

  • 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 à qual este pipeline está a ser submetido.

  • pipeline_version: a versão do pipeline a executar.

Um exemplo para submeter um PipelineEndpoint com estas definiçõ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, utilize:


   from azureml.pipeline.core import PipelineEndpoint

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

Consulte o seguinte bloco de notas para obter informações adicionais sobre como criar e utilizar 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 predefinida para adicionar a versão do pipeline.
archive

Arquivar o PipelineEndpoint.
disable

Defina o PipelineEndpoint como "Desativado" e indisponível para execução.
enable

Defina o PipelineEndpoint como "Ativo" e disponível para ser executado.
get

Obtenha o PipelineEndpoint por nome ou ID, gera uma exceção se não for fornecido.
get_all

Obtenha todos os PipelineEndpoints ativos na área de trabalho atual.

Obtenha todos os PipelineEndpoints ativos. NOTA: este método está a ser preterido a favor de PipelineEndpoint.list().
get_all_pipelines

Obtenha a lista de pipelines no PipelineEndpoint.

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

Obtenha a lista de pipelines e versões correspondentes no PipelineEndpoint.

NOTA: este método está a ser preterido a favor de list_versions()
get_default_version

Obtenha a versão predefinida do PipelineEndpoint.
get_pipeline

Obter o pipeline de uma versão especificada ou a predefinição; lança uma exceção se a versão não for encontrada.
list

Liste PipelineEndpoints ativos na área 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 final do pipeline é uma API REST que pode ser utilizada a partir de aplicações externas. Para obter informações sobre como autenticar ao chamar pontos finais REST, consulte https://aka.ms/pl-restep-auth.

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

Gera Exceção se já existir um PipelineEndpoint com o nome especificado.
reactivate

Reativar um PipelineEndpoint arquivado.
set_default

Defina a versão predefinida de PipelineEndpoint, gera uma exceção se o pipeline especificado não for encontrado.
set_default_version

Defina a versão predefinida de PipelineEndpoint, gera uma exceção se a versão especificada não for encontrada.
set_name

Defina o nome pipelineEndpoint.
submit

Submeter uma experimentação de pipeline de uma determinada versão; se a versão não for nenhuma, aciona a versão predefinida 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 predefinida para adicionar a versão do pipeline.

add_default(pipeline)

Parâmetros

Name Description
pipeline
Necessário
PublishedPipeline

Um pipeline publicado para adicionar como a versão predefinida.

archive

Arquivar o PipelineEndpoint.

archive()

disable

Defina o PipelineEndpoint como "Desativado" e indisponível para execução.

disable()

enable

Defina o PipelineEndpoint como "Ativo" e disponível para ser executado.

enable()

get

Obtenha o PipelineEndpoint por nome ou ID, gera uma exceção se 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

A área de trabalho em que o PipelineEndpoint foi criado.
id
str

O 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 fornecedor de fluxo de trabalho.

Default value: None
_service_endpoint
str

O ponto final de serviço.

Default value: None

Devoluções

Tipo Description
PipelineEndpoint

O objeto PipelineEndpoint.

get_all

Obtenha todos os PipelineEndpoints ativos na área de trabalho atual.

Obtenha todos os PipelineEndpoints ativos. NOTA: este método está a ser preterido a 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

A área de trabalho.
active_only
bool

Se for verdadeiro, devolva apenas os PipelineEndpoints que estão atualmente ativos.

Default value: True
_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
list

A lista de PipelineEndpoint objetos.

get_all_pipelines

Obtenha a 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 devolver apenas pipelines ativos.

Default value: True
_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
list

A lista de PublishedPipeline objetos.

get_all_versions

Obtenha a lista de pipelines e versões correspondentes no PipelineEndpoint.

NOTA: este método está a ser preterido a 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 fornecedor de fluxo de trabalho.

Default value: None
_service_endpoint
str

O ponto final de serviço.

Default value: None

Devoluções

Tipo Description
list

A lista de PipelineVersion objetos.

get_default_version

Obtenha a versão predefinida do PipelineEndpoint.

get_default_version()

Devoluções

Tipo Description
str

A versão predefinida do ponto final do pipeline.

get_pipeline

Obter o pipeline de uma versão especificada ou a predefiniçã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 devolver.

Default value: None

Devoluções

Tipo Description
PublishedPipeline

Um pipeline publicado.

list

Liste PipelineEndpoints ativos na área 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

A área de trabalho.
active_only
bool

Se for verdadeiro, devolva apenas Os Pontos Finais de Pipeline que estão atualmente ativos.

Default value: True
max_results
int

linhas máximas de PipelineEndpoints devolvidos

Default value: 100
_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
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 pretende devolver apenas pipelines ativos.

Default value: True
_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
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 fornecedor de fluxo de trabalho.

Default value: None
_service_endpoint
str

O ponto final de 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 final do pipeline é uma API REST que pode ser utilizada a partir de aplicações externas. Para obter informações sobre como autenticar ao chamar pontos finais REST, consulte https://aka.ms/pl-restep-auth.

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

Gera Exceção se já existir um PipelineEndpoint com o nome especificado.

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

Parâmetros

Name Description
workspace
Necessário
Workspace

A área de trabalho na qual criar o PipelineEndpoint.
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 final de serviço.

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
PipelineEndpoint

Um novo PipelineEndpoint.

Exceções

Tipo Description
ValueError

reactivate

Reativar um PipelineEndpoint 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 predefinida de PipelineEndpoint, gera 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 predefinir.

Exceções

Tipo Description
ValueError

set_default_version

Defina a versão predefinida de PipelineEndpoint, gera 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 definir como a versão predefinida no PipelineEndpoint.

Exceções

Tipo Description
ValueError

set_name

Defina o nome pipelineEndpoint.

set_name(name)

Parâmetros

Name Description
name
Necessário
str

O nome a definir.

submit

Submeter uma experimentação de pipeline de uma determinada versão; se a versão não for nenhuma, aciona a versão predefinida 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 da experimentação para submeter o pipeline.
pipeline_parameters
dict

Parâmetros a utilizar na execução do pipeline, transmitidos como um dicionário de {name: value}. Veja PipelineParameter para obter mais detalhes.

Default value: None
parent_run_id
str

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 deve pertencer à mesma experimentação à qual o pipeline está a ser submetido.

Default value: None
pipeline_version
str

A versão do pipeline a executar.

Default value: None

Devoluções

Tipo Description
PipelineRun

A execução do pipeline submetido.

Exceções

Tipo Description
ValueError

Atributos

default_version

Obtenha a versão predefinida do PipelineEndpoint.

Devoluções

Tipo Description
str

A versão predefinida.

description

Obtenha a descrição do PipelineEndpoint.

Devoluções

Tipo Description
str

A descrição.

endpoint

Obtenha o URL do ponto final REST do PipelineEndpoint.

O ponto final pode ser utilizado para acionar execuções do pipeline.

Devoluções

Tipo Description
str

Ponto final REST para PipelineEndpoint executar o pipeline.

id

Obtenha o ID do PipelineEndpoint.

Devoluções

Tipo Description
str

O 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 estado do PipelineEndpoint.

Devoluções

Tipo Description
str

O estado.

swaggerurl

Obtenha o URL do Swagger REST do PipelineEndpoint.

O URL do Swagger pode ser o esquema de visualização do ponto final do pipeline.

Devoluções

Tipo Description
str

REST Swagger para PipelineEndpoint para executar o pipeline.