Skip to content

Index

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.

The configuration summarizes all the parameters used internally by CAREamics. It is used to create a CAREamist instance and is saved together with the checkpoints and saved models.

Configurations are created for specific algorithms using convenience functions. They are Python objects, but can be exported to a dictionary, and contain a hierarchy of parameters.

Configuration example

Here is an example of a configuration for the Noise2Void algorithm.

Noise2Void configuration

The number of parameters might appear overwhelming, but in practice users only call a function with few parameters. The configuration is designed to hide the complexity of the algorithms and provide a simple interface to the user.

from careamics.compat.config import (
    create_care_configuration,  # CARE
    create_n2n_configuration,  # Noise2Noise
    create_n2v_configuration,  # Noise2Void
)

config = create_n2v_configuration(
    experiment_name="n2v_experiment",
    data_type="array",
    axes="YX",
    patch_size=[64, 64],
    batch_size=8,
    num_epochs=50,
)

In the next sections, you can dive deeper on how to create a configuration and interact with the configuration with different levels of expertise.

Beginner

Intermediate

Advanced