HyperDriveRun Classe

HyperDriveRun contiene i dettagli di un esperimento di HyperDrive inviato.

Questa classe può essere usata per gestire, controllare lo stato e recuperare i dettagli dell'esecuzione di HyperDrive e ognuna delle esecuzioni figlio generate.

Inizializzare un'esecuzione di HyperDrive.

Ereditarietà

Run

HyperDriveRun

Costruttore

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

Parametri

Nome	Descrizione
experiment Necessario	Experiment Esperimento per l'esecuzione di HyperDrive.
run_id Necessario	str ID di esecuzione di HyperDrive.
hyperdrive_config	HyperDriveConfig Configurazione per l'esecuzione di HyperDrive. Valore predefinito: None
experiment Necessario	Experiment Esperimento per l'esecuzione di HyperDrive.
run_id Necessario	str ID di esecuzione di HyperDrive.
hyperdrive_config Necessario	HyperDriveConfig Configurazione per l'esecuzione di HyperDrive. Se Nessuno, si presuppone che l'esecuzione esista già e tenterà di idratarsi dal cloud.

Metodi

cancel	Restituisce True se l'esecuzione di HyperDrive è stata annullata correttamente.
fail	Non usare. Il metodo fail non è supportato per la sottoclasse HyperDriveRun.
get_best_run_by_primary_metric	Trovare e restituire l'istanza di Run che corrisponde all'esecuzione con prestazioni migliori tra tutte le esecuzioni figlio. L'esecuzione con prestazioni migliori viene identificata esclusivamente in base al parametro della metrica primaria specificato in HyperDriveConfig. PrimaryMetricGoal determina se viene usato il valore minimo o massimo della metrica primaria. Per eseguire un'analisi più dettagliata di tutte le metriche ExperimentRun avviate da hyperDriveRun, usare get_metrics. Viene restituita solo una delle esecuzioni, anche se diverse esecuzioni avviate da questa esecuzione di HyperDrive hanno raggiunto la stessa metrica migliore.
get_children_sorted_by_primary_metric	Restituisce un elenco di elementi figlio ordinati in base alla metrica primaria migliore. L'ordinamento viene eseguito in base alla metrica primaria e al relativo obiettivo: se è ingrandita, gli elementi figlio vengono restituiti in ordine decrescente della metrica primaria migliore. Se il valore inverso è True, l'ordine viene invertito. Ogni elemento figlio nel risultato ha id esecuzione, iperparametri, valore e stato della metrica primaria migliore. Gli elementi figlio senza metrica primaria vengono eliminati quando discard_no_metric è True. In caso contrario, vengono aggiunti all'elenco dietro altri elementi figlio con la metrica primaria. Si noti che l'opzione inversa non ha alcun impatto su di essi.
get_diagnostics	Non usare. Il metodo get_diagnostics non è supportato per la sottoclasse HyperDriveRun.
get_hyperparameters	Restituisce gli iperparametri per tutte le esecuzioni figlio avviate da questo HyperDriveRun.
get_metrics	Restituisce le metriche da tutte le esecuzioni avviate da questo HyperDriveRun.

cancel

Restituisce True se l'esecuzione di HyperDrive è stata annullata correttamente.

cancel()

Restituisce

Tipo	Descrizione
bool	Indica se l'esecuzione è stata annullata correttamente.

fail

Non usare. Il metodo fail non è supportato per la sottoclasse HyperDriveRun.

fail()

Eccezioni

Tipo	Descrizione
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Trovare e restituire l'istanza di Run che corrisponde all'esecuzione con prestazioni migliori tra tutte le esecuzioni figlio.

L'esecuzione con prestazioni migliori viene identificata esclusivamente in base al parametro della metrica primaria specificato in HyperDriveConfig. PrimaryMetricGoal determina se viene usato il valore minimo o massimo della metrica primaria. Per eseguire un'analisi più dettagliata di tutte le metriche ExperimentRun avviate da hyperDriveRun, usare get_metrics. Viene restituita solo una delle esecuzioni, anche se diverse esecuzioni avviate da questa esecuzione di HyperDrive hanno raggiunto la stessa metrica migliore.

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

Parametri

Nome	Descrizione
include_failed	bool Indica se includere esecuzioni non riuscite. Valore predefinito: True
include_canceled	bool Indica se includere esecuzioni annullate. Valore predefinito: True
include_resume_from_runs	bool Indica se includere esecuzioni di resume_from ereditate. Valore predefinito: True

Restituisce

Tipo	Descrizione
Run	Esecuzione ottimale o Nessuna se nessun elemento figlio ha la metrica primaria.

get_children_sorted_by_primary_metric

Restituisce un elenco di elementi figlio ordinati in base alla metrica primaria migliore.

L'ordinamento viene eseguito in base alla metrica primaria e al relativo obiettivo: se è ingrandita, gli elementi figlio vengono restituiti in ordine decrescente della metrica primaria migliore. Se il valore inverso è True, l'ordine viene invertito.

Ogni elemento figlio nel risultato ha id esecuzione, iperparametri, valore e stato della metrica primaria migliore.

Gli elementi figlio senza metrica primaria vengono eliminati quando discard_no_metric è True. In caso contrario, vengono aggiunti all'elenco dietro altri elementi figlio con la metrica primaria. Si noti che l'opzione inversa non ha alcun impatto su di essi.

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

Parametri

Nome	Descrizione
top	int Numero di elementi figlio principali da restituire. Se è uguale a 0, verranno restituiti tutti gli elementi figlio. Valore predefinito: 0
reverse	bool Se è True, l'ordine verrà invertito. Influisce solo sugli elementi figlio con la metrica primaria. Valore predefinito: False
discard_no_metric	bool Se è False, gli elementi figlio senza la metrica primaria verranno aggiunti all'elenco. Valore predefinito: False

Restituisce

Tipo	Descrizione
list	Elenco di dizionari con ID esecuzione, iperparametri, migliore metrica primaria e stato

get_diagnostics

Non usare. Il metodo get_diagnostics non è supportato per la sottoclasse HyperDriveRun.

get_diagnostics()

Eccezioni

Tipo	Descrizione
HyperDriveNotImplementedException

get_hyperparameters

Restituisce gli iperparametri per tutte le esecuzioni figlio avviate da questo HyperDriveRun.

get_hyperparameters()

Restituisce

Tipo	Descrizione
dict	Iperparametri per tutte le esecuzioni figlio. È un dizionario con run_id come chiave.

get_metrics

Restituisce le metriche da tutte le esecuzioni avviate da questo HyperDriveRun.

get_metrics()

Restituisce

Tipo	Descrizione
dict	Metriche per tutti gli elementi figlio di questa esecuzione.

Attributi

hyperdrive_config

Restituisce la configurazione di esecuzione dell'hyperdrive.

Restituisce

Tipo	Descrizione
HyperDriveConfig	Configurazione di esecuzione dell'hyperdrive.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'