download_checkpoint#

download_checkpoint(run_path, alias='best')#

Download the checkpoint files from the Weights & Biases artifact marked with a given alias (default: “best”).

Parameters:
  • run_path (str) – The W&B run path in the form “entity/project/run_id”.

  • alias (Literal['best', 'latest']) – The artifact alias to download (e.g., “best”, “latest”). Defaults to “best”.

Returns:

The path to the checkpoint file (.ckpt) within the downloaded artifact. It will be stored in the .artifacts/{run_id}/{alias} directory.

Raises:

ValueError – If the run has no matching artifact or no .ckpt file is found in the artifact.

Return type:

str