Compartir a través de

StepRun Clase

Ejecución de un paso en un Pipeline.

Esta clase se puede usar para administrar, comprobar el estado y recuperar los detalles de ejecución una vez que se envía la ejecución de la canalización primaria y la canalización ha enviado la ejecución del paso.

Inicialice un StepRun.

Constructor

StepRun(experiment, step_run_id, pipeline_run_id, node_id, _service_endpoint=None, _is_reused=False, _current_node_id=None, _reused_run_id=None, _reused_node_id=None, _reused_pipeline_run_id=None, **kwargs)

Parámetros

Nombre Description
experiment
Requerido
Experiment

Objeto de experimento de la ejecución del paso.
step_run_id
Requerido
str

Identificador de ejecución de la ejecución del paso.
pipeline_run_id
Requerido
str

Identificador de ejecución de la ejecución de la canalización primaria.
node_id
Requerido
str

Identificador del nodo del gráfico que representa este paso.
_service_endpoint
str

Punto de conexión al que se va a conectar.

Valor predeterminado: None
_is_reused
bool

Indica si esta ejecución es una ejecución anterior reutilizada.

Valor predeterminado: False
_current_node_id
str

Para un nodo reutilizado, el identificador de nodo del gráfico actual.

Valor predeterminado: None
_reused_run_id
str

Identificador de ejecución reutilizado.

Valor predeterminado: None
_reused_node_id
str

Identificador de nodo reutilizado.

Valor predeterminado: None
_reused_pipeline_run_id
str

Identificador de canalización reutilizado.

Valor predeterminado: None
experiment
Requerido
Experiment

Objeto de experimento de la ejecución del paso.
step_run_id
Requerido
str

Identificador de ejecución de la ejecución del paso.
pipeline_run_id
Requerido
str

Identificador de ejecución de la ejecución de la canalización primaria.
node_id
Requerido
str

Identificador del nodo del gráfico que representa este paso.
_service_endpoint
Requerido
str

Punto de conexión al que se va a conectar.
_is_reused
Requerido
bool

Indica si esta ejecución es una ejecución anterior reutilizada.
_current_node_id
Requerido
str

Para un nodo reutilizado, el identificador de nodo del gráfico actual.
_reused_run_id
Requerido
_reused_node_id
Requerido
str
_reused_pipeline_run_id
Requerido
str

Comentarios

StepRun se crea como una ejecución secundaria de un objeto enviado PipelineRun. Capture todos los StepRuns en una pipelineRun de la siguiente manera:


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

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

Use get_details_with_logs para capturar los detalles de ejecución y los registros creados por la ejecución.

StepRun también se puede usar para descargar las salidas de una ejecución. Use get_outputs para recuperar un dict de las salidas del paso o para get_output recuperar el único StepRunOutput objeto de la salida con el nombre proporcionado. También puede usar get_output_data para capturar directamente la salida del PortDataReference paso especificado.

Un ejemplo de descarga de una salida de paso es el siguiente:


   from azureml.pipeline.core import PipelineRun, StepRun, PortDataReference

   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")
   step_run = pipeline_run.find_step_run("<step_name>")[0]
   port_data_reference = step_run.get_output_data("<output_name>")
   port_data_reference.download(local_path="path")

Métodos

child_run

Ejecución secundaria para la ejecución de pasos. Este método no se implementa para StepRun.
complete

Complete para la ejecución de pasos. Este método no se implementa para StepRun.
fail

Error en la ejecución de pasos. Este método no se implementa para StepRun.
get_details_with_logs

Devuelve los detalles de estado de la ejecución con el contenido del archivo de registro.
get_job_log

Volcar el registro de trabajo actual para la ejecución del paso.
get_output

Obtenga la salida del nodo con el nombre especificado.
get_output_data

Obtiene los datos de salida de una salida determinada.
get_outputs

Obtenga las salidas del paso.
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_stderr_log

Volcar el registro de stderr actual para la ejecución del paso.
get_stdout_log

Volcar el registro de stdout actual para la ejecución del paso.
wait_for_completion

Espere a que se complete esta ejecución de paso.

Devuelve el estado después de la espera.

child_run

Ejecución secundaria para la ejecución de pasos. Este método no se implementa para StepRun.

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

Opcional run_id 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

La ejecución secundaria

Excepciones

Tipo Description
NotImplementedError

complete

Complete para la ejecución de pasos. Este método no se implementa para StepRun.

complete()

Excepciones

Tipo Description
NotImplementedError

fail

Error en la ejecución de pasos. Este método no se implementa para StepRun.

fail()

Excepciones

Tipo Description
NotImplementedError

get_details_with_logs

Devuelve los detalles de estado de la ejecución con el contenido del archivo de registro.

get_details_with_logs()

Devoluciones

Tipo Description
dict

Devuelve el estado de la ejecución con el contenido del archivo de registro.

get_job_log

Volcar el registro de trabajo actual para la ejecución del paso.

get_job_log()

Devoluciones

Tipo Description
str

Cadena de registro.

get_output

Obtenga la salida del nodo con el nombre especificado.

get_output(name)

Parámetros

Nombre Description
name
Requerido
str

Nombre de la salida.

Devoluciones

Tipo Description
StepRunOutput

StepRunOutput con el nombre especificado.

get_output_data

Obtiene los datos de salida de una salida determinada.

get_output_data(name)

Parámetros

Nombre Description
name
Requerido
str

Nombre de la salida.

Devoluciones

Tipo Description
PortDataReference

PortDataReference que representa los datos de salida del paso.

get_outputs

Obtenga las salidas del paso.

get_outputs()

Devoluciones

Tipo Description
dict

Diccionario de StepRunOutputs con el nombre de salida como clave.

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 cola: el trabajo está en cola.

  • 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_stderr_log

Volcar el registro de stderr actual para la ejecución del paso.

get_stderr_log()

Devoluciones

Tipo Description
str

Cadena de registro.

get_stdout_log

Volcar el registro de stdout actual para la ejecución del paso.

get_stdout_log()

Devoluciones

Tipo Description
str

Cadena de registro.

wait_for_completion

Espere a que se complete esta ejecución de paso.

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

show_output=True muestra el estado de ejecución de la canalización en sys.stdout.

Valor predeterminado: True
timeout_seconds
int

Número de segundos que se deben 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.

Atributos

pipeline_run_id

Devuelve el identificador de la ejecución de canalización correspondiente a esta ejecución de paso.

Devoluciones

Tipo Description
str

El identificador PipelineRun.