Skip to content

Model IO Utils

Source

Utility functions to load pretrained models.

load_pretrained(path)

Load a pretrained model from a checkpoint or a BioImage Model Zoo model.

Expected formats are .ckpt or .zip files.

Parameters:

Name Type Description Default
path Union[Path, str]

Path to the pretrained model.

required

Returns:

Type Description
tuple[CAREamicsKiln, Configuration]

tuple of CAREamics model and its configuration.

Raises:

Type Description
ValueError

If the model format is not supported.