Compartir a través de

PublishedPipeline Clase

  • Referencia

Representa una canalización que se va a enviar sin el código Python que la construyó.

Además, se puede usar PublishedPipeline para volver a enviar una Pipeline con valores PipelineParameter y entradas diferentes.

Inicializar PublishedPipeline.

:p aram endpoint La dirección URL del punto de conexión REST para enviar ejecuciones de canalización para esta canalización. :type endpoint: str :p aram total_run_steps: el número de pasos de esta canalización :type total_run_steps: int :p aram workspace: el área de trabajo de la canalización publicada. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: Si desea continuar con la ejecución de otros pasos en PipelineRun

Si se produce un error en un paso, el valor predeterminado es false.

Herencia
azureml.core._portal.HasPipelinePortal
PublishedPipeline

Constructor

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Parámetros

name
str
Requerido

Nombre de la canalización publicada.

graph_id
str
Requerido

Id. del grafo de esta canalización publicada.

description
str
Requerido

Descripción de la canalización publicada.

version
str
Requerido

Versión de la canalización publicada.

published_pipeline_id
str
Requerido

Id. de la canalización publicada.

status
str
Requerido

Estado de la canalización publicada ("Activo" o "Deshabilitado").

endpoint
str
Requerido

Dirección URL del punto de conexión REST a la que enviar ejecuciones para esta canalización.

total_run_steps
int
Requerido

Número de pasos de esta canalización.

workspace
Workspace
Requerido

Área de trabajo de la canalización publicada.

continue_on_step_failure
bool
Requerido

Si se continúa la ejecución del resto de pasos en el elemento PipelineRun si se produce un error en un paso. El valor predeterminado es false.

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Requerido

Proveedor de la canalización publicada.

kwargs
dict
Requerido

Argumentos de palabra clave personalizados, reservados para el desarrollo futuro

name
str
Requerido

Nombre de la canalización publicada.

graph_id
str
Requerido

Id. del grafo de esta canalización publicada.

description
str
Requerido

Descripción de la canalización publicada.

version
str
Requerido

Versión de la canalización publicada.

published_pipeline_id
str
Requerido

Id. de la canalización publicada.

status
str
Requerido

Estado de la canalización publicada ("Activo" o "Deshabilitado").

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Requerido

Proveedor de la canalización publicada.

kwargs
dict
Requerido

Argumentos de palabra clave personalizados, reservados para el desarrollo futuro

Comentarios

Se puede crear un objeto PublishedPipeline a partir de Pipeline o PipelineRun.

Un ejemplo de la publicación desde una canalización es el siguiente:


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

Para publicar desde un objeto PipelineRun use:


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

Nota: el parámetro continue_on_step_failure especifica si la ejecución de pasos de la canalización continuará en caso de error en un paso. El valor predeterminado es False, lo que significa que cuando se produce un error en un paso, la ejecución de la canalización se detendrá y se cancelarán los pasos en ejecución.

Envía un objeto PublishedPipeline 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 envío de un objeto PublishedPipeline es el siguiente:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

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

  • continue_on_step_failure: si continúa la ejecución del resto de pasos en el objeto PipelineRun si se produce un error en un paso (opcional). Solo los pasos que no tengan dependencia de la salida del paso con error continuarán la ejecución. Si se proporciona, este valor de parámetro reemplaza al valor en la canalización.

  • 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 la canalización.

Un ejemplo de envío de un objeto PublishedPipeline con esta configuración es el siguiente:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

Todas las canalizaciones publicadas tienen un punto de conexión REST. Con el punto de conexión de canalización, puede desencadenar una ejecución de la canalización desde cualquier sistema externo, como los clientes que no son de Python. Para más información sobre cómo autenticarse al llamar a puntos de conexión REST, consulte https://aka.ms/pl-restep-auth.

Mediante el punto de conexión puede habilitar la "repetibilidad administrada" en los escenarios de puntuación y nuevo entrenamiento, por ejemplo. Para obtener más información, vea https://aka.ms/pl-first-pipeline.

Métodos

disable

Establece la canalización publicada en "Deshabilitada" y no está disponible para su ejecución.
enable

Establece la canalización publicada en "Activa" y está disponible para su ejecución.
get

Obtiene la canalización publicada.
get_all

Obtiene todas las canalizaciones publicadas en el área de trabajo actual.

EN DESUSO: este método está en desuso en favor del método list de PublishedPipeline.
get_graph

Obtiene el grafo del objeto PublishedPipeline.
get_step_names

Obtiene la lista de los nombres de los pasos de PublishedPipeline.
list

Obtiene todas las canalizaciones publicadas en el área de trabajo actual.
save

Guarda el archivo YAML de la canalización en un archivo.

Actualmente, solo se admiten las canalizaciones que constan de ModuleSteps para la exportación de YAML.
submit

Envía la canalización publicada. Equivale a utilizar submit.

Devuelve el elemento PipelineRun enviado. Se usa este objeto para supervisar y ver los detalles de la ejecución.

disable

Establece la canalización publicada en "Deshabilitada" y no está disponible para su ejecución.

disable()

enable

Establece la canalización publicada en "Activa" y está disponible para su ejecución.

enable()

get

Obtiene la canalización publicada.

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

Parámetros

workspace
Workspace
Requerido

Área de trabajo en la que se creó la canalización publicada.

id
str
Requerido

Id. de la canalización publicada.

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

El proveedor de flujo de trabajo.

_service_endpoint
str
valor predeterminado: None

Extremo del servicio.

Devoluciones

Objeto PublishedPipeline.

Tipo de valor devuelto

PublishedPipeline

get_all

Obtiene todas las canalizaciones publicadas en el área de trabajo actual.

EN DESUSO: este método está en desuso en favor del método list de PublishedPipeline.

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

Parámetros

workspace
Workspace
Requerido

Área de trabajo en la que se creó la canalización publicada.

active_only
bool
valor predeterminado: True

Indica si se deben devolver solo las canalizaciones publicadas que están activas actualmente.

_service_endpoint
str
valor predeterminado: None

Extremo del servicio.

Devoluciones

Lista de objetos PublishedPipeline.

Tipo de valor devuelto

list[PublishedPipeline]

get_graph

Obtiene el grafo del objeto PublishedPipeline.

get_graph(_workflow_provider=None)

Parámetros

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

El proveedor de flujo de trabajo.

Devoluciones

Gráfico.

Tipo de valor devuelto

Graph

get_step_names

Obtiene la lista de los nombres de los pasos de PublishedPipeline.

get_step_names(_workflow_provider=None)

Parámetros

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

El proveedor de flujo de trabajo.

Devoluciones

Lista de los nombres de los pasos de PublishedPipeline.

Tipo de valor devuelto

List[str]

list

Obtiene todas las canalizaciones publicadas en el área de trabajo actual.

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

Parámetros

workspace
Workspace
Requerido

Área de trabajo en la que se creó la canalización publicada.

active_only
bool
valor predeterminado: True

Indica si se deben devolver solo las canalizaciones publicadas que están activas actualmente.

_service_endpoint
str
valor predeterminado: None

Extremo del servicio.

Devoluciones

Lista de objetos PublishedPipeline.

Tipo de valor devuelto

list[PublishedPipeline]

save

Guarda el archivo YAML de la canalización en un archivo.

Actualmente, solo se admiten las canalizaciones que constan de ModuleSteps para la exportación de YAML.

save(path=None, _workflow_provider=None)

Parámetros

path
str
valor predeterminado: None

Ruta de acceso en la que se guardará el archivo YAML. Si la ruta de acceso es un directorio, el archivo YAML de canalización se guarda en path/pipeline_name.yml. Si la ruta de acceso es None, se usará el directorio actual.

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

El proveedor de flujo de trabajo.

Tipo de valor devuelto

None

submit

Envía la canalización publicada. Equivale a utilizar submit.

Devuelve el elemento PipelineRun enviado. Se usa este objeto para supervisar y ver los detalles de la ejecución.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Parámetros

workspace
Workspace
Requerido

Área de trabajo en la que se envía la canalización publicada.

experiment_name
str
Requerido

Nombre del experimento al que se envía.

pipeline_parameters
dict
valor predeterminado: None

Diccionario de parámetros para asignar nuevos valores {param name, param value}. Para obtener más información, consulte PipelineParameter.

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

El proveedor de flujo de trabajo.

_service_endpoint
str
valor predeterminado: None

Extremo del servicio.

parent_run_id
str
valor predeterminado: None

Id. de ejecución opcional que se establecerá para 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.

continue_on_step_failure
bool
valor predeterminado: None

Indica si se continúa la ejecución del resto de pasos en el objeto PipelineRun si se produce un error en un paso (opcional). Si se proporciona, reemplazará el valor en la canalización.

Devoluciones

Ejecución de canalización enviada.

Tipo de valor devuelto

PipelineRun

Atributos

continue_on_step_failure

Obtiene el valor de la opción continue_on_step_failure.

Devoluciones

Valor de la opción continue_on_step_failure.

Tipo de valor devuelto

bool

description

Obtiene la descripción de la canalización publicada.

Devoluciones

Descripción de la canalización publicada.

Tipo de valor devuelto

str

endpoint

Obtiene la dirección URL del punto de conexión REST para ejecutar una canalización publicada.

Devoluciones

Dirección URL del punto de conexión REST para ejecutar la canalización publicada.

Tipo de valor devuelto

str

graph_id

Obtiene el id. del grafo de esta canalización publicada.

Devoluciones

Id. del grafo.

Tipo de valor devuelto

str

id

Obtiene el id. de la canalización publicada.

Devoluciones

Id. de la canalización publicada.

Tipo de valor devuelto

str

name

Obtiene el nombre de la canalización publicada.

Devoluciones

Nombre de la canalización publicada.

Tipo de valor devuelto

str

status

Obtiene el estado de la canalización publicada.

Devoluciones

Estado de la canalización publicada.

Tipo de valor devuelto

str

total_run_steps

Obtiene el número de pasos de la canalización.

Devoluciones

Número de pasos de la canalización.

Tipo de valor devuelto

int

version

Obtiene la versión de la canalización publicada.

Devoluciones

Versión de la canalización publicada.

Tipo de valor devuelto

str