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 jede der generierten untergeordneten Ausführungen verwendet werden.

Initialisieren Sie eine HyperDrive-Ausführung.

Vererbung

Run

HyperDriveRun

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. Wenn keine, gehen wir davon aus, dass die Ausführung bereits vorhanden ist und versucht, aus der Cloud zu hydratisieren.

Methoden

cancel	Gibt „True“ zurück, wenn die Hyperdrive-Ausführung erfolgreich abgebrochen wurde.
fail	Darf nicht verwendet werden. Die fail-Methode wird für die HyperDriveRun-Unterklasse nicht unterstützt.
get_best_run_by_primary_metric	Suchen Sie die Ausführungsinstanz, die der Ausführung mit der besten Leistung aller untergeordneten Ausführungen entspricht, und geben Sie sie zurück. Die Ausführung mit der besten Leistung wird ausschließlich anhand des primären Metrikparameters identifiziert, der in HyperDriveConfig angegeben ist. PrimaryMetricGoal bestimmt, ob das Minimum oder Maximum der primären Metrik verwendet wird. Um eine ausführlichere Analyse aller ExperimentRun-Metriken durchzuführen, die von dieser Hyperdrive-Ausführung (HyperDriveRun) gestartet werden, verwenden Sie „get_metrics“. Nur eine der Ausführungen wird zurückgegeben, auch wenn einige der von dieser Hyperdrive-Ausführung gestarteten Ausführungen die gleiche beste Metrik erreicht haben.
get_children_sorted_by_primary_metric	Gibt eine Liste der untergeordneten Elemente zurück, sortiert nach ihrer besten primären Metrik. Die Sortierung erfolgt gemäß der primären Metrik und ihrem Ziel: Wenn sie zum Maximieren dient, werden die untergeordneten Elemente in absteigender Reihenfolge ihrer besten primären Metrik zurückgegeben. Wenn „reverse“ auf „True“ festgelegt ist, wird die Reihenfolge umgekehrt. Jedes untergeordnete Element im Ergebnis verfügt über Ausführungs-ID, Hyperparameter, den besten primären Metrikwert und einen Status. Untergeordnete Elemente ohne primäre Metrik werden verworfen, wenn „discard_no_metric“ auf „True“ festgelegt ist. Andernfalls werden sie an die Liste hinter anderen untergeordneten Elemente mit primärer Metrik angefügt. Beachten Sie, dass die reverse-Option keine Auswirkungen auf sie hat.
get_diagnostics	Darf nicht verwendet werden. Die Methode „get_diagnostics“ wird für die HyperDriveRun-Unterklasse nicht unterstützt.
get_hyperparameters	Gibt die Hyperparameter für alle untergeordneten Ausführungen zurück, die von dieser Hyperdrive-Ausführung (HyperDriveRun) gestartet wurden.
get_metrics	Gibt die Metriken für alle Ausführungen zurück, die von dieser Hyperdrive-Ausführung (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

Darf nicht verwendet werden. Die fail-Methode wird für die HyperDriveRun-Unterklasse nicht unterstützt.

fail()

Ausnahmen

Typ	Beschreibung
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Suchen Sie die Ausführungsinstanz, die der Ausführung mit der besten Leistung aller untergeordneten Ausführungen entspricht, und geben Sie sie zurück.

Die Ausführung mit der besten Leistung wird ausschließlich anhand des primären Metrikparameters identifiziert, der in HyperDriveConfig angegeben ist. PrimaryMetricGoal bestimmt, ob das Minimum oder Maximum der primären Metrik verwendet wird. Um eine ausführlichere Analyse aller ExperimentRun-Metriken durchzuführen, die von dieser Hyperdrive-Ausführung (HyperDriveRun) gestartet werden, verwenden Sie „get_metrics“. Nur eine der Ausführungen wird zurückgegeben, auch wenn einige der von dieser Hyperdrive-Ausführung gestarteten Ausführungen 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 fehlerhafte Ausführungen einbezogen werden sollen. Standardwert: True
include_canceled	bool Gibt an, ob abgebrochene Ausführungen einbezogen werden sollen. Standardwert: True
include_resume_from_runs	bool Gibt an, ob geerbte resume_from-Ausführungen einbezogen werden sollen. Standardwert: True

Gibt zurück

Typ	Beschreibung
Run	Die am besten geeignete Ausführung oder „None“, wenn kein untergeordnetes Element über die primäre Metrik verfügt.

get_children_sorted_by_primary_metric

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

Die Sortierung erfolgt gemäß der primären Metrik und ihrem Ziel: Wenn sie zum Maximieren dient, werden die untergeordneten Elemente in absteigender Reihenfolge ihrer besten primären Metrik zurückgegeben. Wenn „reverse“ auf „True“ festgelegt ist, wird die Reihenfolge umgekehrt.

Jedes untergeordnete Element im Ergebnis verfügt über Ausführungs-ID, Hyperparameter, den besten primären Metrikwert und einen Status.

Untergeordnete Elemente ohne primäre Metrik werden verworfen, wenn „discard_no_metric“ auf „True“ festgelegt ist. Andernfalls werden sie an die Liste hinter anderen untergeordneten Elemente mit primärer Metrik angefügt. Beachten Sie, dass die reverse-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. Bei 0 werden alle untergeordneten Elemente zurückgegeben. Standardwert: 0
reverse	bool Bei „True“ wird die Reihenfolge umgekehrt. Dies wirkt sich nur auf untergeordnete Elemente mit primärer Metrik aus. Standardwert: False
discard_no_metric	bool Bei „False“ 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 Ausführungs-ID, Hyperparametern, bester primärer Metrik und Status

get_diagnostics

Darf nicht verwendet werden. Die Methode „get_diagnostics“ 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 dieser Hyperdrive-Ausführung (HyperDriveRun) gestartet wurden.

get_hyperparameters()

Gibt zurück

Typ	Beschreibung
dict	Hyperparameter für alle untergeordneten Ausführungen. Es handelt sich um ein Wörterbuch mit „run_id“ als Schlüssel.

get_metrics

Gibt die Metriken für alle Ausführungen zurück, die von dieser Hyperdrive-Ausführung (HyperDriveRun) gestartet wurden.

get_metrics()

Gibt zurück

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

Attribute

hyperdrive_config

Zurückgeben der Hyperdrive-Ausführungskonfiguration.

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'