Partager via

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

Nom Description
experiment
Obligatoire
Experiment

Objet Experiment de l’exécution d’étape.
step_run_id
Obligatoire
str

ID d’exécution de l’exécution d’étape.
pipeline_run_id
Obligatoire
str

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

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

Point de terminaison auquel se connecter.

Valeur par défaut: None
_is_reused
bool

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

Valeur par défaut: False
_current_node_id
str

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

Valeur par défaut: None
_reused_run_id
str

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

Valeur par défaut: None
_reused_node_id
str

ID du nœud réutilisé.

Valeur par défaut: None
_reused_pipeline_run_id
str

ID du pipeline réutilisé.

Valeur par défaut: None
experiment
Obligatoire
Experiment

Objet Experiment de l’exécution d’étape.
step_run_id
Obligatoire
str

ID d’exécution de l’exécution d’étape.
pipeline_run_id
Obligatoire
str

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

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

Point de terminaison auquel se connecter.
_is_reused
Obligatoire
bool

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

Pour un nœud réutilisé, ID du nœud sur le graphique actuel.
_reused_run_id
Obligatoire
_reused_node_id
Obligatoire
str
_reused_pipeline_run_id
Obligatoire
str

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

Nom Description
name
str

Nom facultatif de l’enfant

Valeur par défaut: None
run_id
str

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

Valeur par défaut: None
outputs
str

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

Valeur par défaut: None

Retours

Type Description
Run

Exécution enfant

Exceptions

Type Description
NotImplementedError

complete

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

complete()

Exceptions

Type Description
NotImplementedError

fail

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

fail()

Exceptions

Type Description
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

Type Description
dict

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

Exceptions

Type Description
NotImplementedError

get_job_log

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

get_job_log()

Retours

Type Description
str

Chaîne du journal.

Exceptions

Type Description
NotImplementedError

get_output

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

get_output(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom de la sortie.

Retours

Type Description
StepRunOutput

StepRunOutput avec le nom donné.

Exceptions

Type Description
NotImplementedError

get_output_data

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

get_output_data(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom de la sortie.

Retours

Type Description
PortDataReference

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

Exceptions

Type Description
NotImplementedError

get_outputs

Obtient les sorties de l’étape.

get_outputs()

Retours

Type Description
dict

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

Exceptions

Type Description
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

Type Description
str

Dernier état sous forme de chaîne

Exceptions

Type Description
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

Type Description
str

Chaîne du journal.

Exceptions

Type Description
NotImplementedError

get_stdout_log

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

get_stdout_log()

Retours

Type Description
str

Chaîne du journal.

Exceptions

Type Description
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

Nom Description
show_output
bool

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

Valeur par défaut: True
timeout_seconds
int

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

Valeur par défaut: 9223372036854775807
raise_on_error
bool

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

Valeur par défaut: True

Retours

Type Description
str

État final.

Exceptions

Type Description
NotImplementedError

Attributs

pipeline_run_id

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

Retours

Type Description
str

ID de PipelineRun.