StepRun Classe

  • Référence

Exécution d’une étape dans un Pipeline.

Cette classe peut être utilisée pour gérer, vérifier l’état et récupérer les détails de l’exécution une fois que l’exécution du pipeline parent a été envoyée et que le pipeline a soumis l’étape d’exécution.

Initialiser un StepRun.

Héritage
Run
StepRun

Constructeur

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)

Paramètres

experiment
Experiment
Obligatoire

Objet Experiment de l’exécution d’étape.

step_run_id
str
Obligatoire

ID d’exécution de l’exécution d’étape.

pipeline_run_id
str
Obligatoire

ID d’exécution de l’exécution du pipeline parent.

node_id
str
Obligatoire

ID du nœud du graphique qui représente cette étape.

_service_endpoint
str
valeur par défaut: None

Point de terminaison auquel se connecter.

_is_reused
bool
valeur par défaut: False

Indique si cette exécution est une exécution antérieure réutilisée.

_current_node_id
str
valeur par défaut: None

Pour un nœud réutilisé, ID du nœud sur le graphique actuel.

_reused_run_id
str
valeur par défaut: None

ID de l’exécution réutilisée.

_reused_node_id
str
valeur par défaut: None

ID du nœud réutilisé.

_reused_pipeline_run_id
str
valeur par défaut: None

ID du pipeline réutilisé.

experiment
Experiment
Obligatoire

Objet Experiment de l’exécution d’étape.

step_run_id
str
Obligatoire

ID d’exécution de l’exécution d’étape.

pipeline_run_id
str
Obligatoire

ID d’exécution de l’exécution du pipeline parent.

node_id
str
Obligatoire

ID du nœud du graphique qui représente cette étape.

_service_endpoint
str
Obligatoire

Point de terminaison auquel se connecter.

_is_reused
bool
Obligatoire

Indique si cette exécution est une exécution antérieure réutilisée.

_current_node_id
str
Obligatoire

Pour un nœud réutilisé, ID du nœud sur le graphique actuel.

_reused_run_id
Obligatoire
_reused_node_id
str
Obligatoire
_reused_pipeline_run_id
str
Obligatoire

Remarques

Un objet StepRun est créé en tant qu’exécution enfant d'un objet PipelineRun soumis. Récupère tous les objets StepRun d’un objet PipelineRun comme suit :


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

Utilisez get_details_with_logs pour récupérer les détails de l’exécution et les journaux créés par l’exécution.

StepRun peut également être utilisé pour télécharger les sorties d’une exécution. Utilisez get_outputs pour récupérer un dictionnaire des sorties d’étape, ou utilisez get_output afin de récupérer l’objet unique StepRunOutput pour la sortie avec le nom fourni. Vous pouvez également utiliser get_output_data pour extraire directement l’objet PortDataReference de la sortie d’étape spécifiée.

Voici un exemple de téléchargement d’une sortie d’étape :


   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éthodes

child_run

Exécution enfant pour l’exécution d’étape. Cette méthode n’est pas implémentée pour StepRun.
complete

Terminé pour l’exécution d’étape. Cette méthode n’est pas implémentée pour StepRun.
fail

Échec de l’exécution d’étape. Cette méthode n’est pas implémentée pour StepRun.
get_details_with_logs

Renvoie l’état détaillé de l’exécution avec le contenu du fichier journal.
get_job_log

Vide le journal des travaux en cours pour l’exécution d’étape.
get_output

Obtient la sortie du nœud avec le nom donné.
get_output_data

Obtient les données d’une sortie donnée.
get_outputs

Obtient les sorties de l’étape.
get_status

Récupère l’état le plus récent de l’exécution du pipeline auprès du service.

Les valeurs couramment renvoyées sont « Running », « Finished » et « Failed ».
get_stderr_log

Vide le journal stderr actuel de l’exécution d’étape.
get_stdout_log

Vide le journal stdout actuel de l’exécution d’étape.
wait_for_completion

Attend la fin de cette exécution d’étape.

Renvoie l’état à l’issue de l’attente.

child_run

Exécution enfant pour l’exécution d’étape. Cette méthode n’est pas implémentée pour StepRun.

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

Paramètres

name
str
valeur par défaut: None

Nom facultatif de l’enfant

run_id
str
valeur par défaut: None

Valeur run_id facultative pour l’enfant ; sinon, utilise la valeur par défaut.

outputs
str
valeur par défaut: None

Répertoire de sorties facultatif à suivre pour l’enfant

Retours

Exécution enfant

Type de retour

Run

Exceptions

NotImplementedError

complete

Terminé pour l’exécution d’étape. Cette méthode n’est pas implémentée pour StepRun.

complete()

Exceptions

NotImplementedError

fail

Échec de l’exécution d’étape. Cette méthode n’est pas implémentée pour StepRun.

fail()

Exceptions

NotImplementedError

get_details_with_logs

Renvoie l’état détaillé de l’exécution avec le contenu du fichier journal.

get_details_with_logs()

Retours

Renvoie l’état de l’exécution avec le contenu du fichier journal.

Type de retour

dict

Exceptions

NotImplementedError

get_job_log

Vide le journal des travaux en cours pour l’exécution d’étape.

get_job_log()

Retours

Chaîne du journal.

Type de retour

str

Exceptions

NotImplementedError

get_output

Obtient la sortie du nœud avec le nom donné.

get_output(name)

Paramètres

name
str
Obligatoire

Nom de la sortie.

Retours

StepRunOutput avec le nom donné.

Type de retour

StepRunOutput

Exceptions

NotImplementedError

get_output_data

Obtient les données d’une sortie donnée.

get_output_data(name)

Paramètres

name
str
Obligatoire

Nom de la sortie.

Retours

PortDataReference représentant les données de sortie de l’étape.

Type de retour

PortDataReference

Exceptions

NotImplementedError

get_outputs

Obtient les sorties de l’étape.

get_outputs()

Retours

Dictionnaire de StepRunOutputs avec le nom de sortie comme clé.

Type de retour

dict

Exceptions

NotImplementedError

get_status

Récupère l’état le plus récent de l’exécution du pipeline auprès du service.

Les valeurs couramment renvoyées sont « Running », « Finished » et « Failed ».

get_status()

Retours

Dernier état sous forme de chaîne

Type de retour

str

Exceptions

NotImplementedError

Remarques

  • NotStarted (Non démarré) : état temporaire des objets Run côté client avant l’envoi au cloud.

  • Queued (En attente) : le travail est mis en file d’attente.

  • Running (En cours d’exécution) : l’exécution du travail a débuté sur la cible de calcul.

  • Failed (Échec) : l’exécution a échoué. En règle générale, la propriété Error d’une exécution fournit des détails sur la raison de l’échec.

  • Finished (Terminé) : l’exécution s’est terminée avec succès.

  • Canceled (Annulé) : suite à la suivre d’annulation, l’exécution est à présent annulée.


   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

Vide le journal stderr actuel de l’exécution d’étape.

get_stderr_log()

Retours

Chaîne du journal.

Type de retour

str

Exceptions

NotImplementedError

get_stdout_log

Vide le journal stdout actuel de l’exécution d’étape.

get_stdout_log()

Retours

Chaîne du journal.

Type de retour

str

Exceptions

NotImplementedError

wait_for_completion

Attend la fin de cette exécution d’étape.

Renvoie l’état à l’issue de l’attente.

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

Paramètres

show_output
bool
valeur par défaut: True

show_output=True indique l’état de l’exécution du pipeline sur sys.stdout.

timeout_seconds
int
valeur par défaut: 9223372036854775807

Nombre de secondes à attendre avant l’expiration du délai.

raise_on_error
bool
valeur par défaut: True

Indique si une erreur doit être générée lorsque l’objet Run échoue.

Retours

État final.

Type de retour

str

Exceptions

NotImplementedError

Attributs

pipeline_run_id

Renvoie l’ID de l’exécution de pipeline correspondant à cette exécution d’étape.

Retours

ID de PipelineRun.

Type de retour

str