HyperDriveRun Klass

HyperDriveRun innehåller information om ett skickat HyperDrive-experiment.

Den här klassen kan användas för att hantera, kontrollera status och hämta körningsinformation för HyperDrive-körningen och var och en av de genererade underordnade körningarna.

Initiera en HyperDrive-körning.

Arv

Run

HyperDriveRun

Konstruktor

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

Parametrar

Name	Description
experiment Obligatorisk	Experiment Experimentet för HyperDrive-körningen.
run_id Obligatorisk	str Körnings-ID:t för HyperDrive.
hyperdrive_config	HyperDriveConfig Konfigurationen för den här HyperDrive-körningen. Standardvärde: None
experiment Obligatorisk	Experiment Experimentet för HyperDrive-körningen.
run_id Obligatorisk	str Körnings-ID:t för HyperDrive.
hyperdrive_config Obligatorisk	HyperDriveConfig Konfigurationen för den här HyperDrive-körningen. Om den är Ingen förutsätter vi att körningen redan finns och försöker att fukta från molnet.

Metoder

cancel	Returnera Sant om HyperDrive-körningen avbröts.
fail	Använd inte. Metoden fail stöds inte för HyperDriveRun-underklassen.
get_best_run_by_primary_metric	Hitta och returnera den Run-instans som motsvarar den bästa körningen bland alla underordnade körningar. Den bästa körningen identifieras enbart baserat på den primära måttparametern som anges i HyperDriveConfig. PrimaryMetricGoal styr om det primära måttets lägsta eller högsta värde används. Om du vill göra en mer detaljerad analys av alla ExperimentRun-mått som startas av denna HyperDriveRun använder du get_metrics. Endast en av körningarna returneras, även om flera av körningarna som startades av den här HyperDrive-körningen nådde samma bästa mått.
get_children_sorted_by_primary_metric	Returnera en lista över underordnade som sorteras efter deras bästa primära mått. Sorteringen utförs enligt det primära måttet och dess mål: om den är maximerad returneras de underordnade i fallande ordning efter sitt bästa primära mått. Om omvänd är Sant återförs ordningen. Varje underordnad i resultatet har körnings-ID, hyperparametrar, bästa primära måttvärde och status. Underordnade utan primärt mått ignoreras när discard_no_metric är Sant. Annars läggs de till i listan bakom andra underordnade med primärt mått. Observera att det omvända alternativet inte påverkar dem.
get_diagnostics	Använd inte. Metoden get_diagnostics stöds inte för HyperDriveRun-underklassen.
get_hyperparameters	Returnera hyperparametrarna för alla underordnade körningar som startades av denna HyperDriveRun.
get_metrics	Returnera måtten från alla körningar som startades av denna HyperDriveRun.

cancel

Returnera Sant om HyperDrive-körningen avbröts.

cancel()

Returer

Typ	Description
bool	Om körningen avbröts eller inte.

fail

Använd inte. Metoden fail stöds inte för HyperDriveRun-underklassen.

fail()

Undantag

Typ	Description
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Hitta och returnera den Run-instans som motsvarar den bästa körningen bland alla underordnade körningar.

Den bästa körningen identifieras enbart baserat på den primära måttparametern som anges i HyperDriveConfig. PrimaryMetricGoal styr om det primära måttets lägsta eller högsta värde används. Om du vill göra en mer detaljerad analys av alla ExperimentRun-mått som startas av denna HyperDriveRun använder du get_metrics. Endast en av körningarna returneras, även om flera av körningarna som startades av den här HyperDrive-körningen nådde samma bästa mått.

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

Parametrar

Name	Description
include_failed	bool Om misslyckade körningar ska inkluderas. Standardvärde: True
include_canceled	bool Om avbrutna körningar ska inkluderas. Standardvärde: True
include_resume_from_runs	bool Om ärvda resume_from körningar ska inkluderas. Standardvärde: True

Returer

Typ	Description
Run	Bästa Körning eller Ingen om inget underordnat har det primära måttet.

get_children_sorted_by_primary_metric

Returnera en lista över underordnade som sorteras efter deras bästa primära mått.

Sorteringen utförs enligt det primära måttet och dess mål: om den är maximerad returneras de underordnade i fallande ordning efter sitt bästa primära mått. Om omvänd är Sant återförs ordningen.

Varje underordnad i resultatet har körnings-ID, hyperparametrar, bästa primära måttvärde och status.

Underordnade utan primärt mått ignoreras när discard_no_metric är Sant. Annars läggs de till i listan bakom andra underordnade med primärt mått. Observera att det omvända alternativet inte påverkar dem.

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

Parametrar

Name	Description
top	int Antal underordnade främsta som ska returneras. Om det är 0 returneras alla barn. Standardvärde: 0
reverse	bool Om det är Sant kommer ordningen att ångras. Det påverkar endast underordnade med primärt mått. Standardvärde: False
discard_no_metric	bool Om det är Falskt läggs underordnade utan primärt mått till i listan. Standardvärde: False

Returer

Typ	Description
list	Lista över ordlistor med körnings-ID, hyperparametrar, bästa primära mått och status

get_diagnostics

Använd inte. Metoden get_diagnostics stöds inte för HyperDriveRun-underklassen.

get_diagnostics()

Undantag

Typ	Description
HyperDriveNotImplementedException

get_hyperparameters

Returnera hyperparametrarna för alla underordnade körningar som startades av denna HyperDriveRun.

get_hyperparameters()

Returer

Typ	Description
dict	Hyperparametrar för alla underordnade körningar. Det är en ordlista med run_id som nyckel.

get_metrics

Returnera måtten från alla körningar som startades av denna HyperDriveRun.

get_metrics()

Returer

Typ	Description
dict	Mått för alla underordnade för den här körningen.

Attribut

hyperdrive_config

Returnera hyperdrive-körningskonfigurationen.

Returer

Typ	Description
HyperDriveConfig	Hyperdrive-körningskonfigurationen.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'