PipelineRun Classe
Représente une exécution d’une Pipeline.
Cette classe peut être utilisée pour gérer des détails d’exécution, en vérifier l’état et les récupérer une fois qu’une exécution de pipeline est soumise. Utilisez get_steps pour récupérer les objets StepRun créés par l’exécution de pipeline. D’autres utilisations incluent la récupération de l’objet Graph associé à l’exécution de pipeline, la récupération (fetch) de l’état de l’exécution de pipeline et l’attente de la fin de l’exécution.
Initialiser une exécution de pipeline.
- Héritage
-
PipelineRun
Constructeur
PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)
Paramètres
Remarques
Un objet PipelineRun est retourné lors de l’envoi de Pipeline par le biais de submit. Méthode de Experiment. Pour plus d’informations sur la création et l’envoi d’un pipeline, consultez : https://aka.ms/pl-first-pipeline.
Un objet PipelineRun peut également être instancié avec la Experiment à laquelle l’exécution a été soumise et l’ID 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>")
Avec PipelineRun, utilisez :
wait_for_completion pour superviser l’état d’exécution et, éventuellement, diffuser des journaux d’exécution.
get_status pour récupérer l’état d’exécution.
cancel pour annuler un objet PipelineRun en cours.
get_steps pour lister les StepRuns générés. Un objet PipelineRun génère un StepRun pour chaque étape dans le pipeline.
Méthodes
cancel |
Annule l’exécution en cours. |
child_run |
Crée une exécution enfant pour l’exécution de pipeline. Cette méthode n’est pas implémentée pour l’objet PipelineRun. |
complete |
Marque l’exécution de pipeline comme terminée. Cette méthode n’est pas implémentée pour l’objet PipelineRun. Cette méthode n’est pas prise en charge pour les pipelines ; l’état de complétion/d’échec est géré par le back-end Azure ML. |
fail |
Marque l’exécution du pipeline comme ayant échoué. Cette méthode n’est pas implémentée pour l’objet PipelineRun. Cette méthode n’est pas prise en charge pour les pipelines ; l’état de complétion/d’échec est géré par le back-end Azure ML. |
find_step_run |
Recherche une étape exécutée dans le pipeline par nom. |
get |
Récupère une exécution de pipeline en fonction d’un ID d’exécution. |
get_graph |
Obtient le graphe de l’exécution de pipeline. |
get_pipeline_output |
Obtient le PortDataReference pour la sortie de pipeline donnée. |
get_pipeline_runs |
Récupère les exécutions de pipeline générées à partir d’un pipeline publié. |
get_status |
Récupère l’état le plus récent de l’exécution de pipeline auprès du service. Les valeurs courantes retournées sont « Running », « Finished » et « Failed ». |
get_steps |
Obtient les exécutions d’étape pour toutes les étapes de pipeline terminées ou commencées. |
get_tags |
Obtient l’ensemble des étiquettes pour l’exécution. |
publish_pipeline |
Publier un pipeline et le rendre disponible en vue de sa réexécution. Vous pouvez récupérer le point de terminaison de pipeline à partir de l’objet PublishedPipeline retourné par cette fonction. Avec le point de terminaison de pipeline, vous pouvez appeler le pipeline à partir d’applications externes à l’aide d’appels REST. Pour plus d’informations sur la procédure d’authentification lors de l’appel de points de terminaison REST, consultez https://aka.ms/pl-restep-auth. Le pipeline d’origine associé à l’exécution de pipeline est utilisé comme base pour le pipeline publié. |
save |
Enregistrez le code YAML du pipeline dans un fichier. |
wait_for_completion |
Attendez la fin de cette exécution de pipeline. Retourne l’état à l’issue de l’attente. |
cancel
Annule l’exécution en cours.
cancel()
child_run
Crée une exécution enfant pour l’exécution de pipeline. Cette méthode n’est pas implémentée pour l’objet PipelineRun.
child_run(name=None, run_id=None, outputs=None)
Paramètres
- run_id
- str
ID d’exécution facultatif de l’enfant ; sinon, utilise la valeur par défaut.
Retours
Exécution enfant.
Type de retour
Exceptions
complete
Marque l’exécution de pipeline comme terminée. Cette méthode n’est pas implémentée pour l’objet PipelineRun.
Cette méthode n’est pas prise en charge pour les pipelines ; l’état de complétion/d’échec est géré par le back-end Azure ML.
complete()
Exceptions
fail
Marque l’exécution du pipeline comme ayant échoué. Cette méthode n’est pas implémentée pour l’objet PipelineRun.
Cette méthode n’est pas prise en charge pour les pipelines ; l’état de complétion/d’échec est géré par le back-end Azure ML.
fail()
Exceptions
find_step_run
Recherche une étape exécutée dans le pipeline par nom.
find_step_run(name)
Paramètres
Retours
Liste d’objets StepRun portant le nom fourni.
Type de retour
get
Récupère une exécution de pipeline en fonction d’un ID d’exécution.
static get(workspace, run_id, _service_endpoint=None)
Paramètres
Retours
Objet PipelineRun.
Type de retour
get_graph
get_pipeline_output
Obtient le PortDataReference pour la sortie de pipeline donnée.
get_pipeline_output(pipeline_output_name)
Paramètres
Retours
PortDataReference représentant les données de sortie de pipeline.
Type de retour
get_pipeline_runs
Récupère les exécutions de pipeline générées à partir d’un pipeline publié.
static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)
Paramètres
Retours
Liste des objets PipelineRun.
Type de retour
get_status
Récupère l’état le plus récent de l’exécution de pipeline auprès du service.
Les valeurs courantes retournées sont « Running », « Finished » et « Failed ».
get_status()
Retours
Dernier état sous forme de chaîne.
Type de retour
Remarques
NotStarted : Il s’agit d’un état temporaire côté client. Les objets d’exécution sont intégrés avant l’envoi au cloud.
Running (En cours d’exécution) : la tâche a commencé à s’exécuter 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 : Suite à la demande 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_steps
Obtient les exécutions d’étape pour toutes les étapes de pipeline terminées ou commencées.
get_steps()
Retours
Liste des objets StepRun.
Type de retour
get_tags
Obtient l’ensemble des étiquettes pour l’exécution.
get_tags()
Retours
Dictionnaire d’étiquettes pour l’exécution.
Type de retour
publish_pipeline
Publier un pipeline et le rendre disponible en vue de sa réexécution.
Vous pouvez récupérer le point de terminaison de pipeline à partir de l’objet PublishedPipeline retourné par cette fonction. Avec le point de terminaison de pipeline, vous pouvez appeler le pipeline à partir d’applications externes à l’aide d’appels REST. Pour plus d’informations sur la procédure d’authentification lors de l’appel de points de terminaison REST, consultez https://aka.ms/pl-restep-auth.
Le pipeline d’origine associé à l’exécution de pipeline est utilisé comme base pour le pipeline publié.
publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)
Paramètres
- continue_on_step_failure
- bool
Indique si l’exécution des autres étapes dans l’objet PipelineRun doit continuer en cas d’échec d’une étape. La valeur par défaut est False.
- kwargs
- dict
Arguments de mot clé personnalisés, réservés à des fins de développement futur
Retours
Pipeline publié créé.
Type de retour
save
Enregistrez le code YAML du pipeline dans un fichier.
save(path=None)
Paramètres
- path
- str
Chemin d’enregistrement du fichier YAML. Si le chemin est un répertoire, le fichier YAML de pipeline est enregistré dans <chemin>/pipeline.yml. Si le chemin est défini sur None, le répertoire actif est utilisé.
Type de retour
wait_for_completion
Attendez la fin de cette exécution de pipeline.
Retourne 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
Indique si l’état de l’exécution de pipeline doit figurer sur sys.stdout.
- timeout_seconds
- int
Nombre de secondes à attendre avant l’expiration du délai.
- raise_on_error
- bool
Indique si une erreur est générée quand l’exécution est à l’état d’échec.
Retours
État final.
Type de retour
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour