Skip to content

N2N Algorithm Config

Source

N2N Algorithm configuration.

N2NAlgorithm

Bases: UNetBasedAlgorithm

Noise2Noise Algorithm configuration.

algorithm = 'n2n' class-attribute instance-attribute

N2N Algorithm name.

loss = 'mae' class-attribute instance-attribute

N2N-compatible loss function.

lr_scheduler = LrSchedulerConfig() class-attribute instance-attribute

Learning rate scheduler to use, defined in SupportedLrScheduler.

model instance-attribute

UNet without a final activation function and without the n2v2 modifications.

optimizer = OptimizerConfig() class-attribute instance-attribute

Optimizer to use, defined in SupportedOptimizer.

get_algorithm_citations()

Return a list of citation entries of the current algorithm.

This is used to generate the model description for the BioImage Model Zoo.

Returns:

Type Description
List[CiteEntry]

List of citation entries.

get_algorithm_description()

Get the algorithm description.

Returns:

Type Description
str

Algorithm description.

get_algorithm_friendly_name()

Get the algorithm friendly name.

Returns:

Type Description
str

Friendly name of the algorithm.

get_algorithm_keywords()

Get algorithm keywords.

Returns:

Type Description
list[str]

List of keywords.

get_algorithm_references()

Get the algorithm references.

This is used to generate the README of the BioImage Model Zoo export.

Returns:

Type Description
str

Algorithm references.

get_compatible_algorithms() classmethod

Get the list of compatible algorithms.

Returns:

Type Description
list of str

List of compatible algorithms.

is_supervised() classmethod

Return whether the algorithm is supervised.

Returns:

Type Description
bool

Whether the algorithm is supervised.