nip.parameters.base_run.BaseRunParameters

class nip.parameters.base_run.BaseRunParameters(base_run_type: ~typing.Literal['none', 'parameters', 'rerun_tests'] = 'none', run_id: str | None = None, wandb_project: str = <factory>, wandb_entity: str = <factory>, rerun_tests_force_test_during_training_state: bool = True)

Parameters for basing the current experiment on a previous W&B run.

Parameters:

• base_run_type (BaseRunType) – How to base the current experiment on a previous W&B run.

• run_id (str, optional) – The run ID of the run to base the current experiment on. This must be provided if base_run_type is not BaseRunType.NONE.

• wandb_project (str) – The W&B project of the run to base the current experiment on. If not provided, the default project is used.

• wandb_entity (str) – The W&B entity of the run to base the current experiment on. If not provided, the default entity is used.

• rerun_tests_force_test_during_training_state – When base_run_type is set to “rerun_tests”, if True this forces the existence of a “test_during_training” state, even when it was not present during training. Older runs did not have this state, so without this option it would be impossible to redo a run testing every iteration. If test_every_iteration is not True, this option has no effect, so it’s safe to leave it as True.

• bool – When base_run_type is set to “rerun_tests”, if True this forces the existence of a “test_during_training” state, even when it was not present during training. Older runs did not have this state, so without this option it would be impossible to redo a run testing every iteration. If test_every_iteration is not True, this option has no effect, so it’s safe to leave it as True.

Methods Summary

__eq__(other)	Return self==value.
__init__([base_run_type, run_id, ...])
__post_init__()
__repr__()	Return repr(self).
_get_param_class_from_dict(param_dict)	Try to get the parameter class from a dictionary of serialised parameters.
construct_test_params()	Construct a set of basic parameters for testing.
from_dict(params_dict[, ignore_extra_keys])	Create a parameters object from a dictionary.
get(address)	Get a value from the parameters object using a dot-separated address.
to_dict()	Convert the parameters object to a dictionary.

Attributes

base_run_type
rerun_tests_force_test_during_training_state
run_id
wandb_project
wandb_entity

Methods

__eq__(other)

Return self==value.

__init__(base_run_type: ~typing.Literal['none', 'parameters', 'rerun_tests'] = 'none', run_id: str | None = None, wandb_project: str = <factory>, wandb_entity: str = <factory>, rerun_tests_force_test_during_training_state: bool = True) → None

__post_init__()

__repr__()

Return repr(self).

classmethod _get_param_class_from_dict(param_dict: dict) → type[ParameterValue] | None

Try to get the parameter class from a dictionary of serialised parameters.

Parameters:

param_dict (dict) – A dictionary of parameters, which may have come from a to_dict method. This dictionary may contain a _type key, which is used to determine the class of the parameter.

Returns:

param_class (type[ParameterValue] | None) – The class of the parameter, if it can be determined.

Raises:

ValueError – If the class specified in the dictionary is not a valid parameter class.

classmethod construct_test_params() → BaseHyperParameters

Construct a set of basic parameters for testing.

classmethod from_dict(params_dict: dict, ignore_extra_keys: bool = False) → BaseHyperParameters

Create a parameters object from a dictionary.

Parameters:

• params_dict (dict) – A dictionary of the parameters.

• ignore_extra_keys (bool, default=False) – If True, ignore keys in the dictionary that do not correspond to fields in the parameters object.

Returns:

hyper_params (BaseParameters) – The parameters object.

get(address: str) → Any

Get a value from the parameters object using a dot-separated address.

Parameters:

address (str) – The path to the value in the parameters object, separated by dots.

Returns:

value (Any) – The value at the address.

Raises:

KeyError – If the address does not exist.

to_dict() → dict

Convert the parameters object to a dictionary.

Turns enums into strings, and sub-parameters into dictionaries. Includes the is_random parameter if it exists.

Returns:

params_dict (dict) – A dictionary of the parameters.