StepRun Classe

  • Riferimento

Esecuzione di un passaggio in un oggetto Pipeline.

Questa classe può essere usata per gestire, controllare lo stato e recuperare i dettagli dell'esecuzione dopo l'invio dell'esecuzione della pipeline padre e la pipeline ha inviato l'esecuzione del passaggio.

Inizializzare un'istruzione StepRun.

Ereditarietà
Run
StepRun

Costruttore

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)

Parametri

Nome Descrizione
experiment
Necessario
Experiment

Oggetto esperimento dell'esecuzione del passaggio.
step_run_id
Necessario
str

ID esecuzione del passaggio eseguito.
pipeline_run_id
Necessario
str

ID esecuzione dell'esecuzione della pipeline padre.
node_id
Necessario
str

ID del nodo nel grafico che rappresenta questo passaggio.
_service_endpoint
str

Endpoint a cui connettersi.

Valore predefinito: None
_is_reused
bool

Indica se questa esecuzione è un'esecuzione precedente riutilizzata.

Valore predefinito: False
_current_node_id
str

Per un nodo riutilizzato, l'ID del nodo nel grafico corrente.

Valore predefinito: None
_reused_run_id
str

ID esecuzione riutilizzato.

Valore predefinito: None
_reused_node_id
str

ID nodo riutilizzato.

Valore predefinito: None
_reused_pipeline_run_id
str

ID della pipeline riutilizzato.

Valore predefinito: None
experiment
Necessario
Experiment

Oggetto esperimento dell'esecuzione del passaggio.
step_run_id
Necessario
str

ID esecuzione del passaggio eseguito.
pipeline_run_id
Necessario
str

ID esecuzione dell'esecuzione della pipeline padre.
node_id
Necessario
str

ID del nodo nel grafico che rappresenta questo passaggio.
_service_endpoint
Necessario
str

Endpoint a cui connettersi.
_is_reused
Necessario
bool

Indica se questa esecuzione è un'esecuzione precedente riutilizzata.
_current_node_id
Necessario
str

Per un nodo riutilizzato, l'ID del nodo nel grafico corrente.
_reused_run_id
Necessario
_reused_node_id
Necessario
str
_reused_pipeline_run_id
Necessario
str

Commenti

Un elemento StepRun viene creato come esecuzione figlio di un oggetto inviato PipelineRun. Recuperare tutte le operazioni StepRun in un oggetto PipelineRun come indicato di seguito:


   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()

Usare get_details_with_logs per recuperare i dettagli dell'esecuzione e i log creati dall'esecuzione.

È anche possibile usare StepRun per scaricare gli output di un'esecuzione. Usare get_outputs per recuperare un valore dict degli output del passaggio oppure usare get_output per recuperare il singolo StepRunOutput oggetto per l'output con il nome specificato. È anche possibile usare get_output_data per recuperare direttamente l'oggetto PortDataReference per l'output del passaggio specificato.

Di seguito è riportato un esempio di download dell'output di un passaggio:


   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")

Metodi

child_run

Esecuzione figlio per l'esecuzione del passaggio. Questo metodo non è implementato per StepRun.
complete

Completamento per l'esecuzione del passaggio. Questo metodo non è implementato per StepRun.
fail

Esito negativo per l'esecuzione del passaggio. Questo metodo non è implementato per StepRun.
get_details_with_logs

Restituisce i dettagli sullo stato dell'esecuzione con il contenuto del file di log.
get_job_log

Eseguire il dump del log del processo corrente per l'esecuzione del passaggio.
get_output

Ottenere l'output del nodo con il nome specificato.
get_output_data

Ottenere i dati di output da un determinato output.
get_outputs

Ottenere gli output dei passaggi.
get_status

Recuperare lo stato più recente dell'esecuzione della pipeline dal servizio.

I valori comuni restituiti includono "Running", "Finished" e "Failed".
get_stderr_log

Eseguire il dump del log stderr corrente per l'esecuzione del passaggio.
get_stdout_log

Eseguire il dump del log stdout corrente per l'esecuzione del passaggio.
wait_for_completion

Attendere il completamento dell'esecuzione di questo passaggio.

Restituisce lo stato dopo l'attesa.

child_run

Esecuzione figlio per l'esecuzione del passaggio. Questo metodo non è implementato per StepRun.

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

Parametri

Nome Descrizione
name
str

Nome facoltativo per l'elemento figlio

Valore predefinito: None
run_id
str

Run_id facoltativo per l'elemento figlio; in caso contrario, usa l'impostazione predefinita

Valore predefinito: None
outputs
str

Directory di output facoltativa da tenere traccia per l'elemento figlio

Valore predefinito: None

Restituisce

Tipo Descrizione
Run

Esecuzione figlio

Eccezioni

Tipo Descrizione
NotImplementedError

complete

Completamento per l'esecuzione del passaggio. Questo metodo non è implementato per StepRun.

complete()

Eccezioni

Tipo Descrizione
NotImplementedError

fail

Esito negativo per l'esecuzione del passaggio. Questo metodo non è implementato per StepRun.

fail()

Eccezioni

Tipo Descrizione
NotImplementedError

get_details_with_logs

Restituisce i dettagli sullo stato dell'esecuzione con il contenuto del file di log.

get_details_with_logs()

Restituisce

Tipo Descrizione
dict

Restituisce lo stato dell'esecuzione con il contenuto del file di log

Eccezioni

Tipo Descrizione
NotImplementedError

get_job_log

Eseguire il dump del log del processo corrente per l'esecuzione del passaggio.

get_job_log()

Restituisce

Tipo Descrizione
str

Stringa di log.

Eccezioni

Tipo Descrizione
NotImplementedError

get_output

Ottenere l'output del nodo con il nome specificato.

get_output(name)

Parametri

Nome Descrizione
name
Necessario
str

Nome dell'output.

Restituisce

Tipo Descrizione
StepRunOutput

StepRunOutput con il nome specificato.

Eccezioni

Tipo Descrizione
NotImplementedError

get_output_data

Ottenere i dati di output da un determinato output.

get_output_data(name)

Parametri

Nome Descrizione
name
Necessario
str

Nome dell'output.

Restituisce

Tipo Descrizione
PortDataReference

PortDataReference che rappresenta i dati di output del passaggio.

Eccezioni

Tipo Descrizione
NotImplementedError

get_outputs

Ottenere gli output dei passaggi.

get_outputs()

Restituisce

Tipo Descrizione
dict

Dizionario di StepRunOutputs con il nome di output come chiave.

Eccezioni

Tipo Descrizione
NotImplementedError

get_status

Recuperare lo stato più recente dell'esecuzione della pipeline dal servizio.

I valori comuni restituiti includono "Running", "Finished" e "Failed".

get_status()

Restituisce

Tipo Descrizione
str

Stato più recente come stringa

Eccezioni

Tipo Descrizione
NotImplementedError

Commenti

  • NotStarted: si tratta di oggetti Run sul lato client di stato temporanei che si trovano prima dell'invio nel cloud

  • Accodato: il processo viene accodato.

  • In esecuzione: il processo è stato avviato per l'esecuzione nella destinazione di calcolo.

  • Non riuscito: l'esecuzione non è riuscita. In genere la proprietà Error in un'esecuzione fornirà informazioni dettagliate sul motivo.

  • Completato: l'esecuzione è stata completata correttamente.

  • Annullata: dopo la richiesta di annullamento, l'esecuzione viene annullata.


   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

Eseguire il dump del log stderr corrente per l'esecuzione del passaggio.

get_stderr_log()

Restituisce

Tipo Descrizione
str

Stringa di log.

Eccezioni

Tipo Descrizione
NotImplementedError

get_stdout_log

Eseguire il dump del log stdout corrente per l'esecuzione del passaggio.

get_stdout_log()

Restituisce

Tipo Descrizione
str

Stringa di log.

Eccezioni

Tipo Descrizione
NotImplementedError

wait_for_completion

Attendere il completamento dell'esecuzione di questo passaggio.

Restituisce lo stato dopo l'attesa.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parametri

Nome Descrizione
show_output
bool

show_output=True mostra lo stato di esecuzione della pipeline in sys.stdout.

Valore predefinito: True
timeout_seconds
int

Numero di secondi di attesa prima del timeout.

Valore predefinito: 9223372036854775807
raise_on_error
bool

Indica se generare un errore quando l'esecuzione si trova in uno stato di errore

Valore predefinito: True

Restituisce

Tipo Descrizione
str

Stato finale.

Eccezioni

Tipo Descrizione
NotImplementedError

Attributi

pipeline_run_id

Restituisce l'ID dell'esecuzione della pipeline corrispondente a questo passaggio.

Restituisce

Tipo Descrizione
str

ID PipelineRun.