nip.base_run.get_base_wandb_run_and_new_hyper_params

nip.base_run.get_base_wandb_run_and_new_hyper_params#

nip.base_run.get_base_wandb_run_and_new_hyper_params(hyper_params: HyperParameters) → tuple[Run | None, HyperParameters][source]#

Get the base W&B run and create a new hyper-parameters object.

Depending on the base_run_type in the hyper_params, this function either returns None and the original hyper_params or the base W&B run and a new hyper-parameters object with (some of) the hyper-parameters of the base run.

Parameters:

hyper_params (HyperParameters) – The hyper-parameters of the current experiment.

Returns:

  • wandb_run (WandbRun or None) – The base W&B run object, specified by hyper_params. This is an already finished run loaded using the W&B API. If base_run_type is “none”, this is None, because we are not basing the current experiment on a previous run.

  • new_hyper_params (HyperParameters) – The new hyper-parameters object, based on the base run. If base_run_type is “none”, this is the original hyper_params object.