Skip to content

Save and load

Legacy documentation

This documentation is for the legacy version of CAREamics (v0.1), which is accessible through the careamics.compat module. It is kept here for reference, but we recommend using the latest version of CAREamics (v0.2) for new projects. Head to the v0.2 guides.

CAREamics configurations can be saved to the disk as .yml file and loaded easily to start similar experiments.

Save a configuration

Save a configuration
from careamics.compat.config.utils.configuration_io import save_configuration
from careamics.compat.config import create_n2v_configuration

config = create_n2v_configuration(
    experiment_name="Config_to_save",
    data_type="tiff",
    axes="ZYX",
    patch_size=(8, 64, 64),
    batch_size=8,
    num_epochs=20,
)
save_configuration(config, "config.yml")

In the resulting file, you can see all the parameters that are defaults and hidden from you.

resulting config.yml file

Load a configuration

Load a configuration
from careamics.compat.config.utils.configuration_io import load_configuration

config = load_configuration("config.yml")