HyperDriveRun Třída

HyperDriveRun obsahuje podrobnosti odeslaného experimentu HyperDrivu.

Tuto třídu lze použít ke správě, kontrole stavu a načítání podrobností o spuštění HyperDrivu a ke každému vygenerovanému podřízeného spuštění.

Inicializace spuštění HyperDrivu

Konstruktor

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

Parametry

Name	Description
experiment Vyžadováno	Experiment Experiment pro HyperDrive se spustí.
run_id Vyžadováno	str ID spuštění HyperDrivu.
hyperdrive_config	HyperDriveConfig Konfigurace pro tento HyperDrive se spustí. Default value: None
experiment Vyžadováno	Experiment Experiment pro HyperDrive se spustí.
run_id Vyžadováno	str ID spuštění HyperDrivu.
hyperdrive_config Vyžadováno	HyperDriveConfig Konfigurace pro tento HyperDrive se spustí. Pokud žádný, předpokládáme, že běh již existuje a pokusí se hydratovat z cloudu.

Metody

cancel	Pokud se spuštění HyperDrivu úspěšně zrušilo, vrátí hodnotu True.
fail	Nepoužívejte. Metoda selhání není podporována pro podtřídu HyperDriveRun.
get_best_run_by_primary_metric	Vyhledejte a vraťte instanci spuštění, která odpovídá nejlepšímu spuštění mezi všemi podřízenými spuštěními. Nejlepší spuštění je identifikováno výhradně na základě primárního parametru metriky zadaného v HyperDrivuConfig. PrimaryMetricGoal určuje, jestli se používá minimum nebo maximum primární metriky. Pokud chcete provést podrobnější analýzu všech metrik ExperimentRun spuštěných tímto hyperdrivem, použijte get_metrics. Vrátí se jenom jedno z těchto spuštění, i když několik spuštění spuštěných tímto spuštěním HyperDrivu dosáhlo stejné nejlepší metriky.
get_children_sorted_by_primary_metric	Vrátí seznam podřízených položek seřazených podle jejich nejlepší primární metriky. Řazení se provádí podle primární metriky a jejího cíle: pokud je maximalizované, vrátí se podřízené položky sestupně podle jejich nejlepší primární metriky. Pokud je obrácená hodnota Pravda, pořadí je obrácené. Každá podřízená položka ve výsledku má ID spuštění, hyperparametry, nejlepší primární hodnotu a stav metriky. Podřízené položky bez primární metriky se zahodí, když je discard_no_metric true. Jinak se připojí k seznamu za ostatními podřízenými objekty s primární metrikou. Mějte na paměti, že obrácená možnost nemá na ně žádný vliv.
get_diagnostics	Nepoužívejte. Metoda get_diagnostics není podporována pro podtřídu HyperDriveRun.
get_hyperparameters	Vrátí hyperparametry pro všechna podřízená spuštění, která byla spuštěna tímto HyperDriveRunem.
get_metrics	Vrátí metriky ze všech spuštění, která byla spuštěna touto sadou HyperDriveRun.

cancel

Pokud se spuštění HyperDrivu úspěšně zrušilo, vrátí hodnotu True.

cancel()

Návraty

Typ	Description
bool	Jestli se spuštění úspěšně zrušilo, nebo ne.

fail

Nepoužívejte. Metoda selhání není podporována pro podtřídu HyperDriveRun.

fail()

Výjimky

Typ	Description
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Vyhledejte a vraťte instanci spuštění, která odpovídá nejlepšímu spuštění mezi všemi podřízenými spuštěními.

Nejlepší spuštění je identifikováno výhradně na základě primárního parametru metriky zadaného v HyperDrivuConfig. PrimaryMetricGoal určuje, jestli se používá minimum nebo maximum primární metriky. Pokud chcete provést podrobnější analýzu všech metrik ExperimentRun spuštěných tímto hyperdrivem, použijte get_metrics. Vrátí se jenom jedno z těchto spuštění, i když několik spuštění spuštěných tímto spuštěním HyperDrivu dosáhlo stejné nejlepší metriky.

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

Parametry

Name	Description
include_failed	bool Zda se mají zahrnout neúspěšná spuštění. Default value: True
include_canceled	bool Jestli se mají zahrnout zrušená spuštění. Default value: True
include_resume_from_runs	bool Zda zahrnout zděděné resume_from spuštění. Default value: True

Návraty

Typ	Description
Run	Nejlepší možnost Spustit nebo Žádná, pokud nemá žádná podřízená metrika primární metriku.

get_children_sorted_by_primary_metric

Vrátí seznam podřízených položek seřazených podle jejich nejlepší primární metriky.

Řazení se provádí podle primární metriky a jejího cíle: pokud je maximalizované, vrátí se podřízené položky sestupně podle jejich nejlepší primární metriky. Pokud je obrácená hodnota Pravda, pořadí je obrácené.

Každá podřízená položka ve výsledku má ID spuštění, hyperparametry, nejlepší primární hodnotu a stav metriky.

Podřízené položky bez primární metriky se zahodí, když je discard_no_metric true. Jinak se připojí k seznamu za ostatními podřízenými objekty s primární metrikou. Mějte na paměti, že obrácená možnost nemá na ně žádný vliv.

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

Parametry

Name	Description
top	int Počet hlavních podřízených položek, které se mají vrátit Pokud je 0, vrátí se všechny podřízené položky. Default value: 0
reverse	bool Pokud je true, pořadí bude obráceno. Ovlivňuje pouze podřízené položky s primární metrikou. Default value: False
discard_no_metric	bool Pokud je false, podřízené položky bez primární metriky se připojí k seznamu. Default value: False

Návraty

Typ	Description
list	Seznam slovníků s ID spuštění, hyperparametry, nejlepší primární metrikou a stavem

get_diagnostics

Nepoužívejte. Metoda get_diagnostics není podporována pro podtřídu HyperDriveRun.

get_diagnostics()

Výjimky

Typ	Description
HyperDriveNotImplementedException

get_hyperparameters

Vrátí hyperparametry pro všechna podřízená spuštění, která byla spuštěna tímto HyperDriveRunem.

get_hyperparameters()

Návraty

Typ	Description
dict	Hyperparametry pro všechna podřízená spuštění Jedná se o slovník s run_id jako klíčem.

get_metrics

Vrátí metriky ze všech spuštění, která byla spuštěna touto sadou HyperDriveRun.

get_metrics()

Návraty

Typ	Description
dict	Metriky pro všechny podřízené položky tohoto spuštění.

Atributy

hyperdrive_config

Vraťte konfiguraci spuštění hyperdrivu.

Návraty

Typ	Description
HyperDriveConfig	Konfigurace spuštění hyperdrivu.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'