Freigeben über

StepRun Klasse

  • Referenz

Eine Ausführung eines Schritts in einer Pipeline.

Diese Klasse kann zum Verwalten, Überprüfen des Status und Abrufen von Ausführungsdetails verwendet werden, nachdem die Ausführung der übergeordneten Pipeline übermittelt wurde und die Pipeline die Schrittausführung übermittelt hat.

Initialisieren Sie ein StepRun-Objekt.

Vererbung
Run
StepRun

Konstruktor

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)

Parameter

Name Beschreibung
experiment
Erforderlich
Experiment

Das Experimentobjekt der Schrittausführung.
step_run_id
Erforderlich
str

Die Schrittausführungs-ID.
pipeline_run_id
Erforderlich
str

Die ID der Ausführung der übergeordneten Pipeline.
node_id
Erforderlich
str

Die ID des Knotens im Graph, der diesen Schritt darstellt.
_service_endpoint
str

Der Endpunkt, mit dem eine Verbindung hergestellt werden soll.

Standardwert: None
_is_reused
bool

Gibt an, ob diese Ausführung eine wiederverwendete vorherige Ausführung ist.

Standardwert: False
_current_node_id
str

Bei einem wiederverwendeten Knoten ist dies die Knoten-ID im aktuellen Graph.

Standardwert: None
_reused_run_id
str

Die ID der wiederverwendeten Ausführung.

Standardwert: None
_reused_node_id
str

Die ID des wiederverwendeten Knotens.

Standardwert: None
_reused_pipeline_run_id
str

Die ID der wiederverwendeten Pipeline.

Standardwert: None
experiment
Erforderlich
Experiment

Das Experimentobjekt der Schrittausführung.
step_run_id
Erforderlich
str

Die Schrittausführungs-ID.
pipeline_run_id
Erforderlich
str

Die ID der Ausführung der übergeordneten Pipeline.
node_id
Erforderlich
str

Die ID des Knotens im Graph, der diesen Schritt darstellt.
_service_endpoint
Erforderlich
str

Der Endpunkt, mit dem eine Verbindung hergestellt werden soll.
_is_reused
Erforderlich
bool

Gibt an, ob diese Ausführung eine wiederverwendete vorherige Ausführung ist.
_current_node_id
Erforderlich
str

Bei einem wiederverwendeten Knoten ist dies die Knoten-ID im aktuellen Graph.
_reused_run_id
Erforderlich
_reused_node_id
Erforderlich
str
_reused_pipeline_run_id
Erforderlich
str

Hinweise

Eine StepRun wird als untergeordnete Ausführung einer übermittelten PipelineRun erstellt. Rufen Sie alle StepRuns in einer PipelineRun wie folgt ab:


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

Verwenden Sie get_details_with_logs, um die Ausführungsdetails und Protokolle abzurufen, die von der Ausführung erstellt wurden.

StepRun kann auch zum Herunterladen der Ausgaben einer Ausführung verwendet werden. Verwenden Sie get_outputs, um ein Wörterbuch der Schrittausgaben abzurufen, oder verwenden Sie get_output, um das einzelne StepRunOutput-Objekt für die Ausgabe mit dem angegebenen Namen abzurufen. Sie können auch get_output_data verwenden, um die PortDataReference für die angegebene Schrittausgabe direkt abzurufen.

Ein Beispiel für das Herunterladen einer Schrittausgabe ist:


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

Methoden

child_run

Untergeordnete Ausführung für die Schrittausführung. Diese Methode ist für StepRun nicht implementiert.
complete

„Complete“ für die Schrittausführung. Diese Methode ist für StepRun nicht implementiert.
fail

Fehler bei Schrittausführung. Diese Methode ist für StepRun nicht implementiert.
get_details_with_logs

Gibt die Statusdetails der Ausführung mit Protokolldateiinhalten zurück.
get_job_log

Sichert das aktuelle Auftragsprotokoll für die Ausführung des Schritts.
get_output

Ruft die Knotenausgabe mit dem angegebenen Namen ab.
get_output_data

Ruft die Ausgabedaten aus einer bestimmten Ausgabe ab.
get_outputs

Ruft die Schrittausgaben ab.
get_status

Ruft den aktuellen Status der Pipelineausführung vom Dienst ab.

Zu den häufig zurückgegebenen Werten zählen „Running“ (Wird ausgeführt), „Finished“ (Abgeschlossen) und „Failed“ (Fehler).
get_stderr_log

Sichert das aktuelle stderr-Protokoll für die Schrittausführung.
get_stdout_log

Sichert das aktuelle stdout-Protokoll für die Schrittausführung.
wait_for_completion

Wartet auf den Abschluss dieser Schrittausführung.

Gibt den Status nach dem Warten zurück.

child_run

Untergeordnete Ausführung für die Schrittausführung. Diese Methode ist für StepRun nicht implementiert.

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

Parameter

Name Beschreibung
name
str

Optionaler Name für das untergeordnete Element

Standardwert: None
run_id
str

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

Standardwert: None
outputs
str

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

Standardwert: None

Gibt zurück

Typ Beschreibung
Run

Die untergeordnete Ausführung

Ausnahmen

Typ Beschreibung
NotImplementedError

complete

„Complete“ für die Schrittausführung. Diese Methode ist für StepRun nicht implementiert.

complete()

Ausnahmen

Typ Beschreibung
NotImplementedError

fail

Fehler bei Schrittausführung. Diese Methode ist für StepRun nicht implementiert.

fail()

Ausnahmen

Typ Beschreibung
NotImplementedError

get_details_with_logs

Gibt die Statusdetails der Ausführung mit Protokolldateiinhalten zurück.

get_details_with_logs()

Gibt zurück

Typ Beschreibung
dict

Gibt den Status für die Ausführung mit Protokolldateiinhalten zurück.

Ausnahmen

Typ Beschreibung
NotImplementedError

get_job_log

Sichert das aktuelle Auftragsprotokoll für die Ausführung des Schritts.

get_job_log()

Gibt zurück

Typ Beschreibung
str

Die Protokollzeichenfolge.

Ausnahmen

Typ Beschreibung
NotImplementedError

get_output

Ruft die Knotenausgabe mit dem angegebenen Namen ab.

get_output(name)

Parameter

Name Beschreibung
name
Erforderlich
str

Der Name der Ausgabe

Gibt zurück

Typ Beschreibung
StepRunOutput

StepRunOutput mit dem angegebenen Namen.

Ausnahmen

Typ Beschreibung
NotImplementedError

get_output_data

Ruft die Ausgabedaten aus einer bestimmten Ausgabe ab.

get_output_data(name)

Parameter

Name Beschreibung
name
Erforderlich
str

Der Name der Ausgabe

Gibt zurück

Typ Beschreibung
PortDataReference

PortDataReference zur Darstellung der Schrittausgabedaten.

Ausnahmen

Typ Beschreibung
NotImplementedError

get_outputs

Ruft die Schrittausgaben ab.

get_outputs()

Gibt zurück

Typ Beschreibung
dict

Ein Wörterbuch von StepRunOutputs mit dem Ausgabenamen als Schlüssel.

Ausnahmen

Typ Beschreibung
NotImplementedError

get_status

Ruft den aktuellen Status der Pipelineausführung vom Dienst ab.

Zu den häufig zurückgegebenen Werten zählen „Running“ (Wird ausgeführt), „Finished“ (Abgeschlossen) und „Failed“ (Fehler).

get_status()

Gibt zurück

Typ Beschreibung
str

Der letzte Status als Zeichenfolge.

Ausnahmen

Typ Beschreibung
NotImplementedError

Hinweise

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

  • „Queued“ (In Warteschlange): Der Auftrag wird in die Warteschlange eingereiht.

  • „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.

  • „Canceled“ (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_stderr_log

Sichert das aktuelle stderr-Protokoll für die Schrittausführung.

get_stderr_log()

Gibt zurück

Typ Beschreibung
str

Die Protokollzeichenfolge.

Ausnahmen

Typ Beschreibung
NotImplementedError

get_stdout_log

Sichert das aktuelle stdout-Protokoll für die Schrittausführung.

get_stdout_log()

Gibt zurück

Typ Beschreibung
str

Die Protokollzeichenfolge.

Ausnahmen

Typ Beschreibung
NotImplementedError

wait_for_completion

Wartet auf den Abschluss dieser Schrittausführung.

Gibt den Status nach dem Warten zurück.

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

Parameter

Name Beschreibung
show_output
bool

show_output=True zeigt den Ausführungsstatus der Pipeline in sys.stdout an.

Standardwert: True
timeout_seconds
int

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

Standardwert: 9223372036854775807
raise_on_error
bool

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

Standardwert: True

Gibt zurück

Typ Beschreibung
str

Der endgültige Status.

Ausnahmen

Typ Beschreibung
NotImplementedError

Attribute

pipeline_run_id

Gibt die ID der Pipeline-Ausführung zurück, die dieser Schrittausführung entspricht.

Gibt zurück

Typ Beschreibung
str

Die PipelineRun-ID.