Skip to main content
Version: 2.4 (prerelease)

OmegaConf 2.4 prerelease

Prerelease documentation: these pages describe OmegaConf 2.4. The stable 2.3 documentation remains the default.

OmegaConf turns Python data, YAML, and overrides into a consistent configuration API. The 2.4 documentation is being rebuilt here as a small prototype.

Start here​

Explore the main capabilities​

  1. Work with configs: learn containers, mandatory missing values, merging, and serialization.
  2. Interpolation and resolvers: start with node and string interpolation, then resolver interpolation.
  3. Structured configs: declare typed fields, learn field types, then optional fields and validation.

Each section also contains task pages you can use as needed. For exact signatures and options, use the Python API and its generated symbol details.