PipelineRun Clase

Referencia

Representa una ejecución de una Pipeline.

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

Inicialice una ejecución de canalización.

Herencia: Run

PipelineRun

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 Id. de la ejecución de canalización.
_service_endpoint	str El punto de conexión al que conectarse. Valor predeterminado: None
experiment Requerido	Experiment Objeto de experimento asociado a la ejecución de canalización.
run_id Requerido	str Id. de la ejecución de canalización.
_service_endpoint Requerido	str El punto de conexión al que conectarse.

Comentarios

Devuelve un objeto PipelineRun al enviar una Pipeline mediante submit. Método de un Experiment. Para más información sobre cómo crear y enviar una canalización, consulte: https://aka.ms/pl-first-pipeline.

También se pueden crear instancias de PipelineRun con el Experiment de la ejecución a la que se envió y el id. de 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>")

Cuando trabaje 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 un PipelineRun en curso.
get_steps para enumerar las StepRuns generadas. PipelineRun genera una StepRun para cada paso de la canalización.

Métodos

cancel	Cancela la ejecución en curso.
child_run	Crea una ejecución secundaria para la ejecución de canalización. Este método no se implementa en PipelineRun.
complete	Marca la ejecución de canalización como completada. Este método no se implementa en PipelineRun. Este método no se admite para las canalizaciones; el estado de finalización o error lo administra el servidor back-end de Azure Machine Learning.
fail	Marca la ejecución de canalización como con errores. Este método no se implementa en PipelineRun. Este método no se admite para las canalizaciones; el estado de finalización o error lo administra el servidor back-end de Azure Machine Learning.
find_step_run	Busca un paso ejecutado en la canalización por nombre.
get	Captura una ejecución de canalización basada en un id. de ejecución.
get_graph	Obtiene el grafo de la ejecución de canalización.
get_pipeline_output	Obtiene el valor de PortDataReference para la salida de canalización dada.
get_pipeline_runs	Captura las ejecuciones de canalización que se generaron en una canalización publicada.
get_status	Captura 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	Obtiene las ejecuciones del paso de todos los pasos de canalización que han completado o iniciado la ejecución.
get_tags	Obtiene el conjunto de etiquetas de la ejecución.
publish_pipeline	Publica una canalización y hace que esté disponible para volver a ejecutarse. Puede obtener el punto de conexión de canalización del objeto PublishedPipeline que devuelve esta función. Con el punto de conexión de canalización, puede invocar la canalización desde aplicaciones externas mediante 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. La canalización original asociada a la ejecución de canalización se usa como base para la canalización publicada.
save	Guarda el archivo YAML de la canalización en un archivo.
wait_for_completion	Espera a que finalice la ejecución de esta canalización. Devuelve el estado después de la espera.

cancel

Cancela la ejecución en curso.

cancel()

child_run

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

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

Parámetros

Nombre	Description
name	str Nombre opcional del elemento secundario. Valor predeterminado: None
run_id	str Id. de ejecución opcional del 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	Ejecución secundaria.

Excepciones

Tipo	Description
NotImplementedError

complete

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

Este método no se admite para las canalizaciones; el estado de finalización o error lo administra el servidor back-end de Azure Machine Learning.

complete()

Excepciones

Tipo	Description
NotImplementedError

fail

Marca la ejecución de canalización como con errores. Este método no se implementa en PipelineRun.

Este método no se admite para las canalizaciones; el estado de finalización o error lo administra el servidor back-end de Azure Machine Learning.

fail()

Excepciones

Tipo	Description
NotImplementedError

find_step_run

Busca un paso ejecutado en la canalización por nombre.

find_step_run(name)

Parámetros

Nombre	Description
name Requerido	str Nombre del paso que se buscará.

Devoluciones

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

get

Captura una ejecución de canalización basada en un id. 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 El punto de conexión al que conectarse. Valor predeterminado: None

Devoluciones

Tipo	Description
PipelineRun	Objeto PipelineRun.

get_graph

Obtiene el grafo de la ejecución de canalización.

get_graph()

Devoluciones

Tipo	Description
Graph	Gráfico.

get_pipeline_output

Obtiene el valor de PortDataReference para la salida de canalización dada.

get_pipeline_output(pipeline_output_name)

Parámetros

Nombre	Description
pipeline_output_name Requerido	str Nombre de la salida de canalización que se obtiene.

Devoluciones

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

get_pipeline_runs

Captura las ejecuciones de canalización que se generaron en 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 Id. de la canalización publicada.
_service_endpoint	str El punto de conexión al que conectarse. Valor predeterminado: None

Devoluciones

Tipo	Description
list	Una lista de objetos PipelineRun.

get_status

Captura 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	Estado más reciente como una cadena.

Comentarios

NotStarted: Se trata de un estado temporal en el que se encuentran los objetos de ejecución del lado del cliente antes del envío a la nube.
Running: El trabajo comenzó a ejecutarse en el destino de proceso.
Failed: Error en la ejecución. Normalmente, la propiedad Error de una ejecución proporcionará detalles sobre por qué se produjo el error.
Finished: La ejecución se completó correctamente.
Canceled: Después de la solicitud de cancelación, la ejecución 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

Obtiene las ejecuciones del paso de todos los pasos de canalización que han completado o iniciado la ejecución.

get_steps()

Devoluciones

Tipo	Description
list	Una lista de objetos StepRun.

get_tags

Obtiene el conjunto de etiquetas de la ejecución.

get_tags()

Devoluciones

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

publish_pipeline

Publica una canalización y hace que esté disponible para volver a ejecutarse.

Puede obtener el punto de conexión de canalización del objeto PublishedPipeline que devuelve esta función. Con el punto de conexión de canalización, puede invocar la canalización desde aplicaciones externas mediante 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.

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 Indica 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. Valor predeterminado: None
kwargs Requerido	dict Argumentos de palabra clave personalizados, reservados para el desarrollo futuro

Devoluciones

Tipo	Description
PublishedPipeline	Canalización creada y publicada.

save

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

save(path=None)

Parámetros

Nombre	Description
path	str 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.yml. Si la ruta de acceso es None, se usará el directorio actual. Valor predeterminado: None

Devoluciones

Tipo	Description
None

wait_for_completion

Espera a que finalice la ejecución de esta 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 debe mostrar el estado de ejecución de 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 generar un error cuando la ejecución está en un estado de error. Valor predeterminado: True

Devoluciones

Tipo	Description
str	El 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

Recursos adicionales