nip.utils.checkpoints.load_run_hyper_parameters

nip.utils.checkpoints.load_run_hyper_parameters#

nip.utils.checkpoints.load_run_hyper_parameters(run_id: str, wandb_project: str, wandb_entity: str | None = None, wandb_api: Api | None = None) → HyperParameters[source]#

Load the hyper-parameters of a run from W&B, converting them as needed.

This function loads the hyper-parameters from a W&B run and converts them to be compatible with the current package version.

Parameters:

  • run_id (str) – The ID of the run to load the hyper-parameters from.

  • wandb_project (str) – The project of the wandb run.

  • wandb_entity (str, optional) – The entity of the wandb run. If not provided, the default entity will be used.

  • wandb_api (WandbApi, optional) – The wandb API instance to use. If not provided, a new instance will be created.

Returns:

hyper_params (HyperParameters) – The hyper-parameters loaded from W&B.