multigeom.config#

Configuration: loading YAML files, the default configurations shipped with the package, and the paths of a project.

The default configurations (`multigeom/configs/*.yaml`) are package data, so they are
found wherever the package is installed: `load_config("estimator")` loads
`estimator.yaml` of the package, and `load_config("path/to/my.yaml")` loads a file of
your own. They are

    estimator   settings of the G(x) estimator (samples, timesteps, sigma, seed)
    diffusion   the conditional diffusion model and its training recipe
    inception, resnet50, onoff
                the reference encoders and the training of their readouts

Functions

config_path(name_or_path)

The YAML file for a packaged config name ("estimator", "diffusion", "inception", ...) or for a path.

data_dir()

Resolve the data directory:

load_config(name_or_path)

Load a YAML config (a packaged name such as "estimator", or a file path) into a nested SimpleNamespace.

package_root()

The folder of the installed package (the one that contains this file).

project_root()

The working root of a project, where runs/ and data/ live by default: $MULTIGEOM_REPO if set, else the current directory.