PipelineEndpoint Classe
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.objectPipelineEndpoint
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
- default_version
- str
A versão padrão do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0".
- endpoint
- str
A URL do ponto de extremidade REST do PipelineEndpoint, que pode ser usada para enviar execuções de pipeline.
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
O provedor PipelineEndpoint.
- _pipeline_endpoint_provider
O provedor PublishedPipeline.
- default_version
- str
A versão padrão do pipeline no PipelineEndpoint, incrementos automáticos, começa com "0"
- endpoint
- str
A URL do ponto de extremidade REST para PipelineEndpoint enviar execuções de pipeline.
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
O provedor PipelineEndpoint.
- _pipeline_endpoint_provider
O provedor PublishedPipeline.
- swaggerendpoint
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
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
archive
Arquiva o PipelineEndpoint.
archive()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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
O objeto PipelineEndpoint.
Tipo de retorno
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
A lista de objetos PipelineEndpoint.
Tipo de retorno
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
A lista de objetos PublishedPipeline.
Tipo de retorno
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
A lista de objetos PipelineVersion.
Tipo de retorno
get_default_version
Obtém a versão padrão do PipelineEndpoint.
get_default_version()Retornos
A versão padrão do ponto de extremidade do pipeline.
Tipo de retorno
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
Retornos
Um pipeline publicado.
Tipo de retorno
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
A lista de objetos PipelineEndpoint.
Tipo de retorno
list_pipelines
Obtém uma lista de pipelines associados ao PipelineEndpoint.
list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)Parâmetros
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
A lista de objetos PublishedPipeline.
Tipo de retorno
list_versions
Obtém uma lista de pipelines e versões correspondentes do PipelineEndpoint.
list_versions(_workflow_provider=None, _service_endpoint=None)Parâmetros
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
A lista de objetos PipelineVersion.
Tipo de retorno
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
O provedor do fluxo de trabalho.
Retornos
Um novo PipelineEndpoint.
Tipo de retorno
Exceções
reactivate
Reativar um PipelineEndpoint arquivado.
reactivate(name)Parâmetros
Retornos
Um objeto PipelineEndpoint.
Tipo de retorno
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
Exceções
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
Exceções
set_name
Define o nome do PipelineEndpoint.
set_name(name)Parâmetros
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
- 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.
- 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.
Retornos
A execução de pipeline enviada.
Tipo de retorno
Exceções
Atributos
default_version
description
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
Ponto de extremidade REST para o PipelineEndpoint executar o pipeline.
Tipo de retorno
id
name
pipeline_version_list
Obtém a lista de versões do pipeline.
Retornos
A lista de objetos PipelineIdVersion.
Tipo de retorno
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
Swagger REST para o PipelineEndpoint executar o pipeline.
Tipo de retorno
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de