HyperDriveRun Osztály

A HyperDriveRun egy elküldött HyperDrive-kísérlet részleteit tartalmazza.

Ez az osztály a HyperDrive-futtatás és a létrehozott gyermekfuttatások futtatási részleteinek kezelésére, állapotának ellenőrzésére és lekérésére használható.

HyperDrive-futtatás inicializálása.

Öröklődés

Run

HyperDriveRun

Konstruktor

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

Paraméterek

Name	Description
experiment Kötelező	Experiment A HyperDrive-kísérlet futtatása.
run_id Kötelező	str A HyperDrive futtatási azonosítója.
hyperdrive_config	HyperDriveConfig Futtassa a HyperDrive konfigurációját. alapértelmezett érték: None
experiment Kötelező	Experiment A HyperDrive-kísérlet futtatása.
run_id Kötelező	str A HyperDrive futtatási azonosítója.
hyperdrive_config Kötelező	HyperDriveConfig Futtassa a HyperDrive konfigurációját. Ha nincs, feltételezzük, hogy a futtatás már létezik, és megpróbál hidratálni a felhőből.

Metódusok

cancel	Igaz értéket ad vissza, ha a HyperDrive-futtatás sikeresen megszakadt.
fail	Ne használja. A HyperDriveRun alosztály nem támogatja a feladatmetódust.
get_best_run_by_primary_metric	Keresse meg és adja vissza az összes gyermekfuttatás közül a legjobban teljesítő futtatásnak megfelelő Futtatás példányt. A legjobban teljesítő futtatás azonosítása kizárólag a HyperDriveConfigban megadott elsődleges metrikaparaméter alapján történik. A PrimaryMetricGoal határozza meg, hogy az elsődleges metrika minimumát vagy maximumát használja-e. A HyperDriveRun által indított ExperimentRun-metrikák részletesebb elemzéséhez használja a get_metrics. Csak az egyik futtatás lesz visszaadva, még akkor is, ha a HyperDrive-futtatás által indított futtatások közül több is elérte ugyanazt a legjobb metrikát.
get_children_sorted_by_primary_metric	A gyermekek listáját adja vissza a legjobb elsődleges metrika szerint rendezve. A rendezés az elsődleges metrika és annak célja szerint történik: ha teljes méretű, akkor a gyermekek a legjobb elsődleges metrika csökkenő sorrendjében lesznek visszaadva. Ha a fordított értéke Igaz, a sorrend vissza lesz állítva. Az eredményben szereplő minden gyermek rendelkezik futtatási azonosítóval, hiperparaméterekkel, a legjobb elsődleges metrikaértékekkel és állapottal. Az elsődleges metrika nélküli gyermekeket a rendszer elveti, ha discard_no_metric Igaz. Ellenkező esetben a rendszer hozzáfűzi őket a többi elsődleges metrikát tartalmazó gyermek mögötti listához. Vegye figyelembe, hogy a fordított beállítás nincs hatással rájuk.
get_diagnostics	Ne használja. A get_diagnostics metódus nem támogatott a HyperDriveRun alosztály esetében.
get_hyperparameters	A HyperDriveRun által indított összes gyermekfuttatás hiperparamétereit adja vissza.
get_metrics	A HyperDriveRun által indított összes futtatás metrikáit adja vissza.

cancel

Igaz értéket ad vissza, ha a HyperDrive-futtatás sikeresen megszakadt.

cancel()

Válaszok

Típus	Description
bool	Azt jelzi, hogy a futtatás sikeresen megszakadt-e.

fail

Ne használja. A HyperDriveRun alosztály nem támogatja a feladatmetódust.

fail()

Kivételek

Típus	Description
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Keresse meg és adja vissza az összes gyermekfuttatás közül a legjobban teljesítő futtatásnak megfelelő Futtatás példányt.

A legjobban teljesítő futtatás azonosítása kizárólag a HyperDriveConfigban megadott elsődleges metrikaparaméter alapján történik. A PrimaryMetricGoal határozza meg, hogy az elsődleges metrika minimumát vagy maximumát használja-e. A HyperDriveRun által indított ExperimentRun-metrikák részletesebb elemzéséhez használja a get_metrics. Csak az egyik futtatás lesz visszaadva, még akkor is, ha a HyperDrive-futtatás által indított futtatások közül több is elérte ugyanazt a legjobb metrikát.

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

Paraméterek

Name	Description
include_failed	bool A sikertelen futtatások belefoglalása. alapértelmezett érték: True
include_canceled	bool A megszakított futtatások belefoglalása. alapértelmezett érték: True
include_resume_from_runs	bool Az örökölt resume_from-futtatások belefoglalása. alapértelmezett érték: True

Válaszok

Típus	Description
Run	A legjobb Futtatás vagy Nincs, ha egyetlen gyermek sem rendelkezik az elsődleges metrikával.

get_children_sorted_by_primary_metric

A gyermekek listáját adja vissza a legjobb elsődleges metrika szerint rendezve.

A rendezés az elsődleges metrika és annak célja szerint történik: ha teljes méretű, akkor a gyermekek a legjobb elsődleges metrika csökkenő sorrendjében lesznek visszaadva. Ha a fordított értéke Igaz, a sorrend vissza lesz állítva.

Az eredményben szereplő minden gyermek rendelkezik futtatási azonosítóval, hiperparaméterekkel, a legjobb elsődleges metrikaértékekkel és állapottal.

Az elsődleges metrika nélküli gyermekeket a rendszer elveti, ha discard_no_metric Igaz. Ellenkező esetben a rendszer hozzáfűzi őket a többi elsődleges metrikát tartalmazó gyermek mögötti listához. Vegye figyelembe, hogy a fordított beállítás nincs hatással rájuk.

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

Paraméterek

Name	Description
top	int A visszaküldött gyermekek száma. Ha 0, minden gyermek visszakerül. alapértelmezett érték: 0
reverse	bool Ha igaz, a sorrend vissza lesz állítva. Ez csak az elsődleges metrikával rendelkező gyermekekre van hatással. alapértelmezett érték: False
discard_no_metric	bool Ha hamis, akkor az elsődleges metrika nélküli gyermekek hozzá lesznek fűzve a listához. alapértelmezett érték: False

Válaszok

Típus	Description
list	A futtatási azonosítóval, hiperparaméterekkel, a legjobb elsődleges metrikával és állapottal rendelkező szótárak listája

get_diagnostics

Ne használja. A get_diagnostics metódus nem támogatott a HyperDriveRun alosztály esetében.

get_diagnostics()

Kivételek

Típus	Description
HyperDriveNotImplementedException

get_hyperparameters

A HyperDriveRun által indított összes gyermekfuttatás hiperparamétereit adja vissza.

get_hyperparameters()

Válaszok

Típus	Description
dict	Hiperparaméterek az összes gyermekfuttatáshoz. Ez egy szótár, run_id kulcsként.

get_metrics

A HyperDriveRun által indított összes futtatás metrikáit adja vissza.

get_metrics()

Válaszok

Típus	Description
dict	A futtatás összes gyermekének metrikái.

Attribútumok

hyperdrive_config

Adja vissza a hyperdrive-futtatási konfigurációt.

Válaszok

Típus	Description
HyperDriveConfig	A hyperdrive futtatási konfigurációja.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'