HyperDriveRun Klasa

Funkcja HyperDriveRun zawiera szczegóły przesłanego eksperymentu funkcji HyperDrive.

Ta klasa może służyć do zarządzania, sprawdzania stanu i pobierania szczegółów przebiegu dla przebiegu funkcji HyperDrive i każdego z wygenerowanych przebiegów podrzędnych.

Inicjowanie uruchomienia usługi HyperDrive.

Dziedziczenie

Run

HyperDriveRun

Konstruktor

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

Parametry

Nazwa	Opis
experiment Wymagane	Experiment Eksperyment dla uruchomienia usługi HyperDrive.
run_id Wymagane	str Identyfikator uruchomienia funkcji HyperDrive.
hyperdrive_config	HyperDriveConfig Konfiguracja dla tej funkcji HyperDrive jest uruchamiana. wartość domyślna: None
experiment Wymagane	Experiment Eksperyment dla uruchomienia usługi HyperDrive.
run_id Wymagane	str Identyfikator uruchomienia funkcji HyperDrive.
hyperdrive_config Wymagane	HyperDriveConfig Konfiguracja dla tej funkcji HyperDrive jest uruchamiana. Jeśli brak, załóżmy, że przebieg już istnieje i spróbujemy nawodnić z chmury.

Metody

cancel	Zwróć wartość True, jeśli przebieg funkcji HyperDrive został pomyślnie anulowany.
fail	Nie używaj. Metoda fail nie jest obsługiwana dla podklasy HyperDriveRun.
get_best_run_by_primary_metric	Znajdź i zwróć wystąpienie Uruchom, które odpowiada najlepszemu przebiegowi podrzędnego. Przebieg o najlepszej wydajności jest identyfikowany wyłącznie na podstawie podstawowego parametru metryki określonego w funkcji HyperDriveConfig. Element PrimaryMetricGoal określa, czy jest używana minimalna, czy maksymalna wartość podstawowej metryki. Aby przeprowadzić bardziej szczegółową analizę wszystkich metryk ExperimentRun uruchomionych przez tę funkcję HyperDriveRun, użyj get_metrics. Zwracany jest tylko jeden z przebiegów, nawet jeśli kilka przebiegów uruchomionych przez tę metrykę funkcji HyperDrive osiągnęło tę samą najlepszą metrykę.
get_children_sorted_by_primary_metric	Zwróć listę elementów podrzędnych posortowanych według najlepszej podstawowej metryki. Sortowanie odbywa się zgodnie z metryką podstawową i jej celem: jeśli jest zmaksymalizowana, to dzieci są zwracane w kolejności malejącej najlepszej podstawowej metryki. Jeśli odwrotnie ma wartość True, kolejność jest odwracana. Każdy element podrzędny w wyniku ma identyfikator przebiegu, hiperparametry, najlepszą podstawową wartość metryki i stan. Elementy podrzędne bez podstawowej metryki są odrzucane, gdy discard_no_metric ma wartość True. W przeciwnym razie są one dołączane do listy innych elementów podrzędnych z metrykami podstawowymi. Należy pamiętać, że opcja odwrotna nie ma na nie wpływu.
get_diagnostics	Nie używaj. Metoda get_diagnostics nie jest obsługiwana dla podklasy HyperDriveRun.
get_hyperparameters	Zwróć hiperparametry dla wszystkich przebiegów podrzędnych, które zostały uruchomione przez tę funkcję HyperDriveRun.
get_metrics	Zwróć metryki ze wszystkich przebiegów uruchomionych przez tę funkcję HyperDriveRun.

cancel

Zwróć wartość True, jeśli przebieg funkcji HyperDrive został pomyślnie anulowany.

cancel()

Zwraca

Typ	Opis
bool	Czy przebieg został pomyślnie anulowany.

fail

Nie używaj. Metoda fail nie jest obsługiwana dla podklasy HyperDriveRun.

fail()

Wyjątki

Typ	Opis
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Znajdź i zwróć wystąpienie Uruchom, które odpowiada najlepszemu przebiegowi podrzędnego.

Przebieg o najlepszej wydajności jest identyfikowany wyłącznie na podstawie podstawowego parametru metryki określonego w funkcji HyperDriveConfig. Element PrimaryMetricGoal określa, czy jest używana minimalna, czy maksymalna wartość podstawowej metryki. Aby przeprowadzić bardziej szczegółową analizę wszystkich metryk ExperimentRun uruchomionych przez tę funkcję HyperDriveRun, użyj get_metrics. Zwracany jest tylko jeden z przebiegów, nawet jeśli kilka przebiegów uruchomionych przez tę metrykę funkcji HyperDrive osiągnęło tę samą najlepszą metrykę.

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

Parametry

Nazwa	Opis
include_failed	bool Określa, czy należy uwzględnić przebiegi w trybie failed. wartość domyślna: True
include_canceled	bool Czy uwzględnić anulowane przebiegi. wartość domyślna: True
include_resume_from_runs	bool Określa, czy dołączać dziedziczone resume_from działa. wartość domyślna: True

Zwraca

Typ	Opis
Run	Najlepszy przebieg lub Brak, jeśli żaden element podrzędny nie ma podstawowej metryki.

get_children_sorted_by_primary_metric

Zwróć listę elementów podrzędnych posortowanych według najlepszej podstawowej metryki.

Sortowanie odbywa się zgodnie z metryką podstawową i jej celem: jeśli jest zmaksymalizowana, to dzieci są zwracane w kolejności malejącej najlepszej podstawowej metryki. Jeśli odwrotnie ma wartość True, kolejność jest odwracana.

Każdy element podrzędny w wyniku ma identyfikator przebiegu, hiperparametry, najlepszą podstawową wartość metryki i stan.

Elementy podrzędne bez podstawowej metryki są odrzucane, gdy discard_no_metric ma wartość True. W przeciwnym razie są one dołączane do listy innych elementów podrzędnych z metrykami podstawowymi. Należy pamiętać, że opcja odwrotna nie ma na nie wpływu.

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

Parametry

Nazwa	Opis
top	int Liczba najczęściej zwracanych elementów podrzędnych. Jeśli ma wartość 0, zostaną zwrócone wszystkie dzieci. wartość domyślna: 0
reverse	bool Jeśli ma wartość True, kolejność zostanie odwrócona. Ma to wpływ tylko na elementy podrzędne z metrykami podstawowymi. wartość domyślna: False
discard_no_metric	bool Jeśli ma wartość False, elementy podrzędne bez podstawowej metryki zostaną dołączone do listy. wartość domyślna: False

Zwraca

Typ	Opis
list	Lista słowników z identyfikatorem przebiegu, hiperparametrami, najlepszą metrykami podstawowymi i stanem

get_diagnostics

Nie używaj. Metoda get_diagnostics nie jest obsługiwana dla podklasy HyperDriveRun.

get_diagnostics()

Wyjątki

Typ	Opis
HyperDriveNotImplementedException

get_hyperparameters

Zwróć hiperparametry dla wszystkich przebiegów podrzędnych, które zostały uruchomione przez tę funkcję HyperDriveRun.

get_hyperparameters()

Zwraca

Typ	Opis
dict	Hiperparametry dla wszystkich przebiegów podrzędnych. Jest to słownik z run_id jako klucz.

get_metrics

Zwróć metryki ze wszystkich przebiegów uruchomionych przez tę funkcję HyperDriveRun.

get_metrics()

Zwraca

Typ	Opis
dict	Metryki dla wszystkich elementów podrzędnych tego przebiegu.

Atrybuty

hyperdrive_config

Zwróć konfigurację uruchamiania funkcji hyperdrive.

Zwraca

Typ	Opis
HyperDriveConfig	Konfiguracja uruchamiania funkcji hyperdrive.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'