Freigeben über

HyperDriveRun Klasse

HyperDriveRun enthält die Details eines übermittelten HyperDrive-Experiments.

Diese Klasse kann zum Verwalten, Überprüfen des Status und Abrufen von Ausführungsdetails für die HyperDrive-Ausführung und die einzelnen generierten untergeordneten Ausführungen verwendet werden.

Initialisieren sie eine HyperDrive-Ausführung.

Konstruktor

HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)

Parameter

Name Beschreibung
experiment
Erforderlich
Experiment

Das Experiment für die HyperDrive-Ausführung.
run_id
Erforderlich
str

Die HyperDrive-Ausführungs-ID.
hyperdrive_config
HyperDriveConfig

Die Konfiguration für diese HyperDrive-Ausführung.

Standardwert: None
experiment
Erforderlich
Experiment

Das Experiment für die HyperDrive-Ausführung.
run_id
Erforderlich
str

Die HyperDrive-Ausführungs-ID.
hyperdrive_config
Erforderlich
HyperDriveConfig

Die Konfiguration für diese HyperDrive-Ausführung. If None, we assume that the run already exists and will try tohydratte from the cloud.

Methoden

cancel

Gibt True zurück, wenn die HyperDrive-Ausführung erfolgreich abgebrochen wurde.
fail

Nicht verwenden. Die Fail-Methode wird für die HyperDriveRun-Unterklasse nicht unterstützt.
get_best_run_by_primary_metric

Suchen und zurückgeben Sie die Run-Instanz, die der besten Ausführung unter allen untergeordneten Läufen entspricht.

Die beste Ausführung wird ausschließlich basierend auf dem primären Metrikparameter identifiziert, der in hyperDriveConfig angegeben ist. Das PrimaryMetricGoal bestimmt, ob das Minimum oder maximum der primären Metrik verwendet wird. Verwenden Sie get_metrics, um eine detailliertere Analyse aller experimentrun-Metriken durchzuführen, die von diesem HyperDriveRun gestartet wurden. Es wird nur eine der Ausgeführten zurückgegeben, auch wenn mehrere der von dieser HyperDrive-Ausführung gestarteten Runs die gleiche beste Metrik erreicht haben.
get_children_sorted_by_primary_metric

Gibt eine Liste der untergeordneten Elemente zurück, die nach ihrer besten primären Metrik sortiert sind.

Die Sortierung erfolgt nach der primären Metrik und ihrem Ziel: Wenn sie maximiert ist, werden die untergeordneten Elemente in absteigender Reihenfolge ihrer besten primären Metrik zurückgegeben. Wenn "Umgekehrt" auf "True" festgelegt ist, wird die Reihenfolge umgekehrt.

Jedes untergeordnete Element im Ergebnis hat die ID, Hyperparameter, den besten primären Metrikwert und den Status.

Untergeordnete Elemente ohne primäre Metrik werden verworfen, wenn discard_no_metric "True" ist. Andernfalls werden sie an die Liste hinter anderen untergeordneten Elementen mit primärer Metrik angefügt. Beachten Sie, dass die Umgekehrte Option keine Auswirkungen auf sie hat.
get_diagnostics

Nicht verwenden. Die get_diagnostics-Methode wird für die HyperDriveRun-Unterklasse nicht unterstützt.
get_hyperparameters

Gibt die Hyperparameter für alle untergeordneten Ausführungen zurück, die von diesem HyperDriveRun gestartet wurden.
get_metrics

Gibt die Metriken aller Ausgeführten zurück, die von diesem HyperDriveRun gestartet wurden.

cancel

Gibt True zurück, wenn die HyperDrive-Ausführung erfolgreich abgebrochen wurde.

cancel()

Gibt zurück

Typ Beschreibung
bool

Gibt an, ob die Ausführung erfolgreich abgebrochen wurde.

fail

Nicht verwenden. Die Fail-Methode wird für die HyperDriveRun-Unterklasse nicht unterstützt.

fail()

Ausnahmen

Typ Beschreibung
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Suchen und zurückgeben Sie die Run-Instanz, die der besten Ausführung unter allen untergeordneten Läufen entspricht.

Die beste Ausführung wird ausschließlich basierend auf dem primären Metrikparameter identifiziert, der in hyperDriveConfig angegeben ist. Das PrimaryMetricGoal bestimmt, ob das Minimum oder maximum der primären Metrik verwendet wird. Verwenden Sie get_metrics, um eine detailliertere Analyse aller experimentrun-Metriken durchzuführen, die von diesem HyperDriveRun gestartet wurden. Es wird nur eine der Ausgeführten zurückgegeben, auch wenn mehrere der von dieser HyperDrive-Ausführung gestarteten Runs die gleiche beste Metrik erreicht haben.

get_best_run_by_primary_metric(include_failed=True, include_canceled=True, include_resume_from_runs=True) -> Run | None

Parameter

Name Beschreibung
include_failed
bool

Gibt an, ob fehlgeschlagene Ausführungen eingeschlossen werden sollen.

Standardwert: True
include_canceled
bool

Gibt an, ob abgebrochene Ausführungen eingeschlossen werden sollen.

Standardwert: True
include_resume_from_runs
bool

Gibt an, ob geerbte resume_from Ausgeführt werden sollen.

Standardwert: True

Gibt zurück

Typ Beschreibung
Run

Die beste Ausführung oder Keine, wenn kein untergeordnetes Element die primäre Metrik aufweist.

get_children_sorted_by_primary_metric

Gibt eine Liste der untergeordneten Elemente zurück, die nach ihrer besten primären Metrik sortiert sind.

Die Sortierung erfolgt nach der primären Metrik und ihrem Ziel: Wenn sie maximiert ist, werden die untergeordneten Elemente in absteigender Reihenfolge ihrer besten primären Metrik zurückgegeben. Wenn "Umgekehrt" auf "True" festgelegt ist, wird die Reihenfolge umgekehrt.

Jedes untergeordnete Element im Ergebnis hat die ID, Hyperparameter, den besten primären Metrikwert und den Status.

Untergeordnete Elemente ohne primäre Metrik werden verworfen, wenn discard_no_metric "True" ist. Andernfalls werden sie an die Liste hinter anderen untergeordneten Elementen mit primärer Metrik angefügt. Beachten Sie, dass die Umgekehrte Option keine Auswirkungen auf sie hat.

get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)

Parameter

Name Beschreibung
top
int

Anzahl der obersten untergeordneten Elemente, die zurückgegeben werden sollen. Wenn es 0 ist, werden alle Kinder zurückgegeben.

Standardwert: 0
reverse
bool

Wenn dies "True" ist, wird die Reihenfolge umgekehrt. Es wirkt sich nur auf untergeordnete Elemente mit primärer Metrik aus.

Standardwert: False
discard_no_metric
bool

Wenn es "False" ist, werden untergeordnete Elemente ohne primäre Metrik an die Liste angefügt.

Standardwert: False

Gibt zurück

Typ Beschreibung
list

Liste der Wörterbücher mit Run-ID, Hyperparametern, bester primärer Metrik und Status

get_diagnostics

Nicht verwenden. Die get_diagnostics-Methode wird für die HyperDriveRun-Unterklasse nicht unterstützt.

get_diagnostics()

Ausnahmen

Typ Beschreibung
HyperDriveNotImplementedException

get_hyperparameters

Gibt die Hyperparameter für alle untergeordneten Ausführungen zurück, die von diesem HyperDriveRun gestartet wurden.

get_hyperparameters()

Gibt zurück

Typ Beschreibung
dict

Hyperparameter für alle untergeordneten Vorgänge. Es handelt sich um ein Wörterbuch mit run_id als Schlüssel.

get_metrics

Gibt die Metriken aller Ausgeführten zurück, die von diesem HyperDriveRun gestartet wurden.

get_metrics()

Gibt zurück

Typ Beschreibung
dict

Die Metriken für alle untergeordneten Elemente dieser Ausführung.

Attribute

hyperdrive_config

Gibt die Hyperdrive-Ausführungskonfiguration zurück.

Gibt zurück

Typ Beschreibung
HyperDriveConfig

Die Hyperdrive-Ausführungskonfiguration.

HYPER_DRIVE_RUN_USER_AGENT 

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE 

RUN_TYPE = 'hyperdrive'