Skip to content
  • API documentation
  • careamics
  • lightning
  • dataset_ng
  • lightning_modules
  • get_module

get_module

Factory functions for lightning modules.

create_module(algorithm_config) #

Initialize the correct Lightning module from an algorithm config.

Parameters:

Name Type Description Default
algorithm_config UNetBasedAlgorithm

The pydantic model with algorithm specific parameters.

 required

Returns:

Type Description
CAREamicsModule

A lightning module for running one of the algorithms supported by CAREamics.

Raises:

Type Description
NotImplementedError

If the chosen algorithm is not yet supported.
Source code in src/careamics/lightning/dataset_ng/lightning_modules/get_module.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def create_module(algorithm_config: UNetBasedAlgorithm) -> CAREamicsModule:
    """
    Initialize the correct Lightning module from an algorithm config.

    Parameters
    ----------
    algorithm_config : UNetBasedAlgorithm
        The pydantic model with algorithm specific parameters.

    Returns
    -------
    CAREamicsModule
        A lightning module for running one of the algorithms supported by CAREamics.

    Raises
    ------
    NotImplementedError
        If the chosen algorithm is not yet supported.
    """
    if isinstance(algorithm_config, CAREAlgorithm | N2NAlgorithm):
        return CAREModule(algorithm_config)
    elif isinstance(algorithm_config, N2VAlgorithm):
        return N2VModule(algorithm_config)
    else:
        algorithm = algorithm_config.algorithm
        raise NotImplementedError(
            f"Support for {algorithm} has not been implemented yet."
        )

get_module_cls(algorithm) #

Get the lightning module class for the specified algorithm.

Parameters:

Name Type Description Default
algorithm SupportedAlgorithm

One of the algorithms supported by CAREamics, e.g. "n2v".

 required

Returns:

Type Description
CAREamicsModuleCls

A Lightning module class for running the specified algorithm.

Raises:

Type Description
NotImplementedError

If the chosen algorithm is not get supported.
Source code in src/careamics/lightning/dataset_ng/lightning_modules/get_module.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def get_module_cls(algorithm: SupportedAlgorithm) -> CAREamicsModuleCls:
    """
    Get the lightning module class for the specified `algorithm`.

    Parameters
    ----------
    algorithm : SupportedAlgorithm
        One of the algorithms supported by CAREamics, e.g. `"n2v"`.

    Returns
    -------
    CAREamicsModuleCls
        A Lightning module class for running the specified `algorithm`.

    Raises
    ------
    NotImplementedError
        If the chosen algorithm is not get supported.
    """
    match algorithm:
        case SupportedAlgorithm.CARE:
            return CAREModule
        case SupportedAlgorithm.N2V:
            return N2VModule
        case _:
            raise NotImplementedError(
                f"Support for {algorithm.value} has not been implemented yet."
            )