PipelineEndpoint Classe

Representa um Pipeline fluxo de trabalho que pode ser desencadeado a partir de um URL de ponto final único.

PipelineEndpoints pode ser usado para criar novas versões de um PublishedPipeline modo mantendo o mesmo ponto final. PipelineEndpoints são nomeados exclusivamente dentro de um espaço de trabalho.

Utilizando o atributo ponto final de um objeto PipelineEndpoint, pode desencadear novas corres 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 a criação e execução de gasodutos de aprendizagem automática, consulte https://aka.ms/pl-first-pipeline .

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

workspace
Workspace

O espaço de trabalho em que o PipelineEndpoint é definido.

id
<xref:str>

A identificação do PipelineEndpoint.

name
<xref:str>

O nome do PipelineEndpoint.

description
<xref:str>

A descrição do PipelineEndpoint.

status
<xref:str>

O novo estado do PipelineEndpoint: 'Active' ou 'Disabled'.

default_version
<xref:str>

A versão padrão do pipeline em PipelineEndpoint, incrementos automáticos, começa com "0".

endpoint
<xref:str>

O URL de ponto final REST para o PipelineEndpoint, que pode ser usado para submeter corridas de gasoduto.

pipeline_version_list
list

A lista de PipelineIdVersion objetos.

_pipeline_endpoint_provider
<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>

O fornecedor PipelineEndpoint.

_pipeline_endpoint_provider
<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>

O provedor PublishedPipeline.

Observações

Um PipelineEndpoint pode ser criado a partir de um Pipeline ou 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")

Envie um PipelineEndpoint utilizando submit . Quando a submissão é chamada, é criada uma PipelineRun criação de StepRun objetos 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 enviar um PipelineEndpoint. Estas incluem:

  • pipeline_parameters: Parâmetros para a execução do gasoduto, dicionário de {nome: valor}. Veja PipelineParameter mais detalhes.

  • parent_run_id: Você pode fornecer um ID de execução para definir o funcionaamento dos pais deste curso de pipeline, que é refletido no RunHistory. A corrida dos pais deve pertencer à mesma experiência a que este oleoduto está a ser submetido.

  • pipeline_version: A versão do pipeline a funcionar.

Um exemplo para submeter um PipelineEndpoint utilizando 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 uma utilização pipelineEndpoint:


   from azureml.pipeline.core import PipelineEndpoint

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

Consulte o seguinte caderno para obter informações adicionais sobre a criação e utilização de PipelineEndpoints: https://aka.ms/pl-ver-endpoint .

Métodos

add

Adicione o gasoduto especificado ao PipelineEndpoint.

add_default

Adicione o gasoduto especificado ao PipelineEndpoint e desempenhe a versão padrão adicionada à versão do pipeline.

archive

Arquive o PipelineEndpoint.

disable

Desaponte o PipelineEndpoint para 'Desactivado' e indisponível para ser executado.

enable

Desaponte o PipelineEndpoint para 'Active' e disponível para executar.

get

Obtenha o PipelineEndpoint pelo nome ou ID, lança exceção se um dos dois não for fornecido.

get_all

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

Obtenha todos os PipelineEndpoints ativos. NOTA: Este método está a ser depreciado a favor da pipelineEndpoint.list().

get_all_pipelines

Obtenha uma lista de oleodutos em PipelineEndpoint.

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

get_all_versions

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

NOTA: Este método está a ser depreciado a favor de list_versions()

get_default_version

Obtenha a versão padrão do PipelineEndpoint.

get_pipeline

Obtenha o gasoduto de uma versão especificada ou o predefinido; lança uma exceção se a versão não for encontrada.

list

Listar pipelineendpoints ativos no espaço de trabalho atual.

list_pipelines

Obtenha uma lista de oleodutos associados ao PipelineEndpoint.

list_versions

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

publish

Crie um PipelineEndpoint com o nome especificado e o gasoduto/oleoduto publicado.

O ponto final do gasoduto é 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 o trabalho com os pontos finais do gasoduto, consulte https://aka.ms/pl-first-pipeline .

Lança exceção se já existir um PipelineEndpoint com o nome próprio.

reactivate

Reativar um PipelineEndpoint que foi arquivado.

set_default

Desaponte a versão padrão do PipelineEndpoint, abre uma exceção se o gasoduto especificado não for encontrado.

set_default_version

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

set_name

Desaponte o nome de PipelineEndpoint.

submit

Apresentar uma experiência de pipeline de versão dada; se a versão não for nenhuma, desencadeia a versão padrão do pipeline.

add

Adicione o gasoduto especificado ao PipelineEndpoint.

add(pipeline)

Parâmetros

pipeline
PublishedPipeline

Um oleoduto publicado para adicionar.

add_default

Adicione o gasoduto especificado ao PipelineEndpoint e desempenhe a versão padrão adicionada à versão do pipeline.

add_default(pipeline)

Parâmetros

pipeline
PublishedPipeline

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

archive

Arquive o PipelineEndpoint.

archive()

disable

Desaponte o PipelineEndpoint para 'Desactivado' e indisponível para ser executado.

disable()

enable

Desaponte o PipelineEndpoint para 'Active' e disponível para executar.

enable()

get

Obtenha o PipelineEndpoint pelo nome ou ID, lança exceção se um dos dois não for fornecido.

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

Parâmetros

workspace
Workspace

O espaço de trabalho em que o PipelineEndpoint foi criado.

id
<xref:str>
valor predefinido: None

A identificação do PipelineEndpoint.

name
<xref:str>
valor predefinido: None

O nome do PipelineEndpoint.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predefinido: None

O provedor de fluxo de trabalho.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

Devoluções

O objeto PipelineEndpoint.

Tipo de retorno

get_all

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

Obtenha todos os PipelineEndpoints ativos. NOTA: Este método está a ser depreciado a favor da pipelineEndpoint.list().

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

Parâmetros

workspace
Workspace

O espaço de trabalho.

active_only
<xref:bool>
valor predefinido: True

Se for verdade, apenas devolva os pontos PipelineEnd que estão atualmente ativos.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predefinido: None

O provedor de fluxo de trabalho.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

Devoluções

A lista de PipelineEndpoint objetos.

Tipo de retorno

get_all_pipelines

Obtenha uma lista de oleodutos em PipelineEndpoint.

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

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

Parâmetros

active_only
<xref:bool>
valor predefinido: True

Bandeira para devolver apenas oleodutos ativos.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predefinido: None

O provedor de fluxo de trabalho.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

Devoluções

A lista de PublishedPipeline objetos.

Tipo de retorno

get_all_versions

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

NOTA: Este método está a ser depreciado a favor de list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parâmetros

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predefinido: None

O provedor de fluxo de trabalho.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

Devoluções

A lista de PipelineVersion objetos.

Tipo de retorno

get_default_version

Obtenha a versão padrão do PipelineEndpoint.

get_default_version()

Devoluções

A versão padrão do ponto final do gasoduto.

Tipo de retorno

<xref:str>

get_pipeline

Obtenha o gasoduto de uma versão especificada ou o predefinido; lança uma exceção se a versão não for encontrada.

get_pipeline(version=None)

Parâmetros

version
<xref:str>
valor predefinido: None

A versão do oleoduto para regressar.

Devoluções

Um oleoduto publicado.

Tipo de retorno

list

Listar pipelineendpoints ativos no espaço de trabalho atual.

list(workspace, active_only=True, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace
Workspace

O espaço de trabalho.

active_only
<xref:bool>
valor predefinido: True

Se for verdade, apenas devolva os pontos PipelineEnd que estão atualmente ativos.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predefinido: None

O provedor de fluxo de trabalho.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

Devoluções

A lista de PipelineEndpoint objetos.

Tipo de retorno

list_pipelines

Obtenha uma lista de oleodutos associados ao PipelineEndpoint.

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

Parâmetros

active_only
<xref:bool>
valor predefinido: True

Indica se deve devolver apenas os gasodutos ativos.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predefinido: None

O provedor de fluxo de trabalho.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

Devoluções

A lista de PublishedPipeline objetos.

Tipo de retorno

list_versions

Obtenha uma lista de oleodutos 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>
valor predefinido: None

O provedor de fluxo de trabalho.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

Devoluções

A lista de PipelineVersion objetos.

Tipo de retorno

publish

Crie um PipelineEndpoint com o nome especificado e o gasoduto/oleoduto publicado.

O ponto final do gasoduto é 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 o trabalho com os pontos finais do gasoduto, consulte https://aka.ms/pl-first-pipeline .

Lança exceção se já existir um PipelineEndpoint com o nome próprio.

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

Parâmetros

workspace
Workspace

O espaço de trabalho para criar o PipelineEndpoint em.

name
<xref:str>

O nome do PipelineEndpoint.

description
<xref:str>

A descrição do PipelineEndpoint.

pipeline
PublishedPipeline ou Pipeline

O oleoduto ou oleoduto publicado.

_service_endpoint
<xref:str>
valor predefinido: None

O ponto final de serviço.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predefinido: None

O provedor de fluxo de trabalho.

Devoluções

Um novo PipelineEndpoint.

Tipo de retorno

Exceções

ValueError

reactivate

Reativar um PipelineEndpoint que foi arquivado.

reactivate(name)

Parâmetros

name
<xref:str>

O nome a definir.

Devoluções

Um objeto PipelineEndpoint.

Tipo de retorno

set_default

Desaponte a versão padrão do PipelineEndpoint, abre uma exceção se o gasoduto especificado não for encontrado.

set_default(pipeline)

Parâmetros

pipeline
PublishedPipeline

O oleoduto publicado para definir como padrão.

Exceções

ValueError

set_default_version

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

set_default_version(version)

Parâmetros

version
<xref:str>

A versão a definir como a versão padrão em PipelineEndpoint.

Exceções

ValueError

set_name

Desaponte o nome de PipelineEndpoint.

set_name(name)

Parâmetros

name
<xref:str>

O nome a definir.

submit

Apresentar uma experiência de pipeline de versão dada; se a versão não for nenhuma, desencadeia a versão padrão do pipeline.

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

Parâmetros

experiment_name
<xref:str>

O nome da experiência para enviar o oleoduto.

pipeline_parameters
<xref:dict>
valor predefinido: None

Parâmetros a utilizar na execução do gasoduto, passados como um dicionário de {nome: valor}. Veja PipelineParameter mais detalhes.

parent_run_id
<xref:str>
valor predefinido: None

Você pode fornecer um ID de execução para definir o funcionador dos pais deste curso de pipeline, que é refletido em RunHistory. A corrida dos pais deve pertencer à mesma experiência a que este oleoduto está a ser submetido.

pipeline_version
<xref:str>
valor predefinido: None

A versão do oleoduto a correr.

Devoluções

O gasoduto submetido.

Tipo de retorno

Exceções

ValueError

Atributos

default_version

Obtenha a versão padrão do PipelineEndpoint.

Devoluções

A versão padrão.

Tipo de retorno

<xref:str>

description

Obtenha a descrição do PipelineEndpoint.

Devoluções

A descrição.

Tipo de retorno

<xref:str>

endpoint

Obtenha o URL de ponto final REST do PipelineEndpoint.

O ponto final pode ser utilizado para desencadear os disparos do gasoduto.

Devoluções

PONTO final REST para PipelineEndpoint para executar o gasoduto.

Tipo de retorno

<xref:str>

id

Obter a identificação do PipelineEndpoint.

Devoluções

A identificação do PipelineEndpoint.

Tipo de retorno

<xref:str>

name

Pegue o nome do PipelineEndpoint.

Devoluções

O nome.

Tipo de retorno

<xref:str>

pipeline_version_list

Obtenha a lista de versão do pipeline.

Devoluções

A lista de PipelineIdVersion objetos.

Tipo de retorno

status

Obtenha o estado do PipelineEndpoint.

Devoluções

O estado.

Tipo de retorno

<xref:str>

swaggerurl

Obtenha o REST Swagger URL do PipelineEndpoint.

O url Swagger pode ser visto esquema do ponto final do gasoduto.

Devoluções

REST Swagger para PipelineEndpoint para executar o gasoduto.

Tipo de retorno

<xref:str>