OmegaConf

Overview

OmegaConf is a YAML based hierarchical configuration system, with support for merging configurations from multiple sources (files, CLI argument, environment variables) providing a consistent API regardless of how the configuration was created. OmegaConf also offers runtime type safety via Structured Configs.

• Installation
• Creating
  • Empty
  • From a dictionary
  • From a list
  • From a YAML file
  • From a YAML string
  • From a dot-list
  • From command line arguments
  • From structured config
• Access and manipulation
  • Access
  • Default values
  • Mandatory values
  • Manipulation
• Serialization
  • Save/Load YAML file
  • Save/Load pickle file
• Variable interpolation
  • Config node interpolation
  • Resolvers
  • Built-in resolvers
• Merging configurations
  • OmegaConf.merge()
  • OmegaConf.unsafe_merge()
• Configuration flags
  • Read-only flag
  • Struct flag
• Utility functions
  • OmegaConf.to_container
  • OmegaConf.to_object
  • OmegaConf.resolve
  • OmegaConf.select
  • OmegaConf.update
  • OmegaConf.masked_copy
  • OmegaConf.is_missing
  • OmegaConf.is_interpolation
  • OmegaConf.{is_config, is_dict, is_list}
  • OmegaConf.missing_keys
• Debugger integration
• Custom resolvers
• Built-in resolvers
  • oc.env
  • oc.create
  • oc.deprecated
  • oc.decode
  • oc.select
  • oc.dict.{keys,value}
• Clearing/removing resolvers
  • clear_resolvers
  • clear_resolver
• Structured configs
  • Simple types
  • Static type checker support
  • Runtime type validation and conversion
  • Nesting structured configs
  • Lists
  • Dictionaries
  • Nested dict and list annotations
  • Unions
  • Other special features
  • Merging with other configs
• The OmegaConf grammar
  • Interpolation strings
  • Interpolation types
  • Element types
  • Escaped characters

Indices and tables

• Index
• Module Index
• Search Page