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

ng_config_discriminator

Discriminator for NG configurations.

validate_ng_config(config) #

Validate a configuration dictionary as an NGConfig.

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 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def validate_ng_config(config: dict[str, Any]) -> NGConfigs:
    """
    Validate a configuration dictionary as an NGConfig.

    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)