PipelineRun Klasse

  • Referenz

Stellt eine Ausführung eines Pipeline dar.

Mit dieser Klasse können Sie eine Pipelineausführung verwalten, ihren Ausführungsstatus überprüfen und Ausführungsdetails zu ihr abrufen, nachdem sie übermittelt wurde. Verwenden Sie get_steps, um die StepRun-Objekte abzurufen, die von der Pipelineausführung erstellt werden. Weitere Anwendungsfälle sind das Abrufen des der Pipelineausführung zugeordneten Graph-Objekts, das Abrufen des Status der Pipelineausführung und das Warten auf den Abschluss der Ausführung.

Initialisieren Sie eine Pipelineausführung.

Vererbung
Run
PipelineRun

Konstruktor

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parameter

experiment
Experiment
Erforderlich

Das Experimentobjekt, das der Pipelineausführung zugeordnet ist.

run_id
str
Erforderlich

Die ID der Pipelineausführung.

_service_endpoint
str
Standardwert: None

Der Endpunkt, mit dem eine Verbindung hergestellt werden soll.

experiment
Experiment
Erforderlich

Das Experimentobjekt, das der Pipelineausführung zugeordnet ist.

run_id
str
Erforderlich

Die ID der Pipelineausführung.

_service_endpoint
str
Erforderlich

Der Endpunkt, mit dem eine Verbindung hergestellt werden soll.

Hinweise

Ein PipelineRun-Objekt wird zurückgegeben, wenn ein Pipeline über submitübermittelt wird. Methode eines Experiment. Weitere Informationen zum Erstellen und Übermitteln einer Pipeline finden Sie unter: https://aka.ms/pl-first-pipeline.

Eine Pipelineausführung kann auch mit der Experiment, an die die Ausführung übermittelt wurde, und der Pipelineausführungs-ID wie folgt instanziiert werden:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

Wenn Sie mit PipelineRun arbeiten, verwenden Sie:

  • wait_for_completion, um den Ausführungsstatus zu überwachen und optional Ausführungsprotokolle zu streamen.

  • get_status, um den Ausführungsstatus abzurufen.

  • cancel, um eine laufende Pipelineausführung abzubrechen.

  • get_steps, um die generierten Schrittausführungen aufzulisten. Eine Pipelineausführung generiert für jeden Schritt in der Pipeline eine StepRun.

Methoden

cancel

Brechen Sie die laufende Ausführung ab.
child_run

Erstellen Sie eine untergeordnete Ausführung für die Pipelineausführung. Diese Methode ist für PipelineRun (Pipelineausführung) nicht implementiert.
complete

Markieren Sie die Pipelineausführung als abgeschlossen. Diese Methode ist für PipelineRun (Pipelineausführung) nicht implementiert.

Diese Methode wird für Pipelines nicht unterstützt. Abschluss-/Fehlerstatus wird vom Azure ML-Back-End verwaltet.
fail

Markieren Sie die Pipeline-Ausführung als fehlgeschlagen. Diese Methode ist für PipelineRun (Pipelineausführung) nicht implementiert.

Diese Methode wird für Pipelines nicht unterstützt. Abschluss-/Fehlerstatus wird vom Azure ML-Back-End verwaltet.
find_step_run

Suchen Sie eine Schritt-Ausführung in der Pipeline anhand des Namens.
get

Rufen Sie eine Pipelineausführung basierend auf einer Ausführungs-ID ab.
get_graph

Abrufen des Graphs der Pipelineausführung.
get_pipeline_output

Abrufen von PortDataReference für die angegebene Pipelineausgabe.
get_pipeline_runs

Abrufen der Pipelineausführungen, die aus einer veröffentlichten Pipeline generiert wurden.
get_status

Rufen Sie den aktuellen Status der Pipelineausführung vom Dienst ab.

Zu den zurückgegebenen allgemeinen Werten zählen „Running“, „Finished“ und „Failed“.
get_steps

Abrufen der Schrittausführungen für alle Pipelineschritte, die abgeschlossen wurden oder mit der Ausführung begonnen haben.
get_tags

Abrufen der Tag-Menge für die Ausführung.
publish_pipeline

Veröffentlichen Sie eine Pipeline, und stellen Sie sie für die erneute Veröffentlichung zur Verfügung.

Sie können den Pipelineendpunkt aus dem PublishedPipeline-Objekt abrufen, das von dieser Funktion zurückgegeben wird. Mit dem Pipelineendpunkt können Sie die Pipeline über externe Anwendungen mithilfe von REST-Aufrufen aufrufen. Informationen zur Authentifizierung beim Aufrufen von REST-Endpunkten finden Sie unter https://aka.ms/pl-restep-auth.

Die ursprüngliche Pipeline, die der Pipelineausführung zugeordnet ist, wird als Basis für die veröffentlichte Pipeline verwendet.
save

Speichern Sie die YAML-Pipeline in einer Datei.
wait_for_completion

Warten Sie, bis diese Pipeline ausgeführt wurde.

Gibt den Status nach dem Warten zurück.

cancel

Brechen Sie die laufende Ausführung ab.

cancel()

child_run

Erstellen Sie eine untergeordnete Ausführung für die Pipelineausführung. Diese Methode ist für PipelineRun (Pipelineausführung) nicht implementiert.

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

Parameter

name
str
Standardwert: None

Optionaler Name für das untergeordnete Element.

run_id
str
Standardwert: None

Optionale Ausführungs-ID für das untergeordnete Element, andernfalls wird der Standardwert verwendet.

outputs
str
Standardwert: None

Optionales Ausgabeverzeichnis, das für das untergeordnete Element nachverfolgt werden soll.

Gibt zurück

Die untergeordnete Ausführung.

Rückgabetyp

Run

Ausnahmen

NotImplementedError

complete

Markieren Sie die Pipelineausführung als abgeschlossen. Diese Methode ist für PipelineRun (Pipelineausführung) nicht implementiert.

Diese Methode wird für Pipelines nicht unterstützt. Abschluss-/Fehlerstatus wird vom Azure ML-Back-End verwaltet.

complete()

Ausnahmen

NotImplementedError

fail

Markieren Sie die Pipeline-Ausführung als fehlgeschlagen. Diese Methode ist für PipelineRun (Pipelineausführung) nicht implementiert.

Diese Methode wird für Pipelines nicht unterstützt. Abschluss-/Fehlerstatus wird vom Azure ML-Back-End verwaltet.

fail()

Ausnahmen

NotImplementedError

find_step_run

Suchen Sie eine Schritt-Ausführung in der Pipeline anhand des Namens.

find_step_run(name)

Parameter

name
str
Erforderlich

Der Name des zu suchenden Schritts.

Gibt zurück

Liste der StepRun-Objekte mit dem angegebenen Namen.

Rückgabetyp

list

get

Rufen Sie eine Pipelineausführung basierend auf einer Ausführungs-ID ab.

static get(workspace, run_id, _service_endpoint=None)

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, der der Pipeline zugeordnet ist.

run_id
str
Erforderlich

Die ID der Pipelineausführung.

_service_endpoint
str
Standardwert: None

Der Endpunkt, mit dem eine Verbindung hergestellt werden soll.

Gibt zurück

Das PipelineRun-Objekt.

Rückgabetyp

PipelineRun

get_graph

Abrufen des Graphs der Pipelineausführung.

get_graph()

Gibt zurück

Das Diagramm.

Rückgabetyp

Graph

get_pipeline_output

Abrufen von PortDataReference für die angegebene Pipelineausgabe.

get_pipeline_output(pipeline_output_name)

Parameter

pipeline_output_name
str
Erforderlich

Der Name der abzurufenden Pipelineausgabe.

Gibt zurück

Der PortDataReference, der die Pipelineausgabedaten darstellt.

Rückgabetyp

PortDataReference

get_pipeline_runs

Abrufen der Pipelineausführungen, die aus einer veröffentlichten Pipeline generiert wurden.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parameter

workspace
Workspace
Erforderlich

Der Arbeitsbereich, der der Pipeline zugeordnet ist.

pipeline_id
str
Erforderlich

Die ID der veröffentlichten Pipeline.

_service_endpoint
str
Standardwert: None

Der Endpunkt, mit dem eine Verbindung hergestellt werden soll.

Gibt zurück

Eine Liste von PipelineRun-Objekten.

Rückgabetyp

list

get_status

Rufen Sie den aktuellen Status der Pipelineausführung vom Dienst ab.

Zu den zurückgegebenen allgemeinen Werten zählen „Running“, „Finished“ und „Failed“.

get_status()

Gibt zurück

Der letzte Status als Zeichenfolge.

Rückgabetyp

str

Hinweise

  • „NotStarted“ (Nicht gestartet): Dies ist ein temporärer Zustand, in dem sich clientseitige Ausführungsobjekte vor der Cloudübermittlung befinden.

  • „Running“ (Wird ausgeführt): Der Auftrag wurde gestartet, um im Computeziel ausgeführt zu werden.

  • „Failed“ (Fehler): Fehler bei der Ausführung. In der Regel liefert die Eigenschaft „Error“ einer Ausführung Details zur Ursache.

  • „Finished“ (Abgeschlossen): Die Ausführung wurde erfolgreich abgeschlossen.

  • Abgebrochen: Nach der Abbruchanforderung wird die Ausführung jetzt erfolgreich abgebrochen.


   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

Abrufen der Schrittausführungen für alle Pipelineschritte, die abgeschlossen wurden oder mit der Ausführung begonnen haben.

get_steps()

Gibt zurück

Eine Liste von StepRun-Objekten.

Rückgabetyp

list

get_tags

Abrufen der Tag-Menge für die Ausführung.

get_tags()

Gibt zurück

Wörterbuch der Tags für das Modell.

Rückgabetyp

dict

publish_pipeline

Veröffentlichen Sie eine Pipeline, und stellen Sie sie für die erneute Veröffentlichung zur Verfügung.

Sie können den Pipelineendpunkt aus dem PublishedPipeline-Objekt abrufen, das von dieser Funktion zurückgegeben wird. Mit dem Pipelineendpunkt können Sie die Pipeline über externe Anwendungen mithilfe von REST-Aufrufen aufrufen. Informationen zur Authentifizierung beim Aufrufen von REST-Endpunkten finden Sie unter https://aka.ms/pl-restep-auth.

Die ursprüngliche Pipeline, die der Pipelineausführung zugeordnet ist, wird als Basis für die veröffentlichte Pipeline verwendet.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parameter

name
str
Erforderlich

Der Name der veröffentlichten Pipeline.

description
str
Erforderlich

Die Beschreibung der veröffentlichten Pipeline.

version
str
Erforderlich

Die Version der veröffentlichten Pipeline.

continue_on_step_failure
bool
Standardwert: None

Gibt an, ob die Ausführung weiterer Schritte in der Pipelineausführung (PipelineRun) fortgesetzt werden soll, wenn bei einem Schritt ein Fehler auftritt. Die Standardeinstellung lautet „false“.

kwargs
dict
Erforderlich

Benutzerdefinierte Schlüsselwortargumente, für die zukünftige Entwicklung reserviert

Gibt zurück

Erstellte veröffentlichte Pipeline.

Rückgabetyp

PublishedPipeline

save

Speichern Sie die YAML-Pipeline in einer Datei.

save(path=None)

Parameter

path
str
Standardwert: None

Der Pfad zum Speichern der YAML-Datei. Wenn der Pfad ein Verzeichnis ist, wird die YAML-Pipelinedatei unter <path>/pipeline.yml gespeichert. Wenn der Pfad None ist, wird das aktuelle Verzeichnis verwendet.

Rückgabetyp

None

wait_for_completion

Warten Sie, bis diese Pipeline ausgeführt wurde.

Gibt den Status nach dem Warten zurück.

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

Parameter

show_output
bool
Standardwert: True

Gibt an, ob der Ausführungsstatus der Pipeline in sys.stdout angezeigt werden soll.

timeout_seconds
int
Standardwert: 9223372036854775807

Die Anzahl der Sekunden, die gewartet werden soll, bevor ein Timeout eintritt.

raise_on_error
bool
Standardwert: True

Gibt an, ob ein Fehler ausgelöst werden soll, wenn sich die Ausführung in einem fehlerhaften Zustand befindet.

Gibt zurück

Der endgültige Status.

Rückgabetyp

str