PipelineRun Clase

Representa una ejecución de .Pipeline

Esta clase se puede usar para administrar, comprobar el estado y recuperar los detalles de ejecución una vez que se envía una ejecución de canalización. Use get_steps para recuperar los StepRun objetos creados por la ejecución de la canalización. Otros usos incluyen recuperar el Graph objeto asociado a la ejecución de la canalización, capturar el estado de la ejecución de la canalización y esperar la finalización de la ejecución.

Inicialice una ejecución de canalización.

Constructor

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parámetros

Nombre	Description
experiment Requerido	Experiment Objeto de experimento asociado a la ejecución de canalización.
run_id Requerido	str Identificador de ejecución de la ejecución de la canalización.
_service_endpoint	str Punto de conexión al que se va a conectar. Valor predeterminado: None
experiment Requerido	Experiment Objeto de experimento asociado a la ejecución de canalización.
run_id Requerido	str Identificador de ejecución de la ejecución de la canalización.
_service_endpoint Requerido	str Punto de conexión al que se va a conectar.

Comentarios

Se devuelve un objeto PipelineRun al enviar un Pipeline objeto a través de submit. método de .Experiment Para obtener más información sobre cómo crear y enviar una canalización, vea: https://aka.ms/pl-first-pipeline.

También se puede crear una instancia de PipelineRun con la Experiment ejecución enviada a y el identificador pipelineRun como se indica a continuación:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

Al trabajar con PipelineRun, use:

wait_for_completion para supervisar el estado de ejecución y, opcionalmente, transmitir registros de ejecución.
get_status para capturar el estado de ejecución.
cancel para cancelar una pipelineRun en curso.
get_steps para enumerar los StepRuns generados. PipelineRun genera un StepRun para cada paso de la canalización.

Métodos

cancel	Cancele la ejecución en curso.
child_run	Cree una ejecución secundaria para la ejecución de canalización. Este método no se implementa para PipelineRun.
complete	Marque la ejecución de la canalización como completada. Este método no se implementa para PipelineRun. Este método no se admite para canalizaciones; el estado de finalización o error se administra mediante el back-end de Azure ML.
fail	Marque la ejecución de la canalización como errónea. Este método no se implementa para PipelineRun. Este método no se admite para canalizaciones; el estado de finalización o error se administra mediante el back-end de Azure ML.
find_step_run	Busque una ejecución de pasos en la canalización por nombre.
get	Capturar una ejecución de canalización basada en un identificador de ejecución.
get_graph	Obtenga el gráfico de la ejecución de la canalización.
get_pipeline_output	Obtenga portDataReference para la salida de canalización especificada.
get_pipeline_runs	Capture las ejecuciones de canalización que se generaron a partir de una canalización publicada.
get_status	Capture el estado más reciente de la ejecución de la canalización desde el servicio. Los valores comunes devueltos incluyen "Running", "Finished" y "Failed".
get_steps	Obtenga las ejecuciones de pasos para todos los pasos de canalización que se han completado o empezado a ejecutarse.
get_tags	Obtenga el conjunto de etiquetas para la ejecución.
publish_pipeline	Publique una canalización y haga que esté disponible para volver a ejecutar. Puede obtener el punto de conexión de canalización del objeto PublishedPipeline devuelto por esta función. Con el punto de conexión de canalización, puede invocar la canalización desde aplicaciones externas mediante llamadas REST. Para obtener información sobre cómo autenticarse al llamar a puntos de conexión REST, consulte https://aka.ms/pl-restep-auth. La canalización original asociada a la ejecución de canalización se usa como base para la canalización publicada.
save	Guarde la canalización YAML en un archivo.
wait_for_completion	Espere a que finalice esta ejecución de canalización. Devuelve el estado después de la espera.

cancel

Cancele la ejecución en curso.

cancel()

child_run

Cree una ejecución secundaria para la ejecución de canalización. Este método no se implementa para PipelineRun.

child_run(name=None, run_id=None, outputs=None)

Parámetros

Nombre	Description
name	str Nombre opcional para el elemento secundario. Valor predeterminado: None
run_id	str Identificador de ejecución opcional para el elemento secundario; de lo contrario, usa el valor predeterminado. Valor predeterminado: None
outputs	str Directorio de salidas opcionales para realizar el seguimiento del elemento secundario. Valor predeterminado: None

Devoluciones

Tipo	Description
Run	Se ejecuta el elemento secundario.

Excepciones

Tipo	Description
NotImplementedError

complete

Marque la ejecución de la canalización como completada. Este método no se implementa para PipelineRun.

Este método no se admite para canalizaciones; el estado de finalización o error se administra mediante el back-end de Azure ML.

complete()

Excepciones

Tipo	Description
NotImplementedError

fail

Marque la ejecución de la canalización como errónea. Este método no se implementa para PipelineRun.

Este método no se admite para canalizaciones; el estado de finalización o error se administra mediante el back-end de Azure ML.

fail()

Excepciones

Tipo	Description
NotImplementedError

find_step_run

Busque una ejecución de pasos en la canalización por nombre.

find_step_run(name)

Parámetros

Nombre	Description
name Requerido	str Nombre del paso que se va a buscar.

Devoluciones

Tipo	Description
list	Lista de StepRun objetos con el nombre proporcionado.

get

Capturar una ejecución de canalización basada en un identificador de ejecución.

static get(workspace, run_id, _service_endpoint=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo asociada a la canalización.
run_id Requerido	str El identificador de la ejecución de canalización.
_service_endpoint	str Punto de conexión al que se va a conectar. Valor predeterminado: None

Devoluciones

Tipo	Description
PipelineRun	Objeto PipelineRun.

get_graph

Obtenga el gráfico de la ejecución de la canalización.

get_graph()

Devoluciones

Tipo	Description
Graph	Gráfico.

get_pipeline_output

Obtenga portDataReference para la salida de canalización especificada.

get_pipeline_output(pipeline_output_name)

Parámetros

Nombre	Description
pipeline_output_name Requerido	str Nombre de la salida de la canalización que se va a obtener.

Devoluciones

Tipo	Description
PortDataReference	PortDataReference que representa los datos de salida de la canalización.

get_pipeline_runs

Capture las ejecuciones de canalización que se generaron a partir de una canalización publicada.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo asociada a la canalización.
pipeline_id Requerido	str Identificador de la canalización publicada.
_service_endpoint	str Punto de conexión al que se va a conectar. Valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de PipelineRun objetos.

get_status

Capture el estado más reciente de la ejecución de la canalización desde el servicio.

Los valores comunes devueltos incluyen "Running", "Finished" y "Failed".

get_status()

Devoluciones

Tipo	Description
str	El estado más reciente como una cadena.

Comentarios

NotStarted: se trata de un estado temporal en los objetos Run del lado cliente antes del envío en la nube.
En ejecución: el trabajo comenzó a ejecutarse en el destino de proceso.
Error: error en la ejecución. Normalmente, la propiedad Error de una ejecución proporcionará detalles sobre por qué.
Finalizado: la ejecución se completó correctamente.
Cancelada: después de la solicitud de cancelación, la ejecución ahora se cancela correctamente.


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

Obtenga las ejecuciones de pasos para todos los pasos de canalización que se han completado o empezado a ejecutarse.

get_steps()

Devoluciones

Tipo	Description
list	Lista de StepRun objetos.

get_tags

Obtenga el conjunto de etiquetas para la ejecución.

get_tags()

Devoluciones

Tipo	Description
dict	Diccionario de etiquetas para la ejecución.

publish_pipeline

Publique una canalización y haga que esté disponible para volver a ejecutar.

Puede obtener el punto de conexión de canalización del objeto PublishedPipeline devuelto por esta función. Con el punto de conexión de canalización, puede invocar la canalización desde aplicaciones externas mediante llamadas REST. Para obtener información sobre cómo autenticarse al llamar a puntos de conexión REST, consulte https://aka.ms/pl-restep-auth.

La canalización original asociada a la ejecución de canalización se usa como base para la canalización publicada.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parámetros

Nombre	Description
name Requerido	str Nombre de la canalización publicada.
description Requerido	str Descripción de la canalización publicada.
version Requerido	str Versión de la canalización publicada.
continue_on_step_failure	bool Si desea continuar la ejecución de otros pasos en PipelineRun si se produce un error en un paso. El valor predeterminado es False. Valor predeterminado: None
kwargs Requerido	dict Argumentos de palabra clave personalizados, reservados para el desarrollo futuro

Devoluciones

Tipo	Description
PublishedPipeline	Canalización publicada creada.

save

Guarde la canalización YAML en un archivo.

save(path=None)

Parámetros

Nombre	Description
path	str Ruta de acceso a la que se va a guardar YAML. Si la ruta de acceso es un directorio, el archivo YAML de canalización se guarda en <la ruta de acceso> o pipeline.yml. Si la ruta de acceso no es ninguna, se usa el directorio actual. Valor predeterminado: None

Devoluciones

Tipo	Description
None

wait_for_completion

Espere a que finalice esta ejecución de canalización.

Devuelve el estado después de la espera.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parámetros

Nombre	Description
show_output	bool Indica si se muestra el estado de ejecución de la canalización en sys.stdout. Valor predeterminado: True
timeout_seconds	int El número de segundos que se va a esperar antes de que se agote el tiempo de espera. Valor predeterminado: 9223372036854775807
raise_on_error	bool Indica si se debe producir un error cuando la ejecución está en estado de error. Valor predeterminado: True

Devoluciones

Tipo	Description
str	Estado final.

Compartir a través de

PipelineRun Clase

Constructor

Parámetros

Comentarios

Métodos

cancel

child_run

Parámetros

Devoluciones

Excepciones

complete

Excepciones

fail

Excepciones

find_step_run

Parámetros

Devoluciones

get

Parámetros

Devoluciones

get_graph

Devoluciones

get_pipeline_output

Parámetros

Devoluciones

get_pipeline_runs

Parámetros

Devoluciones

get_status

Devoluciones

Comentarios

get_steps

Devoluciones

get_tags

Devoluciones

publish_pipeline

Parámetros

Devoluciones

save

Parámetros

Devoluciones

wait_for_completion

Parámetros

Devoluciones

Comentarios