PipelineEndpoint Clase

Referencia

Representa un flujo de trabajo Pipeline que se puede desencadenar desde una dirección URL de punto de conexión única.

PipelineEndpoints se puede usar para crear nuevas versiones de PublishedPipeline mientras se mantiene el mismo punto de conexión. Los objetos PipelineEndpoints se denominan de forma única dentro de un área de trabajo.

Con el atributo de punto de conexión de un objeto PipelineEndpoint, puede desencadenar nuevas ejecuciones de canalización desde aplicaciones externas con llamadas REST. Para más información sobre cómo autenticarse al llamar a puntos de conexión REST, consulte https://aka.ms/pl-restep-auth.

Para obtener más información sobre cómo crear y ejecutar canalizaciones de aprendizaje automático, consulte https://aka.ms/pl-first-pipeline.

Inicializar PipelineEndpoint.

Herencia: builtins.object

PipelineEndpoint

Constructor

PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo en la que se define PipelineEndpoint.
id Requerido	str Identificador de PipelineEndpoint.
name Requerido	str Nombre de PipelineEndpoint.
description Requerido	str Descripción de PipelineEndpoint.
status Requerido	str Nuevo estado de PipelineEndpoint: "Activo" o "Deshabilitado".
default_version Requerido	str Versión predeterminada de la canalización en PipelineEndpoint (incrementos automáticos, comienza por "0").
endpoint Requerido	str Dirección URL del punto de conexión REST para PipelineEndpoint, que se puede usar para enviar ejecuciones de canalización.
pipeline_version_list Requerido	list Lista de objetos PipelineIdVersion.
_pipeline_endpoint_provider Requerido	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Proveedor de PipelineEndpoint.
_pipeline_endpoint_provider Requerido	Proveedor de PublishedPipeline.
workspace Requerido	Workspace El objeto de área de trabajo al que pertenece este pipelineEndpoint.
id Requerido	str Identificador de PipelineEndpoint.
name Requerido	str Nombre de PipelineEndpoint.
description Requerido	str Descripción de PipelineEndpoint.
status Requerido	str Nuevo estado de PipelineEndpoint: "Activo" o "Deshabilitado".
default_version Requerido	str La versión predeterminada de la canalización en PipelineEndpoint, incrementos automáticos, comienza por "0".
endpoint Requerido	str Dirección URL del punto de conexión rest para PipelineEndpoint para enviar ejecuciones de canalización.
pipeline_version_list Requerido	list Lista de elementos PipelineIdVersion
_pipeline_endpoint_provider Requerido	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Proveedor de PipelineEndpoint.
_pipeline_endpoint_provider Requerido	Proveedor de PublishedPipeline.
swaggerendpoint Requerido	Dirección URL del punto de conexión rest de Swagger para PipelineEndpoint para enviar ejecuciones de canalización.

Comentarios

Un objeto PipelineEndpoint se puede crear a partir de Pipeline o PublishedPipeline.

Un ejemplo para publicar desde una canalización o PublishedPipeline es el siguiente:


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

Envíe un objeto PipelineEndpoint mediante submit. Cuando se llama a submit, se crea un objeto PipelineRun que, a su vez, crea objetos StepRun para cada paso del flujo de trabajo.

Un ejemplo de cómo enviar un objeto PipelineEndpoint es el siguiente:


   from azureml.pipeline.core import PipelineEndpoint

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

Hay una serie de configuraciones opcionales que se pueden especificar al enviar un objeto PipelineEndpoint. Estos incluyen las siguientes:

pipeline_parameters: parámetros para la ejecución de la canalización, diccionario de {name: value}. Para obtener más información, consulte PipelineParameter.
parent_run_id: puede proporcionar un id. de ejecución para establecer la ejecución primaria de esta ejecución de canalización, que se refleja en RunHistory. La ejecución primaria debe pertenecer al mismo experimento al que se envía esta canalización.
pipeline_version: versión de canalización que se ejecutará.

Un ejemplo para enviar un objeto PipelineEndpoint con esta configuración es el siguiente:


   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 agregar una nueva versión de PipelineEndpoint, use:


   from azureml.pipeline.core import PipelineEndpoint

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

Consulte el cuaderno siguiente para obtener información adicional sobre cómo crear y usar PipelineEndpoints: https://aka.ms/pl-ver-endpoint.

Métodos

add	Agregue la canalización especificada a PipelineEndpoint.
add_default	Agregue la canalización especificada a PipelineEndpoint y establezca la versión predeterminada en la versión de canalización agregada.
archive	Archive PipelineEndpoint.
disable	Establezca PipelineEndpoint en "Deshabilitado" y no disponible para ejecutarse.
enable	Establezca PipelineEndpoint en "Activo" y disponible para ejecutarse.
get	Obtiene PipelineEndpoint por nombre o identificador; inicia una excepción si no se proporciona ninguno de ellos.
get_all	Obtiene todos los PipelineEndpoints activos en el área de trabajo actual. Obtiene todos los PipelineEndpoints activos. NOTA: Este método está en desuso en favor de PipelineEndpoint.list().
get_all_pipelines	Obtiene una lista de canalizaciones en PipelineEndpoint. NOTA: Este método está en desuso en favor de list_pipelines().
get_all_versions	Obtiene la lista de canalizaciones y las versiones correspondientes en PipelineEndpoint. NOTA: Este método está en desuso en favor de list_versions().
get_default_version	Obtiene la versión predeterminada de PipelineEndpoint.
get_pipeline	Obtiene la canalización de una versión especificada o el valor predeterminado; produce una excepción si no se encuentra la versión.
list	Enumere los PipelineEndpoints activos en el área de trabajo actual.
list_pipelines	Obtiene una lista de canalizaciones asociadas a PipelineEndpoint.
list_versions	Obtiene una lista de canalizaciones y las versiones correspondientes de PipelineEndpoint.
publish	Cree un objeto PipelineEndpoint con el nombre y la canalización o canalización publicada especificados. El punto de conexión de canalización es una API REST que se puede usar desde aplicaciones externas. Para más información sobre cómo autenticarse al llamar a puntos de conexión REST, consulte https://aka.ms/pl-restep-auth. Para obtener más información sobre cómo trabajar con puntos de conexión de canalización, vea https://aka.ms/pl-first-pipeline. Produce una excepción si ya existe un objeto PipelineEndpoint con el nombre especificado.
reactivate	Reactive un objeto PipelineEndpoint que se archivó.
set_default	Establezca la versión predeterminada de PipelineEndpoint; inicia una excepción si no se encuentra la canalización especificada.
set_default_version	Establezca la versión predeterminada de PipelineEndpoint; inicia una excepción si no se encuentra la versión especificada.
set_name	Establezca el nombre de PipelineEndpoint.
submit	Envíe un experimento de canalización de una versión determinada; si version es none desencadena la versión predeterminada de la canalización.

add

Agregue la canalización especificada a PipelineEndpoint.

add(pipeline)

Parámetros

Nombre	Description
pipeline Requerido	PublishedPipeline Canalización publicada que se agregará.

add_default

Agregue la canalización especificada a PipelineEndpoint y establezca la versión predeterminada en la versión de canalización agregada.

add_default(pipeline)

Parámetros

Nombre	Description
pipeline Requerido	PublishedPipeline Canalización publicada que se agregará como versión predeterminada.

disable

Establezca PipelineEndpoint en "Deshabilitado" y no disponible para ejecutarse.

disable()

enable

Establezca PipelineEndpoint en "Activo" y disponible para ejecutarse.

enable()

get

Obtiene PipelineEndpoint por nombre o identificador; inicia una excepción si no se proporciona ninguno de ellos.

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo en la que se creó PipelineEndpoint.
id	str Identificador de PipelineEndpoint. valor predeterminado: None
name	str Nombre de PipelineEndpoint. valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
PipelineEndpoint	Objeto PipelineEndpoint.

get_all

Obtiene todos los PipelineEndpoints activos en el área de trabajo actual.

Obtiene todos los PipelineEndpoints activos. NOTA: Este método está en desuso en favor de PipelineEndpoint.list().

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo.
active_only	bool Si es true, solo devuelve los objetos PipelineEndpoints que están activos actualmente. valor predeterminado: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de objetos PipelineEndpoint.

get_all_pipelines

Obtiene una lista de canalizaciones en PipelineEndpoint.

NOTA: Este método está en desuso en favor de list_pipelines().

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

Parámetros

Nombre	Description
active_only	bool Marca para devolver solo canalizaciones activas. valor predeterminado: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de objetos PublishedPipeline.

get_all_versions

Obtiene la lista de canalizaciones y las versiones correspondientes en PipelineEndpoint.

NOTA: Este método está en desuso en favor de list_versions().

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de objetos PipelineVersion.

get_default_version

Obtiene la versión predeterminada de PipelineEndpoint.

get_default_version()

Devoluciones

Tipo	Description
str	Versión predeterminada del punto de conexión de canalización.

get_pipeline

Obtiene la canalización de una versión especificada o el valor predeterminado; produce una excepción si no se encuentra la versión.

get_pipeline(version=None)

Parámetros

Nombre	Description
version	str Versión de la canalización que se devolverá. valor predeterminado: None

Devoluciones

Tipo	Description
PublishedPipeline	Canalización publicada.

list

Enumere los PipelineEndpoints activos en el área de trabajo actual.

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo.
active_only	bool Si es true, solo devuelve los objetos PipelineEndpoints que están activos actualmente. valor predeterminado: True
max_results	int max lines of returned PipelineEndpoints valor predeterminado: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de objetos PipelineEndpoint.

list_pipelines

Obtiene una lista de canalizaciones asociadas a PipelineEndpoint.

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

Parámetros

Nombre	Description
active_only	bool Indica si se deben devolver solo canalizaciones activas. valor predeterminado: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de objetos PublishedPipeline.

list_versions

Obtiene una lista de canalizaciones y las versiones correspondientes de PipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de objetos PipelineVersion.

publish

Cree un objeto PipelineEndpoint con el nombre y la canalización o canalización publicada especificados.

El punto de conexión de canalización es una API REST que se puede usar desde aplicaciones externas. Para más información sobre cómo autenticarse al llamar a puntos de conexión REST, consulte https://aka.ms/pl-restep-auth.

Para obtener más información sobre cómo trabajar con puntos de conexión de canalización, vea https://aka.ms/pl-first-pipeline.

Produce una excepción si ya existe un objeto PipelineEndpoint con el nombre especificado.

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo en la que se creará PipelineEndpoint.
name Requerido	str Nombre de PipelineEndpoint.
description Requerido	str Descripción de PipelineEndpoint.
pipeline Requerido	PublishedPipeline o Pipeline Canalización publicada o canalización.
_service_endpoint	str Extremo del servicio. valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> El proveedor de flujo de trabajo. valor predeterminado: None

Devoluciones

Tipo	Description
PipelineEndpoint	Nuevo PipelineEndpoint.

Excepciones

Tipo	Description
ValueError

reactivate

Reactive un objeto PipelineEndpoint que se archivó.

reactivate(name)

Parámetros

Nombre	Description
name Requerido	str Nombre que se establecerá.

Devoluciones

Tipo	Description
PipelineEndpoint	Objeto PipelineEndpoint.

set_default

Establezca la versión predeterminada de PipelineEndpoint; inicia una excepción si no se encuentra la canalización especificada.

set_default(pipeline)

Parámetros

Nombre	Description
pipeline Requerido	PublishedPipeline Canalización publicada que se establecerá como valor predeterminado.

Excepciones

Tipo	Description
ValueError

set_default_version

Establezca la versión predeterminada de PipelineEndpoint; inicia una excepción si no se encuentra la versión especificada.

set_default_version(version)

Parámetros

Nombre	Description
version Requerido	str Versión que se establecerá como versión predeterminada en PipelineEndpoint.

Excepciones

Tipo	Description
ValueError

set_name

Establezca el nombre de PipelineEndpoint.

set_name(name)

Parámetros

Nombre	Description
name Requerido	str Nombre que se establecerá.

submit

Envíe un experimento de canalización de una versión determinada; si version es none desencadena la versión predeterminada de la canalización.

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

Parámetros

Nombre	Description
experiment_name Requerido	str Nombre del experimento en el que se envía la canalización.
pipeline_parameters	dict Parámetros que se usarán en la ejecución de la canalización, pasados como un diccionario de {name: value}. Para obtener más información, consulte PipelineParameter. valor predeterminado: None
parent_run_id	str Puede proporcionar un identificador de ejecución para establecer la ejecución primaria de esta ejecución de canalización, que se refleja en RunHistory. La ejecución primaria debe pertenecer al mismo experimento al que se envía esta canalización. valor predeterminado: None
pipeline_version	str Versión de la canalización que se ejecutará. valor predeterminado: None

Devoluciones

Tipo	Description
PipelineRun	Ejecución de canalización enviada.

Excepciones

Tipo	Description
ValueError

Atributos

default_version

Obtiene la versión predeterminada de PipelineEndpoint.

Devoluciones

Tipo	Description
str	Versión predeterminada.

description

Obtiene la descripción de PipelineEndpoint.

Devoluciones

Tipo	Description
str	La descripción.

endpoint

Obtiene la dirección URL del punto de conexión REST de PipelineEndpoint.

El punto de conexión se puede usar para desencadenar ejecuciones de la canalización.

Devoluciones

Tipo	Description
str	Punto de conexión REST para PipelineEndpoint para ejecutar la canalización.

id

Obtiene el identificador de PipelineEndpoint.

Devoluciones

Tipo	Description
str	Identificador de PipelineEndpoint.

name

Obtiene el nombre de PipelineEndpoint.

Devoluciones

Tipo	Description
str	Nombre.

pipeline_version_list

Obtiene la lista de versiones de canalización.

Devoluciones

Tipo	Description
list	Lista de objetos PipelineIdVersion.

status

Obtiene el estado de PipelineEndpoint.

Devoluciones

Tipo	Description
str	Estado.

swaggerurl

Obtiene la dirección URL de Swagger de REST de PipelineEndpoint.

La dirección URL de Swagger puede ser el esquema de vista del punto de conexión de canalización.

Devoluciones

Tipo	Description
str	Swagger de REST para PipelineEndpoint para ejecutar la canalización.

Compartir a través de

PipelineEndpoint Clase

Constructor

Parámetros

Comentarios

Métodos

add

Parámetros

add_default

Parámetros

archive

disable

enable

get

Parámetros

Devoluciones

get_all

Parámetros

Devoluciones

get_all_pipelines

Parámetros

Devoluciones

get_all_versions

Parámetros

Devoluciones

get_default_version

Devoluciones

get_pipeline

Parámetros

Devoluciones

list

Parámetros

Devoluciones

list_pipelines

Parámetros

Devoluciones

list_versions

Parámetros

Devoluciones

publish

Parámetros

Devoluciones

Excepciones

reactivate

Parámetros

Devoluciones

set_default

Parámetros

Excepciones

set_default_version

Parámetros

Excepciones

set_name

Parámetros

submit

Parámetros

Devoluciones

Excepciones

Atributos

default_version

Devoluciones

description

Devoluciones

endpoint

Devoluciones

id

Devoluciones

name

Devoluciones

pipeline_version_list

Devoluciones

status

Devoluciones

swaggerurl

Devoluciones

Comentarios

Comentarios

Recursos adicionales