Partager via

StepRun Classe

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 de l’exécution du pipeline parent une fois que l’exécution du pipeline parent est soumise et que le pipeline a envoyé l’exécution de l’étape.

Initialisez un 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 d’expérience de l’exécution de l’étape.
step_run_id
Obligatoire
str

ID d’exécution de l’exécution de l’é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 dans le 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 précédente réutilisée.

Valeur par défaut: False
_current_node_id
str

Pour un nœud réutilisé, l’ID de nœud sur le graphique actif.

Valeur par défaut: None
_reused_run_id
str

ID d’exécution réutilisé.

Valeur par défaut: None
_reused_node_id
str

ID de nœud réutilisé.

Valeur par défaut: None
_reused_pipeline_run_id
str

ID de pipeline réutilisé.

Valeur par défaut: None
experiment
Obligatoire
Experiment

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

ID d’exécution de l’exécution de l’é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 dans le 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 précédente réutilisée.
_current_node_id
Obligatoire
str

Pour un nœud réutilisé, l’ID de nœud sur le graphique actif.
_reused_run_id
Obligatoire
_reused_node_id
Obligatoire
str
_reused_pipeline_run_id
Obligatoire
str

Remarques

Un StepRun est créé en tant qu’exécution enfant d’un objet soumis PipelineRun. Récupérez tous les StepRuns dans un 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()

Permet get_details_with_logs d’extraire 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. Permet get_outputs de récupérer une dictée des sorties d’étape ou d’utiliser get_output pour récupérer l’objet unique StepRunOutput de la sortie avec le nom fourni. Vous pouvez également utiliser get_output_data pour extraire directement la PortDataReference sortie de l’é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 de l’étape. Cette méthode n’est pas implémentée pour StepRun.
complete

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

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

Retournez les détails d’état de l’exécution avec le contenu du fichier journal.
get_job_log

Videz le journal des travaux actuel pour l’exécution de l’étape.
get_output

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

Obtenez les données de sortie à partir d’une sortie donnée.
get_outputs

Obtenez les sorties de l’étape.
get_status

Récupérez l’état le plus récent de l’exécution du pipeline à partir du service.

Les valeurs courantes retournées incluent « Running », « Finished » et « Failed ».
get_stderr_log

Videz le journal stderr actuel pour l’exécution de l’étape.
get_stdout_log

Videz le journal stdout actuel pour l’exécution de l’étape.
wait_for_completion

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

Retourne l’état après l’attente.

child_run

Exécution enfant pour l’exécution de l’é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 pour l’enfant

Valeur par défaut: None
run_id
str

Run_id facultatif pour l’enfant, sinon utilise la valeur par défaut

Valeur par défaut: None
outputs
str

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

Valeur par défaut: None

Retours

Type Description
Run

Exécution enfant

Exceptions

Type Description
NotImplementedError

complete

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

complete()

Exceptions

Type Description
NotImplementedError

fail

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

fail()

Exceptions

Type Description
NotImplementedError

get_details_with_logs

Retournez les détails d’état de l’exécution avec le contenu du fichier journal.

get_details_with_logs()

Retours

Type Description
dict

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

get_job_log

Videz le journal des travaux actuel pour l’exécution de l’étape.

get_job_log()

Retours

Type Description
str

Chaîne de journal.

get_output

Obtenez 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é.

get_output_data

Obtenez les données de sortie à partir 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.

get_outputs

Obtenez les sorties de l’étape.

get_outputs()

Retours

Type Description
dict

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

get_status

Récupérez l’état le plus récent de l’exécution du pipeline à partir du service.

Les valeurs courantes retournées incluent « Running », « Finished » et « Failed ».

get_status()

Retours

Type Description
str

État le plus récent sous forme de chaîne

Remarques

  • NotStarted : il s’agit d’un objet d’exécution côté client temporaire avant la soumission du cloud

  • Mis en file d’attente : le travail est mis en file d’attente.

  • Exécution : le travail a commencé à s’exécuter dans la cible de calcul.

  • Échec : échec de l’exécution. Généralement, la propriété Error sur une exécution fournit des détails sur la raison pour laquelle.

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

  • Annulé : suite à la demande d’annulation, l’exécution est désormais annulée avec succès.


   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

Videz le journal stderr actuel pour l’exécution de l’étape.

get_stderr_log()

Retours

Type Description
str

Chaîne de journal.

get_stdout_log

Videz le journal stdout actuel pour l’exécution de l’étape.

get_stdout_log()

Retours

Type Description
str

Chaîne de journal.

wait_for_completion

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

Retourne l’état après 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 d’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 d’attente.

Valeur par défaut: 9223372036854775807
raise_on_error
bool

Indique s’il faut déclencher une erreur lorsque l’exécution est dans un état d’échec

Valeur par défaut: True

Retours

Type Description
str

État final.

Attributs

pipeline_run_id

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

Retours

Type Description
str

ID PipelineRun.