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

experiment
Experiment
Requerido

Objeto de experimento asociado a la ejecución de canalización.

run_id
str
Requerido

Id. de la ejecución de canalización.

_service_endpoint
str
valor predeterminado: None

El punto de conexión al que conectarse.

experiment
Experiment
Requerido

Objeto de experimento asociado a la ejecución de canalización.

run_id
str
Requerido

Id. de la ejecución de canalización.

_service_endpoint
str
Requerido

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

name
str
valor predeterminado: None

Nombre opcional del elemento secundario.

run_id
str
valor predeterminado: None

Id. de ejecución opcional del elemento secundario; de lo contrario, usa el valor predeterminado.

outputs
str
valor predeterminado: None

Directorio de salidas opcionales para realizar el seguimiento del elemento secundario.

Devoluciones

Ejecución secundaria.

Tipo de valor devuelto

Run

Excepciones

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

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

NotImplementedError

find_step_run

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

find_step_run(name)

Parámetros

name
str
Requerido

Nombre del paso que se buscará.

Devoluciones

Lista de objetos StepRun con el nombre proporcionado.

Tipo de valor devuelto

list

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

workspace
Workspace
Requerido

Área de trabajo asociada a la canalización.

run_id
str
Requerido

El identificador de la ejecución de canalización.

_service_endpoint
str
valor predeterminado: None

El punto de conexión al que conectarse.

Devoluciones

Objeto PipelineRun.

Tipo de valor devuelto

PipelineRun

get_graph

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

get_graph()

Devoluciones

Gráfico.

Tipo de valor devuelto

Graph

get_pipeline_output

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

get_pipeline_output(pipeline_output_name)

Parámetros

pipeline_output_name
str
Requerido

Nombre de la salida de canalización que se obtiene.

Devoluciones

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

Tipo de valor devuelto

PortDataReference

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

workspace
Workspace
Requerido

Área de trabajo asociada a la canalización.

pipeline_id
str
Requerido

Id. de la canalización publicada.

_service_endpoint
str
valor predeterminado: None

El punto de conexión al que conectarse.

Devoluciones

Una lista de objetos PipelineRun.

Tipo de valor devuelto

list

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

Estado más reciente como una cadena.

Tipo de valor devuelto

str

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

Una lista de objetos StepRun.

Tipo de valor devuelto

list

get_tags

Obtiene el conjunto de etiquetas de la ejecución.

get_tags()

Devoluciones

Diccionario de etiquetas de la ejecución.

Tipo de valor devuelto

dict

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

name
str
Requerido

Nombre de la canalización publicada.

description
str
Requerido

Descripción de la canalización publicada.

version
str
Requerido

Versión de la canalización publicada.

continue_on_step_failure
bool
valor predeterminado: None

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.

kwargs
dict
Requerido

Argumentos de palabra clave personalizados, reservados para el desarrollo futuro

Devoluciones

Canalización creada y publicada.

Tipo de valor devuelto

PublishedPipeline

save

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

save(path=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.yml. Si la ruta de acceso es None, se usará el directorio actual.

Tipo de valor devuelto

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

show_output
bool
valor predeterminado: True

Indica si se debe mostrar el estado de ejecución de canalización en sys.stdout.

timeout_seconds
int
valor predeterminado: 9223372036854775807

El número de segundos que se va a esperar antes de que se agote el tiempo de espera.

raise_on_error
bool
valor predeterminado: True

Indica si se debe generar un error cuando la ejecución está en un estado de error.

Devoluciones

El estado final.

Tipo de valor devuelto

str