PipelineEndpoint Clase
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.
Inicialice PipelineEndpoint.
- Herencia
-
builtins.objectPipelineEndpoint
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
- default_version
- str
Versión predeterminada de la canalización en PipelineEndpoint (incrementos automáticos, comienza por "0").
- endpoint
- str
Dirección URL del punto de conexión REST para PipelineEndpoint, que se puede usar para enviar ejecuciones de canalización.
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
Proveedor de PipelineEndpoint.
- _pipeline_endpoint_provider
Proveedor de PublishedPipeline.
- default_version
- str
La versión predeterminada de la canalización en PipelineEndpoint, incrementos automáticos, comienza por "0".
- endpoint
- str
Dirección URL del punto de conexión rest para PipelineEndpoint para enviar ejecuciones de canalización.
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
Proveedor de PipelineEndpoint.
- _pipeline_endpoint_provider
Proveedor de PublishedPipeline.
- swaggerendpoint
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
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
- pipeline
- PublishedPipeline
Canalización publicada que se agregará como versión predeterminada.
archive
Archive PipelineEndpoint.
archive()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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Objeto PipelineEndpoint.
Tipo de valor devuelto
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
- active_only
- bool
Si es true, solo devuelve los objetos PipelineEndpoints que están activos actualmente.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Lista de objetos PipelineEndpoint.
Tipo de valor devuelto
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Lista de objetos PublishedPipeline.
Tipo de valor devuelto
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Lista de objetos PipelineVersion.
Tipo de valor devuelto
get_default_version
Obtiene la versión predeterminada de PipelineEndpoint.
get_default_version()Devoluciones
Versión predeterminada del punto de conexión de canalización.
Tipo de valor devuelto
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
Devoluciones
Canalización publicada.
Tipo de valor devuelto
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
- active_only
- bool
Si es true, solo devuelve los objetos PipelineEndpoints que están activos actualmente.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Lista de objetos PipelineEndpoint.
Tipo de valor devuelto
list_pipelines
Obtiene una lista de canalizaciones asociadas a PipelineEndpoint.
list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)Parámetros
- active_only
- bool
Indica si se deben devolver solo canalizaciones activas.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Lista de objetos PublishedPipeline.
Tipo de valor devuelto
list_versions
Obtiene una lista de canalizaciones y las versiones correspondientes de PipelineEndpoint.
list_versions(_workflow_provider=None, _service_endpoint=None)Parámetros
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Lista de objetos PipelineVersion.
Tipo de valor devuelto
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
El proveedor de flujo de trabajo.
Devoluciones
Nuevo PipelineEndpoint.
Tipo de valor devuelto
Excepciones
reactivate
Reactive un objeto PipelineEndpoint que se archivó.
reactivate(name)Parámetros
Devoluciones
Objeto PipelineEndpoint.
Tipo de valor devuelto
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
- pipeline
- PublishedPipeline
Canalización publicada que se establecerá como valor predeterminado.
Excepciones
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
Excepciones
set_name
Establezca el nombre de PipelineEndpoint.
set_name(name)Parámetros
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
- 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.
- 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.
Devoluciones
Ejecución de canalización enviada.
Tipo de valor devuelto
Excepciones
Atributos
default_version
Obtiene la versión predeterminada de PipelineEndpoint.
Devoluciones
Versión predeterminada.
Tipo de valor devuelto
description
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
Punto de conexión REST para PipelineEndpoint para ejecutar la canalización.
Tipo de valor devuelto
id
Obtiene el identificador de PipelineEndpoint.
Devoluciones
Identificador de PipelineEndpoint.
Tipo de valor devuelto
name
pipeline_version_list
Obtiene la lista de versiones de canalización.
Devoluciones
Lista de objetos PipelineIdVersion.
Tipo de valor devuelto
status
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
Swagger de REST para PipelineEndpoint para ejecutar la canalización.
Tipo de valor devuelto
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de