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
- Install OmegaConf gets the release candidate into your Python environment.
- Your first config walks through creation, access, and merging.
Explore the main capabilities
- Work with configs: learn containers, missing values, merging, and data exchange.
- Derive values: start with node references, then resolver calls.
- Define a schema: add typed fields, learn containers, choices, and unions, 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.