OmegaConf 2.3
Stable documentation: these pages describe OmegaConf 2.3.1. You can also preview the 2.4 documentation.
OmegaConf turns Python data, YAML, and overrides into a consistent configuration API. This is a small prototype of a rebuilt documentation site.
Start here
- Install OmegaConf gets the stable release 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, Enums, 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.