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
| Nombre | Description |
|---|---|
|
experiment
Requerido
|
El objeto de experimento de la ejecución del paso. |
|
step_run_id
Requerido
|
El identificador de ejecución de la ejecución del paso. |
|
pipeline_run_id
Requerido
|
El identificador de la ejecución de canalización. |
|
node_id
Requerido
|
El identificador del nodo del gráfico que representa este paso. |
|
_service_endpoint
|
El punto de conexión al que conectarse. Valor predeterminado: None
|
|
_is_reused
|
Indica si esta ejecución es una ejecución anterior reutilizada. Valor predeterminado: False
|
|
_current_node_id
|
Para un nodo reutilizado, se trata del identificador de nodo del gráfico actual. Valor predeterminado: None
|
|
_reused_run_id
|
El identificador de ejecución reutilizado. Valor predeterminado: None
|
|
_reused_node_id
|
El identificador de nodo reutilizado. Valor predeterminado: None
|
|
_reused_pipeline_run_id
|
El identificador de canalización reutilizado. Valor predeterminado: None
|
|
experiment
Requerido
|
El objeto de experimento de la ejecución del paso. |
|
step_run_id
Requerido
|
El identificador de ejecución de la ejecución del paso. |
|
pipeline_run_id
Requerido
|
El identificador de la ejecución de canalización. |
|
node_id
Requerido
|
El identificador del nodo del gráfico que representa este paso. |
|
_service_endpoint
Requerido
|
El punto de conexión al que conectarse. |
|
_is_reused
Requerido
|
Indica si esta ejecución es una ejecución anterior reutilizada. |
|
_current_node_id
Requerido
|
Para un nodo reutilizado, se trata del identificador de nodo del gráfico actual. |
|
_reused_run_id
Requerido
|
|
|
_reused_node_id
Requerido
|
|
|
_reused_pipeline_run_id
Requerido
|
|
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
| Nombre | Description |
|---|---|
|
name
|
El nombre opcional del elemento secundario Valor predeterminado: None
|
|
run_id
|
run_id opcional del elemento secundario; de lo contrario, usa el valor predeterminado. Valor predeterminado: None
|
|
outputs
|
Directorio de salidas opcionales para realizar el seguimiento del elemento secundario. Valor predeterminado: None
|
Devoluciones
| Tipo | Description |
|---|---|
|
La ejecución secundaria. |
Excepciones
| Tipo | Description |
|---|---|
complete
Completar ejecución del paso. Este método no se implementa en StepRun.
complete()Excepciones
| Tipo | Description |
|---|---|
fail
Error en la ejecución del paso. Este método no se implementa en StepRun.
fail()Excepciones
| Tipo | Description |
|---|---|
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 |
|---|---|
|
Devuelve el estado de la ejecución con el contenido del archivo de registro. |
Excepciones
| Tipo | Description |
|---|---|
get_job_log
Vuelque el registro de trabajo actual para la ejecución del paso.
get_job_log()Devoluciones
| Tipo | Description |
|---|---|
|
La cadena de registro. |
Excepciones
| Tipo | Description |
|---|---|
get_output
Obtenga la salida del nodo con el nombre especificado.
get_output(name)Parámetros
| Nombre | Description |
|---|---|
|
name
Requerido
|
Nombre de la salida. |
Devoluciones
| Tipo | Description |
|---|---|
|
StepRunOutput con el nombre especificado. |
Excepciones
| Tipo | Description |
|---|---|
get_output_data
Obtenga los datos de salida de una salida determinada.
get_output_data(name)Parámetros
| Nombre | Description |
|---|---|
|
name
Requerido
|
Nombre de la salida. |
Devoluciones
| Tipo | Description |
|---|---|
|
PortDataReference que representa los datos de salida del paso. |
Excepciones
| Tipo | Description |
|---|---|
get_outputs
Obtenga las salidas del paso.
get_outputs()Devoluciones
| Tipo | Description |
|---|---|
|
Un diccionario de StepRunOutput con el nombre de salida como clave. |
Excepciones
| Tipo | Description |
|---|---|
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 |
|---|---|
|
El estado más reciente como una cadena. |
Excepciones
| Tipo | Description |
|---|---|
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
| Tipo | Description |
|---|---|
|
La cadena de registro. |
Excepciones
| Tipo | Description |
|---|---|
get_stdout_log
Vuelque el registro de stdout actual para la ejecución del paso.
get_stdout_log()Devoluciones
| Tipo | Description |
|---|---|
|
La cadena de registro. |
Excepciones
| Tipo | Description |
|---|---|
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
| Nombre | Description |
|---|---|
|
show_output
|
show_output=True muestra el estado de ejecución de la canalización en sys.stdout. Valor predeterminado: True
|
|
timeout_seconds
|
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
|
Indica si se debe generar un error cuando la ejecución está en un estado de error. Valor predeterminado: True
|
Devoluciones
| Tipo | Description |
|---|---|
|
El estado final. |
Excepciones
| Tipo | Description |
|---|---|
Atributos
pipeline_run_id
Devuelve el identificador de la ejecución de canalización correspondiente a esta ejecución de paso.
Devoluciones
| Tipo | Description |
|---|---|
|
El identificador de PipelineRun. |