StepRun Clase
Ejecución de un paso en una clase 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 canalización primaria y la canalización ha enviado la ejecución del paso.
Inicialice un stepRun.
- Herencia
-
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
- _is_reused
- bool
Indica si esta ejecución es una ejecución anterior reutilizada.
- _current_node_id
- str
Para un nodo reutilizado, se trata del identificador de nodo del gráfico actual.
- _reused_pipeline_run_id
- str
El identificador de canalización reutilizado.
- _current_node_id
- str
Para un nodo reutilizado, se trata del identificador de nodo del gráfico actual.
- _reused_run_id
- _reused_node_id
- str
- _reused_pipeline_run_id
- str
Comentarios
Se crea una clase StepRun como una ejecución secundaria de una clase PipelineRun enviada. Capture todas las clases StepRun de una clase PipelineRun como se muestra 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>")
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 use get_output para recuperar el objeto StepRunOutput único para la salida con el nombre proporcionado. También puede usar get_output_data para capturar PortDataReference directamente para la salida del 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 |
La ejecución secundaria para la ejecución del paso. Este método no se implementa en StepRun. |
| complete |
Completar ejecución del paso. Este método no se implementa en StepRun. |
| fail |
Error en la ejecución del paso. Este método no se implementa en StepRun. |
| get_details_with_logs |
Devuelve los detalles de estado de la ejecución con el contenido del archivo de registro. |
| get_job_log |
Vuelque 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 |
Obtenga los datos de salida de una salida determinada. |
| get_outputs |
Obtenga las salidas del paso. |
| 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_stderr_log |
Vuelque el registro stderr actual para la ejecución del paso. |
| get_stdout_log |
Vuelque el registro de stdout actual para la ejecución del paso. |
| wait_for_completion |
Espere a que finalice la ejecución de este paso. Devuelve el estado después de la espera. |
child_run
La ejecución secundaria para la ejecución del paso. Este método no se implementa en StepRun.
child_run(name=None, run_id=None, outputs=None)Parámetros
- run_id
- str
run_id opcional del elemento secundario; de lo contrario, usa el valor predeterminado.
- outputs
- str
Directorio de salidas opcionales para realizar el seguimiento del elemento secundario.
Devoluciones
La ejecución secundaria.
Tipo de valor devuelto
Excepciones
complete
Completar ejecución del paso. Este método no se implementa en StepRun.
complete()Excepciones
fail
Error en la ejecución del paso. Este método no se implementa en StepRun.
fail()Excepciones
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
Devuelve el estado de la ejecución con el contenido del archivo de registro.
Tipo de valor devuelto
Excepciones
get_job_log
Vuelque el registro de trabajo actual para la ejecución del paso.
get_job_log()Devoluciones
La cadena de registro.
Tipo de valor devuelto
Excepciones
get_output
Obtenga la salida del nodo con el nombre especificado.
get_output(name)Parámetros
Devoluciones
StepRunOutput con el nombre especificado.
Tipo de valor devuelto
Excepciones
get_output_data
Obtenga los datos de salida de una salida determinada.
get_output_data(name)Parámetros
Devoluciones
PortDataReference que representa los datos de salida del paso.
Tipo de valor devuelto
Excepciones
get_outputs
Obtenga las salidas del paso.
get_outputs()Devoluciones
Un diccionario de StepRunOutput con el nombre de salida como clave.
Tipo de valor devuelto
Excepciones
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
El estado más reciente como una cadena.
Tipo de valor devuelto
Excepciones
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.
Queued: El trabajo está en cola.
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_stderr_log
Vuelque el registro stderr actual para la ejecución del paso.
get_stderr_log()Devoluciones
La cadena de registro.
Tipo de valor devuelto
Excepciones
get_stdout_log
Vuelque el registro de stdout actual para la ejecución del paso.
get_stdout_log()Devoluciones
La cadena de registro.
Tipo de valor devuelto
Excepciones
wait_for_completion
Espere a que finalice la ejecución de este paso.
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
show_output=True muestra el estado de ejecución de la canalización en sys.stdout.
- timeout_seconds
- int
El número de segundos que se va a esperar antes de que se agote el tiempo de espera.
- raise_on_error
- bool
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
Excepciones
Atributos
pipeline_run_id
Devuelve el identificador de la ejecución de canalización correspondiente a esta ejecución de paso.
Devoluciones
El identificador de PipelineRun.
Tipo de valor devuelto
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de