Model IO
Model I/O utilities.
export_to_bmz(model, config, path_to_archive, model_name, general_description, data_description, authors, input_array, output_array, covers=None, channel_names=None, model_version='0.1.0')
Export the model to BioImage Model Zoo format.
Arrays are expected to be SC(Z)YX with singleton dimensions allowed for S and C.
model_name should consist of letters, numbers, dashes, underscores and parentheses
only.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
CAREamicsModule
|
CAREamics model to export. |
required |
config
|
Configuration
|
Model configuration. |
required |
path_to_archive
|
Union[Path, str]
|
Path to the output file. |
required |
model_name
|
str
|
Model name. |
required |
general_description
|
str
|
General description of the model. |
required |
data_description
|
str
|
Description of the data the model was trained on. |
required |
authors
|
list[dict]
|
Authors of the model. |
required |
input_array
|
ndarray
|
Input array, should not have been normalized. |
required |
output_array
|
ndarray
|
Output array, should have been denormalized. |
required |
covers
|
list of pathlib.Path or str
|
Paths to the cover images. |
None
|
channel_names
|
Optional[list[str]]
|
Channel names, by default None. |
None
|
model_version
|
str
|
Model version. |
"0.1.0"
|
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. |