Partager via

HyperDriveRun Classe

HyperDriveRun contient les détails d’une expérience HyperDrive soumise.

Cette classe peut être utilisée pour gérer, vérifier l’état et récupérer les détails de l’exécution d’HyperDrive et de chacune des exécutions enfants générées.

Initialiser une exécution HyperDrive.

Constructeur

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

Paramètres

Nom Description
experiment
Obligatoire
Experiment

Expérience de l’exécution d’HyperDrive.
run_id
Obligatoire
str

ID d’exécution HyperDrive.
hyperdrive_config
HyperDriveConfig

Configuration de cette exécution HyperDrive.

Valeur par défaut: None
experiment
Obligatoire
Experiment

Expérience de l’exécution d’HyperDrive.
run_id
Obligatoire
str

ID d’exécution HyperDrive.
hyperdrive_config
Obligatoire
HyperDriveConfig

Configuration de cette exécution HyperDrive. Si ce n’est pas le cas, nous partons du principe que l’exécution existe déjà et essaiera d’hydrater à partir du cloud.

Méthodes

cancel

Retourne la valeur True si l’exécution HyperDrive a été annulée avec succès.
fail

N’utilisez pas. La méthode d’échec n’est pas prise en charge pour la sous-classe HyperDriveRun.
get_best_run_by_primary_metric

Recherchez et retournez l’instance d’exécution qui correspond à l’exécution la plus performante parmi toutes les exécutions enfants.

L’exécution la plus performante est identifiée uniquement en fonction du paramètre de métrique principal spécifié dans HyperDriveConfig. PrimaryMetricGoal détermine si la mesure minimale ou maximale de la métrique primaire est utilisée. Pour effectuer une analyse plus détaillée de toutes les métriques ExperimentRun lancées par cet HyperDriveRun, utilisez get_metrics. Une seule des exécutions est retournée, même si plusieurs des exécutions lancées par cette exécution HyperDrive ont atteint la même métrique.
get_children_sorted_by_primary_metric

Retournez une liste d’enfants triés par leur meilleure métrique principale.

Le tri est effectué en fonction de la métrique principale et de son objectif : s’il est agrandi, les enfants sont retournés dans l’ordre décroissant de leur meilleure métrique primaire. Si l’inverse est True, l’ordre est inversé.

Chaque enfant du résultat a l’ID d’exécution, les hyperparamètres, la meilleure valeur et l’état de la métrique principale.

Les enfants sans métrique principale sont ignorés lorsque discard_no_metric a la valeur True. Sinon, ils sont ajoutés à la liste derrière d’autres enfants avec la métrique principale. Notez que l’option inverse n’a aucun impact sur eux.
get_diagnostics

N’utilisez pas. La méthode get_diagnostics n’est pas prise en charge pour la sous-classe HyperDriveRun.
get_hyperparameters

Retournez les hyperparamètres pour toutes les exécutions enfants lancées par cet HyperDriveRun.
get_metrics

Retournez les métriques de toutes les exécutions lancées par cet HyperDriveRun.

cancel

Retourne la valeur True si l’exécution HyperDrive a été annulée avec succès.

cancel()

Retours

Type Description
bool

Indique si l’exécution a été annulée avec succès ou non.

fail

N’utilisez pas. La méthode d’échec n’est pas prise en charge pour la sous-classe HyperDriveRun.

fail()

Exceptions

Type Description
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Recherchez et retournez l’instance d’exécution qui correspond à l’exécution la plus performante parmi toutes les exécutions enfants.

L’exécution la plus performante est identifiée uniquement en fonction du paramètre de métrique principal spécifié dans HyperDriveConfig. PrimaryMetricGoal détermine si la mesure minimale ou maximale de la métrique primaire est utilisée. Pour effectuer une analyse plus détaillée de toutes les métriques ExperimentRun lancées par cet HyperDriveRun, utilisez get_metrics. Une seule des exécutions est retournée, même si plusieurs des exécutions lancées par cette exécution HyperDrive ont atteint la même métrique.

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

Paramètres

Nom Description
include_failed
bool

Indique s’il faut inclure les exécutions ayant échoué.

Valeur par défaut: True
include_canceled
bool

Indique s’il faut inclure les exécutions annulées.

Valeur par défaut: True
include_resume_from_runs
bool

Indique s’il faut inclure des exécutions resume_from héritées.

Valeur par défaut: True

Retours

Type Description
Run

Meilleure exécution, ou Aucun si aucun enfant n’a la métrique principale.

get_children_sorted_by_primary_metric

Retournez une liste d’enfants triés par leur meilleure métrique principale.

Le tri est effectué en fonction de la métrique principale et de son objectif : s’il est agrandi, les enfants sont retournés dans l’ordre décroissant de leur meilleure métrique primaire. Si l’inverse est True, l’ordre est inversé.

Chaque enfant du résultat a l’ID d’exécution, les hyperparamètres, la meilleure valeur et l’état de la métrique principale.

Les enfants sans métrique principale sont ignorés lorsque discard_no_metric a la valeur True. Sinon, ils sont ajoutés à la liste derrière d’autres enfants avec la métrique principale. Notez que l’option inverse n’a aucun impact sur eux.

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

Paramètres

Nom Description
top
int

Nombre d’enfants principaux à retourner. S’il s’agit de 0, tous les enfants seront retournés.

Valeur par défaut: 0
reverse
bool

Si la valeur est True, l’ordre sera inversé. Elle affecte uniquement les enfants ayant une métrique principale.

Valeur par défaut: False
discard_no_metric
bool

S’il s’agit de False, les enfants sans métrique principale sont ajoutés à la liste.

Valeur par défaut: False

Retours

Type Description
list

Liste des dictionnaires avec l’ID d’exécution, les hyperparamètres, la meilleure métrique principale et l’état

get_diagnostics

N’utilisez pas. La méthode get_diagnostics n’est pas prise en charge pour la sous-classe HyperDriveRun.

get_diagnostics()

Exceptions

Type Description
HyperDriveNotImplementedException

get_hyperparameters

Retournez les hyperparamètres pour toutes les exécutions enfants lancées par cet HyperDriveRun.

get_hyperparameters()

Retours

Type Description
dict

Hyperparamètres pour toutes les exécutions enfants. Il s’agit d’un dictionnaire avec run_id en tant que clé.

get_metrics

Retournez les métriques de toutes les exécutions lancées par cet HyperDriveRun.

get_metrics()

Retours

Type Description
dict

Métriques pour tous les enfants de cette exécution.

Attributs

hyperdrive_config

Retournez la configuration d’exécution hyperdrive.

Retours

Type Description
HyperDriveConfig

Configuration d’exécution hyperdrive.

HYPER_DRIVE_RUN_USER_AGENT 

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE 

RUN_TYPE = 'hyperdrive'