Skip to content

Microsplit Algorithm Config

Source

MicroSplit algorithm configuration.

MicroSplitAlgorithm

Bases: VAEBasedAlgorithm

MicroSplit algorithm configuration.

optimizer = OptimizerConfig() class-attribute instance-attribute

Optimizer to use, defined in SupportedOptimizer.

algorithm_cross_validation()

Validate the algorithm model based on algorithm.

Returns:

Type Description
Self

The validated model.

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.

output_channels_validation()

Validate the consistency between number of out channels and noise models.

Returns:

Type Description
Self

The validated model.

predict_logvar_validation()

Validate the consistency of predict_logvar throughout the model.

Returns:

Type Description
Self

The validated model.