Hyperparameters

Functions to handle the definition and manipulation of hyperparameters

metatrain.utils.hypers.get_hypers_list(hypers_cls: Type[HypersType]) → list[str]

Get the list of hyperparameter names defined in a TypedDict hypers class.

Inheritance of parameters is allowed from parent classes, but make sure that the parent classes only contain hyperparameters as attributes! (i.e., no methods allowed). Private attributes (starting with “_”) are not considered as hyperparameters, so one can have arbitrary private methods or attributes in the class and its parents, although this is not recommended.

Parameters:

hypers_cls (Type[HypersType]) – The class defining the hyperparameters.

Returns:

A list with the names of the hyperparameters.

Return type:

list[str]

metatrain.utils.hypers.init_with_defaults(hypers_cls: Type[HypersType]) → dict

Initialize a TypedDict hypers class with its default values.

Inheritance of parameters is allowed from parent classes, but make sure that the parent classes only contain hyperparameters as attributes! (i.e., no methods allowed). Private attributes (starting with “_”) are not considered as hyperparameters, so one can have arbitrary private methods or attributes in the class and its parents, although this is not recommended.

Parameters:

hypers_cls (Type[HypersType]) – The class defining the hyperparameters.

Returns:

A dict with the default hyperparameters.

Return type:

dict

metatrain.utils.hypers.overwrite_defaults(hypers_cls: Type, new_defaults: dict) → None

Overwrite the default hyperparameters.

This function does not check that the new defaults correspond to valid hyperparameters of the given hypers class. If the new defaults contain keys that are not hyperparameters of the class, they will simply be ignored.

Parameters:

• hypers_cls (Type) – The hypers class whose defaults to overwrite.

• new_defaults (dict) – A dict with the new default hyperparameters.

Return type:

None

metatrain.utils.hypers.get_hypers_diff(old_hypers: Mapping[str, Any], new_hypers: Mapping[str, Any], default_hypers: Mapping[str, Any] | None = None) → dict[str, tuple[Any, Any]]

Get the difference between two hypers dictionaries.

Parameters:

• old_hypers (Mapping[str, Any]) – The old hyperparameters.

• new_hypers (Mapping[str, Any]) – The new hyperparameters.

• default_hypers (Mapping[str, Any] | None) – Default hyperparameters. If provided, they will be used to fill the missing keys in values of the new hypers that are dicts.

Returns:

A dict with the hyperparameters that are different in the new hypers compared to the old hypers. It is assumed that every key in the new hypers is also present in the old hypers.

Return type:

dict[str, tuple[Any, Any]]

metatrain.utils.hypers.raise_hypers_mismatch(hypers_diff: Mapping[str, tuple[Any, Any]]) → None

Raise an error if the hypers diff is not empty.

The error shows a report of the mismatched hyperparameters.

Parameters:

hypers_diff (Mapping[str, tuple[Any, Any]]) – A dict with the hyperparameters that are different. It can be computed using get_hypers_diff().

Return type:

None

metatrain.utils.hypers.raise_if_hypers_mismatch(old_hypers: Mapping[str, Any], new_hypers: Mapping[str, Any], default_hypers: Mapping[str, Any] | None = None) → None

Raise an error if the new hypers do not match the old hypers.

Parameters:

• old_hypers (Mapping[str, Any]) – The old hyperparameters.

• new_hypers (Mapping[str, Any]) – The new hyperparameters.

• default_hypers (Mapping[str, Any] | None) – Default hyperparameters. If provided, they will be used to fill the missing keys in values of the new hypers that are dicts.

Return type:

None