Skip to content

Get Module

Source

Factory functions for lightning modules.

create_module(algorithm_config)

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:

get_module_cls(algorithm)

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: