Skip to content
  • API documentation
  • careamics
  • config
  • ng_factories
  • ng_config_discriminator

ng_config_discriminator

Discriminator for NG configurations.

instantiate_algorithm_config(config) #

Instantiate an algorithm configuration from a configuration dictionary.

This method uses a TypeAdapter to validate the configuration and instantiate the correct algorithm configuration. Currently only compatible with UNet-based algorithms.

Parameters:

Name Type Description Default
config dict[str, Any]

Configuration dictionary to validate.

 required

Returns:

Type Description
NGAlgos

Validated configuration as one of the UNetBasedAlgorithm configurations.

Raises:

Type Description
ValueError

If the configuration is not valid.
Source code in src/careamics/config/ng_factories/ng_config_discriminator.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def instantiate_algorithm_config(config: dict[str, Any]) -> NGAlgos:
    """
    Instantiate an algorithm configuration from a configuration dictionary.

    This method uses a `TypeAdapter` to validate the configuration and instantiate the
    correct algorithm configuration. Currently only compatible with UNet-based
    algorithms.

    Parameters
    ----------
    config : dict[str, Any]
        Configuration dictionary to validate.

    Returns
    -------
    NGAlgos
        Validated configuration as one of the UNetBasedAlgorithm configurations.

    Raises
    ------
    ValueError
        If the configuration is not valid.
    """
    adapter: TypeAdapter[NGAlgos] = TypeAdapter(NGAlgos)
    return adapter.validate_python(config)

instantiate_config(config) #

Instantiate a NG configuration from a configuration dictionary.

This method uses a TypeAdapter to validate the configuration and instantiate the correct NG configuration.

Parameters:

Name Type Description Default
config dict[str, Any]

Configuration dictionary to validate.

 required

Returns:

Type Description
NGConfigs

Validated configuration as an NGConfig.

Raises:

Type Description
ValueError

If the configuration is not valid.
Source code in src/careamics/config/ng_factories/ng_config_discriminator.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def instantiate_config(config: dict[str, Any]) -> NGConfigs:
    """
    Instantiate a NG configuration from a configuration dictionary.

    This method uses a `TypeAdapter` to validate the configuration and instantiate the
    correct NG configuration.

    Parameters
    ----------
    config : dict[str, Any]
        Configuration dictionary to validate.

    Returns
    -------
    NGConfigs
        Validated configuration as an NGConfig.

    Raises
    ------
    ValueError
        If the configuration is not valid.
    """
    adapter: TypeAdapter[NGConfigs] = TypeAdapter(NGConfigs)
    return adapter.validate_python(config)

instantiate_norm_config(config) #

Instantiate a NormalizationConfig from a configuration dictionary.

This method uses a TypeAdapter to validate the configuration and instantiate the correct NormalizationConfig.

Parameters:

Name Type Description Default
config dict[str, Any]

Configuration dictionary to validate.

 required

Returns:

Type Description
NormalizationConfig

Validated configuration as a NormalizationConfig.

Raises:

Type Description
ValueError

If the configuration is not valid.
Source code in src/careamics/config/ng_factories/ng_config_discriminator.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def instantiate_norm_config(config: dict[str, Any]) -> NormalizationConfig:
    """
    Instantiate a NormalizationConfig from a configuration dictionary.

    This method uses a `TypeAdapter` to validate the configuration and instantiate the
    correct NormalizationConfig.

    Parameters
    ----------
    config : dict[str, Any]
        Configuration dictionary to validate.

    Returns
    -------
    NormalizationConfig
        Validated configuration as a NormalizationConfig.

    Raises
    ------
    ValueError
        If the configuration is not valid.
    """
    adapter: TypeAdapter[NormalizationConfig] = TypeAdapter(NormalizationConfig)
    return adapter.validate_python(config)