HyperDriveRun Classe

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

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

Initialiser une exécution HyperDrive.

Héritage

Run

HyperDriveRun

Constructeur

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

Paramètres

Nom	Description
experiment Obligatoire	Experiment Expérience de l’exécution HyperDrive.
run_id Obligatoire	str ID de l’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 HyperDrive.
run_id Obligatoire	str ID d’exécution HyperDrive.
hyperdrive_config Obligatoire	HyperDriveConfig Configuration de cette exécution HyperDrive. Si aucun, nous partons du principe que l’exécution existe déjà et essaiera de s’hydrater à partir du cloud.

Méthodes

cancel	Retourner la valeur True si l’exécution HyperDrive a été annulée.
fail	Ne pas utiliser. La méthode Fail 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 à la meilleure exécution parmi toutes les exécutions enfants. La meilleure exécution est identifiée uniquement en fonction du paramètre de métrique principale spécifié dans HyperDriveConfig. PrimaryMetricGoal détermine si la valeur minimale ou maximale de la métrique principale est utilisée. Pour effectuer une analyse plus détaillée de toutes les métriques ExperimentRun lancées par ce 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 meilleure métrique.
get_children_sorted_by_primary_metric	Retourner une liste d’enfants triés selon leur meilleure métrique principale. Le tri est effectué en fonction de la métrique principale et de son objectif : s’il faut agrandir, alors les enfants sont retournés dans l’ordre décroissant de leur meilleure métrique principale. Si l’option Inverser a la valeur True, l’ordre est inversé. Chaque enfant dans le résultat a l’ID d’exécution, les hyperparamètres, la meilleure valeur de métrique principale et l’état. 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 Inverser n’a aucun impact sur ces derniers.
get_diagnostics	Ne pas utiliser. La méthode get_diagnostics n’est pas prise en charge pour la sous-classe HyperDriveRun.
get_hyperparameters	Retourner les hyperparamètres de toutes les exécutions enfants qui ont été lancées par cet HyperDriveRun.
get_metrics	Retourner les métriques de toutes les exécutions qui ont été lancées par cet HyperDriveRun.

cancel

Retourner la valeur True si l’exécution HyperDrive a été annulée.

cancel()

Retours

Type	Description
bool	Indique si l’exécution a été annulée.

fail

Ne pas utiliser. La méthode Fail 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 à la meilleure exécution parmi toutes les exécutions enfants.

La meilleure exécution est identifiée uniquement en fonction du paramètre de métrique principale spécifié dans HyperDriveConfig. PrimaryMetricGoal détermine si la valeur minimale ou maximale de la métrique principale est utilisée. Pour effectuer une analyse plus détaillée de toutes les métriques ExperimentRun lancées par ce 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 meilleure 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 les exécutions resume_from héritées. Valeur par défaut: True

Retours

Type	Description
Run	La meilleure exécution, ou None si aucun enfant n’a la métrique principale.

get_children_sorted_by_primary_metric

Retourner une liste d’enfants triés selon leur meilleure métrique principale.

Le tri est effectué en fonction de la métrique principale et de son objectif : s’il faut agrandir, alors les enfants sont retournés dans l’ordre décroissant de leur meilleure métrique principale. Si l’option Inverser a la valeur True, l’ordre est inversé.

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

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 Inverser n’a aucun impact sur ces derniers.

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

Paramètres

Nom	Description
top	int Nombre d’enfants supérieurs à retourner. Si la valeur est 0, tous les enfants sont retournés. Valeur par défaut: 0
reverse	bool Si la valeur est True, l’ordre est inversé. Cela n’affecte que les enfants avec la métrique principale. Valeur par défaut: False
discard_no_metric	bool Si la valeur est False, les enfants sans la 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

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

get_diagnostics()

Exceptions

Type	Description
HyperDriveNotImplementedException

get_hyperparameters

Retourner les hyperparamètres de toutes les exécutions enfants qui ont été 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 comme clé.

get_metrics

Retourner les métriques de toutes les exécutions qui ont été lancées par cet HyperDriveRun.

get_metrics()

Retours

Type	Description
dict	Les métriques de tous les enfants de cette exécution.

Attributs

hyperdrive_config

Retourner la configuration de l’exécution HyperDrive.

Retours

Type	Description
HyperDriveConfig	Configuration de l’exécution HyperDrive.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'