careamics 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

careamics/config/references/algorithm_descriptions.py

@@ -0,0 +1,132 @@
+"""Descriptions of the algorithms used in CAREmics."""
+
+from pydantic import BaseModel
+
+CUSTOM = "Custom"
+N2V = "Noise2Void"
+N2V2 = "N2V2"
+STRUCT_N2V = "StructN2V"
+STRUCT_N2V2 = "StructN2V2"
+N2N = "Noise2Noise"
+CARE = "CARE"
+
+
+N2V_DESCRIPTION = (
+    "Noise2Void is a UNet-based self-supervised algorithm that "
+    "uses blind-spot training to denoise images. In short, in every "
+    "patches during training, random pixels are selected and their "
+    "value replaced by a neighboring pixel value. The network is then "
+    "trained to predict the original pixel value. The algorithm "
+    "relies on the continuity of the signal (neighboring pixels have "
+    "similar values) and the pixel-wise independence of the noise "
+    "(the noise in a pixel is not correlated with the noise in "
+    "neighboring pixels)."
+)
+
+
+class AlgorithmDescription(BaseModel):
+    """Description of an algorithm.
+
+    Attributes
+    ----------
+    description : str
+        Description of the algorithm.
+    """
+
+    description: str
+
+
+class N2VDescription(AlgorithmDescription):
+    """Description of Noise2Void.
+
+    Attributes
+    ----------
+    description : str
+        Description of Noise2Void.
+    """
+
+    description: str = N2V_DESCRIPTION
+
+
+class N2V2Description(AlgorithmDescription):
+    """Description of N2V2.
+
+    Attributes
+    ----------
+    description : str
+        Description of N2V2.
+    """
+
+    description: str = (
+        "N2V2 is a variant of Noise2Void. "
+        + N2V_DESCRIPTION
+        + "\nN2V2 introduces blur-pool layers and removed skip "
+        "connections in the UNet architecture to remove checkboard "
+        "artefacts, a common artefacts ocurring in Noise2Void."
+    )
+
+
+class StructN2VDescription(AlgorithmDescription):
+    """Description of StructN2V.
+
+    Attributes
+    ----------
+    description : str
+        Description of StructN2V.
+    """
+
+    description: str = (
+        "StructN2V is a variant of Noise2Void. "
+        + N2V_DESCRIPTION
+        + "\nStructN2V uses a linear mask (horizontal or vertical) to replace "
+        "the pixel values of neighbors of the masked pixels by a random "
+        "value. Such masking allows removing 1D structured noise from the "
+        "the images, the main failure case of the original N2V."
+    )
+
+
+class StructN2V2Description(AlgorithmDescription):
+    """Description of StructN2V2.
+
+    Attributes
+    ----------
+    description : str
+        Description of StructN2V2.
+    """
+
+    description: str = (
+        "StructN2V2 is a a variant of Noise2Void that uses both "
+        "structN2V and N2V2. "
+        + N2V_DESCRIPTION
+        + "\nStructN2V2 uses a linear mask (horizontal or vertical) to replace "
+        "the pixel values of neighbors of the masked pixels by a random "
+        "value. Such masking allows removing 1D structured noise from the "
+        "the images, the main failure case of the original N2V."
+        "\nN2V2 introduces blur-pool layers and removed skip connections in "
+        "the UNet architecture to remove checkboard artefacts, a common "
+        "artefacts ocurring in Noise2Void."
+    )
+
+
+class N2NDescription(AlgorithmDescription):
+    """Description of Noise2Noise.
+
+    Attributes
+    ----------
+    description : str
+        Description of Noise2Noise.
+    """
+
+    description: str = "Noise2Noise"  # TODO
+
+
+class CAREDescription(AlgorithmDescription):
+    """Description of CARE.
+
+    Attributes
+    ----------
+    description : str
+        Description of CARE.
+    """
+
+    description: str = "CARE"  # TODO

careamics/config/references/references.py

@@ -0,0 +1,39 @@
+"""References for the CAREamics algorithms."""
+
+from bioimageio.spec.generic.v0_3 import CiteEntry
+
+N2VRef = CiteEntry(
+    text='Krull, A., Buchholz, T.O. and Jug, F., 2019. "Noise2Void - Learning '
+    'denoising from single noisy images". In Proceedings of the IEEE/CVF '
+    "conference on computer vision and pattern recognition (pp. 2129-2137).",
+    doi="10.1109/cvpr.2019.00223",
+)
+
+N2V2Ref = CiteEntry(
+    text="Höck, E., Buchholz, T.O., Brachmann, A., Jug, F. and Freytag, A., "
+    '2022. "N2V2 - Fixing Noise2Void checkerboard artifacts with modified '
+    'sampling strategies and a tweaked network architecture". In European '
+    "Conference on Computer Vision (pp. 503-518).",
+    doi="10.1007/978-3-031-25069-9_33",
+)
+
+StructN2VRef = CiteEntry(
+    text="Broaddus, C., Krull, A., Weigert, M., Schmidt, U. and Myers, G., 2020."
+    '"Removing structured noise with self-supervised blind-spot '
+    'networks". In 2020 IEEE 17th International Symposium on Biomedical '
+    "Imaging (ISBI) (pp. 159-163).",
+    doi="10.1109/isbi45749.2020.9098336",
+)
+
+N2NRef = CiteEntry(
+    text="Lehtinen, J., Munkberg, J., Hasselgren, J., Laine, S., Karras, T., "
+    'Aittala, M. and Aila, T., 2018. "Noise2Noise: Learning image restoration '
+    'without clean data". arXiv preprint arXiv:1803.04189.',
+    doi="10.48550/arXiv.1803.04189",
+)
+
+CARERef = CiteEntry(
+    text='Weigert, Martin, et al. "Content-aware image restoration: pushing the '
+    'limits of fluorescence microscopy." Nature methods 15.12 (2018): 1090-1097.',
+    doi="10.1038/s41592-018-0216-7",
+)

careamics/config/support/__init__.py

@@ -0,0 +1,31 @@
+"""Supported configuration options.
+
+Used throughout the code to ensure consistency. These should be kept in sync with the
+corresponding configuration options in the Pydantic models.
+"""
+
+__all__ = [
+    "SupportedArchitecture",
+    "SupportedActivation",
+    "SupportedOptimizer",
+    "SupportedScheduler",
+    "SupportedLoss",
+    "SupportedAlgorithm",
+    "SupportedPixelManipulation",
+    "SupportedTransform",
+    "SupportedData",
+    "SupportedStructAxis",
+    "SupportedLogger",
+]
+
+
+from .supported_activations import SupportedActivation
+from .supported_algorithms import SupportedAlgorithm
+from .supported_architectures import SupportedArchitecture
+from .supported_data import SupportedData
+from .supported_loggers import SupportedLogger
+from .supported_losses import SupportedLoss
+from .supported_optimizers import SupportedOptimizer, SupportedScheduler
+from .supported_pixel_manipulations import SupportedPixelManipulation
+from .supported_struct_axis import SupportedStructAxis
+from .supported_transforms import SupportedTransform

careamics/config/support/supported_activations.py

@@ -0,0 +1,27 @@
+"""Activations supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+class SupportedActivation(str, BaseEnum):
+    """Supported activation functions.
+
+    - None, no activation will be used.
+    - Sigmoid
+    - Softmax
+    - Tanh
+    - ReLU
+    - LeakyReLU
+
+    All activations are defined in PyTorch.
+
+    See: https://pytorch.org/docs/stable/nn.html#loss-functions
+    """
+
+    NONE = "None"
+    SIGMOID = "Sigmoid"
+    SOFTMAX = "Softmax"
+    TANH = "Tanh"
+    RELU = "ReLU"
+    LEAKYRELU = "LeakyReLU"
+    ELU = "ELU"

careamics/config/support/supported_algorithms.py

@@ -0,0 +1,33 @@
+"""Algorithms supported by CAREamics."""
+
+from __future__ import annotations
+
+from careamics.utils import BaseEnum
+
+
+class SupportedAlgorithm(str, BaseEnum):
+    """Algorithms available in CAREamics."""
+
+    N2V = "n2v"
+    """Noise2Void algorithm, a self-supervised approach based on blind denoising."""
+
+    CARE = "care"
+    """Content-aware image restoration, a supervised algorithm used for a variety
+    of tasks."""
+
+    N2N = "n2n"
+    """Noise2Noise algorithm, a self-supervised denoising scheme based on comparing
+    noisy images of the same sample."""
+
+    MUSPLIT = "musplit"
+    """An image splitting approach based on ladder VAE architectures."""
+
+    DENOISPLIT = "denoisplit"
+    """An image splitting and denoising approach based on ladder VAE architectures."""
+
+    CUSTOM = "custom"
+    """Custom algorithm, used for cases where a custom architecture is provided."""
+
+    # PN2V = "pn2v"
+    # HDN = "hdn"
+    # SEG = "segmentation"

careamics/config/support/supported_architectures.py

@@ -0,0 +1,17 @@
+"""Architectures supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+class SupportedArchitecture(str, BaseEnum):
+    """Supported architectures."""
+
+    UNET = "UNet"
+    """UNet architecture used with N2V, CARE and Noise2Noise."""
+
+    LVAE = "LVAE"
+    """Ladder Variational Autoencoder used for muSplit and denoiSplit."""
+
+    CUSTOM = "custom"
+    """Keyword used for custom architectures provided by users and only compatible
+    with `FCNAlgorithmConfig` configuration."""

careamics/config/support/supported_data.py

@@ -0,0 +1,109 @@
+"""Data supported by CAREamics."""
+
+from __future__ import annotations
+
+from typing import Union
+
+from careamics.utils import BaseEnum
+
+
+class SupportedData(str, BaseEnum):
+    """Supported data types.
+
+    Attributes
+    ----------
+    ARRAY : str
+        Array data.
+    TIFF : str
+        TIFF image data.
+    CUSTOM : str
+        Custom data.
+    """
+
+    ARRAY = "array"
+    TIFF = "tiff"
+    CUSTOM = "custom"
+    # ZARR = "zarr"
+
+    # TODO remove?
+    @classmethod
+    def _missing_(cls, value: object) -> str:
+        """
+        Override default behaviour for missing values.
+
+        This method is called when `value` is not found in the enum values. It converts
+        `value` to lowercase, removes "." if it is the first character and tries to
+        match it with enum values.
+
+        Parameters
+        ----------
+        value : object
+            Value to be matched with enum values.
+
+        Returns
+        -------
+        str
+            Matched enum value.
+        """
+        if isinstance(value, str):
+            lower_value = value.lower()
+
+            if lower_value.startswith("."):
+                lower_value = lower_value[1:]
+
+            # attempt to match lowercase value with enum values
+            for member in cls:
+                if member.value == lower_value:
+                    return member
+
+        # still missing
+        return super()._missing_(value)
+
+    @classmethod
+    def get_extension_pattern(cls, data_type: Union[str, SupportedData]) -> str:
+        """
+        Get Path.rglob and fnmatch compatible extension.
+
+        Parameters
+        ----------
+        data_type : SupportedData
+            Data type.
+
+        Returns
+        -------
+        str
+            Corresponding extension pattern.
+        """
+        if data_type == cls.ARRAY:
+            raise NotImplementedError(f"Data '{data_type}' is not loaded from a file.")
+        elif data_type == cls.TIFF:
+            return "*.tif*"
+        elif data_type == cls.CUSTOM:
+            return "*.*"
+        else:
+            raise ValueError(f"Data type {data_type} is not supported.")
+
+    @classmethod
+    def get_extension(cls, data_type: Union[str, SupportedData]) -> str:
+        """
+        Get file extension of corresponding data type.
+
+        Parameters
+        ----------
+        data_type : str or SupportedData
+            Data type.
+
+        Returns
+        -------
+        str
+            Corresponding extension.
+        """
+        if data_type == cls.ARRAY:
+            raise NotImplementedError(f"Data '{data_type}' is not loaded from a file.")
+        elif data_type == cls.TIFF:
+            return ".tiff"
+        elif data_type == cls.CUSTOM:
+            # TODO: improve this message
+            raise NotImplementedError("Custom extensions have to be passed elsewhere.")
+        else:
+            raise ValueError(f"Data type {data_type} is not supported.")

careamics/config/support/supported_loggers.py

@@ -0,0 +1,10 @@
+"""Logger supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+class SupportedLogger(str, BaseEnum):
+    """Available loggers."""
+
+    WANDB = "wandb"
+    TENSORBOARD = "tensorboard"

careamics/config/support/supported_losses.py

@@ -0,0 +1,29 @@
+"""Losses supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+# TODO register loss with custom_loss decorator?
+class SupportedLoss(str, BaseEnum):
+    """Supported losses.
+
+    Attributes
+    ----------
+    MSE : str
+        Mean Squared Error loss.
+    MAE : str
+        Mean Absolute Error loss.
+    N2V : str
+        Noise2Void loss.
+    """
+
+    MSE = "mse"
+    MAE = "mae"
+    N2V = "n2v"
+    # PN2V = "pn2v"
+    # HDN = "hdn"
+    MUSPLIT = "musplit"
+    DENOISPLIT = "denoisplit"
+    DENOISPLIT_MUSPLIT = "denoisplit_musplit"
+    # CE = "ce"
+    # DICE = "dice"

careamics/config/support/supported_optimizers.py

@@ -0,0 +1,57 @@
+"""Optimizers and schedulers supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+class SupportedOptimizer(str, BaseEnum):
+    """Supported optimizers.
+
+    Attributes
+    ----------
+    Adam : str
+        Adam optimizer.
+    SGD : str
+        Stochastic Gradient Descent optimizer.
+    """
+
+    # ASGD = "ASGD"
+    # Adadelta = "Adadelta"
+    # Adagrad = "Adagrad"
+    ADAM = "Adam"
+    # AdamW = "AdamW"
+    # Adamax = "Adamax"
+    # LBFGS = "LBFGS"
+    # NAdam = "NAdam"
+    # RAdam = "RAdam"
+    # RMSprop = "RMSprop"
+    # Rprop = "Rprop"
+    SGD = "SGD"
+    # SparseAdam = "SparseAdam"
+
+
+class SupportedScheduler(str, BaseEnum):
+    """Supported schedulers.
+
+    Attributes
+    ----------
+    ReduceLROnPlateau : str
+        Reduce learning rate on plateau.
+    StepLR : str
+        Step learning rate.
+    """
+
+    # ChainedScheduler = "ChainedScheduler"
+    # ConstantLR = "ConstantLR"
+    # CosineAnnealingLR = "CosineAnnealingLR"
+    # CosineAnnealingWarmRestarts = "CosineAnnealingWarmRestarts"
+    # CyclicLR = "CyclicLR"
+    # ExponentialLR = "ExponentialLR"
+    # LambdaLR = "LambdaLR"
+    # LinearLR = "LinearLR"
+    # MultiStepLR = "MultiStepLR"
+    # MultiplicativeLR = "MultiplicativeLR"
+    # OneCycleLR = "OneCycleLR"
+    # PolynomialLR = "PolynomialLR"
+    REDUCE_LR_ON_PLATEAU = "ReduceLROnPlateau"
+    # SequentialLR = "SequentialLR"
+    STEP_LR = "StepLR"

careamics/config/support/supported_pixel_manipulations.py

@@ -0,0 +1,15 @@
+"""Pixel manipulation methods supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+class SupportedPixelManipulation(str, BaseEnum):
+    """Supported Noise2Void pixel manipulations.
+
+    - Uniform: Replace masked pixel value by a (uniformly) randomly selected neighbor
+        pixel value.
+    - Median: Replace masked pixel value by the mean of the neighborhood.
+    """
+
+    UNIFORM = "uniform"
+    MEDIAN = "median"

careamics/config/support/supported_struct_axis.py

@@ -0,0 +1,21 @@
+"""StructN2V axes supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+class SupportedStructAxis(str, BaseEnum):
+    """Supported structN2V mask axes.
+
+    Attributes
+    ----------
+    HORIZONTAL : str
+        Horizontal axis.
+    VERTICAL : str
+        Vertical axis.
+    NONE : str
+        No axis, the mask is not applied.
+    """
+
+    HORIZONTAL = "horizontal"
+    VERTICAL = "vertical"
+    NONE = "none"

careamics/config/support/supported_transforms.py

@@ -0,0 +1,11 @@
+"""Transforms supported by CAREamics."""
+
+from careamics.utils import BaseEnum
+
+
+class SupportedTransform(str, BaseEnum):
+    """Transforms officially supported by CAREamics."""
+
+    XY_FLIP = "XYFlip"
+    XY_RANDOM_ROTATE90 = "XYRandomRotate90"
+    N2V_MANIPULATE = "N2VManipulate"

careamics/config/tile_information.py

@@ -0,0 +1,65 @@
+"""Pydantic model representing the metadata of a prediction tile."""
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from annotated_types import Len
+from pydantic import BaseModel, ConfigDict
+
+DimTuple = Annotated[tuple, Len(min_length=3, max_length=4)]
+
+
+class TileInformation(BaseModel):
+    """
+    Pydantic model containing tile information.
+
+    This model is used to represent the information required to stitch back a tile into
+    a larger image. It is used throughout the prediction pipeline of CAREamics.
+
+    Array shape should be C(Z)YX, where Z is an optional dimensions.
+    """
+
+    model_config = ConfigDict(validate_default=True)
+
+    array_shape: DimTuple  # TODO: find a way to add custom error message?
+    """Shape of the original (untiled) array."""
+
+    last_tile: bool = False
+    """Whether this tile is the last one of the array."""
+
+    overlap_crop_coords: tuple[tuple[int, ...], ...]
+    """Inner coordinates of the tile where to crop the prediction in order to stitch
+    it back into the original image."""
+
+    stitch_coords: tuple[tuple[int, ...], ...]
+    """Coordinates in the original image where to stitch the cropped tile back."""
+
+    sample_id: int
+    """Sample ID of the tile."""
+
+    # TODO: Test that ZYX axes are not singleton ?
+
+    def __eq__(self, other_tile: object):
+        """Check if two tile information objects are equal.
+
+        Parameters
+        ----------
+        other_tile : object
+            Tile information object to compare with.
+
+        Returns
+        -------
+        bool
+            Whether the two tile information objects are equal.
+        """
+        if not isinstance(other_tile, TileInformation):
+            return NotImplemented
+
+        return (
+            self.array_shape == other_tile.array_shape
+            and self.last_tile == other_tile.last_tile
+            and self.overlap_crop_coords == other_tile.overlap_crop_coords
+            and self.stitch_coords == other_tile.stitch_coords
+            and self.sample_id == other_tile.sample_id
+        )

careamics/config/training_model.py

@@ -0,0 +1,72 @@
+"""Training configuration."""
+
+from __future__ import annotations
+
+from pprint import pformat
+from typing import Literal, Optional
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+)
+
+from .callback_model import CheckpointModel, EarlyStoppingModel
+
+
+class TrainingConfig(BaseModel):
+    """
+    Parameters related to the training.
+
+    Mandatory parameters are:
+        - num_epochs: number of epochs, greater than 0.
+        - batch_size: batch size, greater than 0.
+        - augmentation: whether to use data augmentation or not (True or False).
+
+    Attributes
+    ----------
+    num_epochs : int
+        Number of epochs, greater than 0.
+    """
+
+    # Pydantic class configuration
+    model_config = ConfigDict(
+        validate_assignment=True,
+    )
+
+    num_epochs: int = Field(default=20, ge=1)
+    """Number of epochs, greater than 0."""
+
+    logger: Optional[Literal["wandb", "tensorboard"]] = None
+    """Logger to use during training. If None, no logger will be used. Available
+    loggers are defined in SupportedLogger."""
+
+    checkpoint_callback: CheckpointModel = CheckpointModel()
+    """Checkpoint callback configuration, following PyTorch Lightning Checkpoint
+    callback."""
+
+    early_stopping_callback: Optional[EarlyStoppingModel] = Field(
+        default=None, validate_default=True
+    )
+    """Early stopping callback configuration, following PyTorch Lightning Checkpoint
+    callback."""
+
+    def __str__(self) -> str:
+        """Pretty string reprensenting the configuration.
+
+        Returns
+        -------
+        str
+            Pretty string.
+        """
+        return pformat(self.model_dump())
+
+    def has_logger(self) -> bool:
+        """Check if the logger is defined.
+
+        Returns
+        -------
+        bool
+            Whether the logger is defined or not.
+        """
+        return self.logger is not None