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.

• Usage
  • Installation
  • Creating
  • Access and manipulation
  • Serialization
  • Variable interpolation
  • Merging configurations
  • Configuration flags
  • Utility functions
  • Debugger integration
• Migrating tuple usage in OmegaConf 2.4
  • What changed
  • Choosing the intended sequence type
  • Checking sequence types
  • Migration checklist
• Resolvers
  • Custom resolvers
  • Built-in resolvers
  • Clearing/removing resolvers
• Structured Configs
  • Simple types
  • Static type checker support
  • Runtime type validation and conversion
  • Nesting structured configs
  • Literal types
  • Lists
  • Tuples (experimental)
  • Dictionaries
  • Nested dict and list annotations
  • Unions
  • Unions of container types
  • Other special features
  • Merging with other configs
  • Using Metadata to Ignore Fields
• The OmegaConf grammar
  • Interpolation strings
  • Interpolation types
  • Element types
  • Escaped characters
• How-To Guides
  • How to Perform Arithmetic Using eval as a Resolver
• YAML Alias Limits
  • Details
• API Reference
  • The OmegaConf API
  • Utility functions importable from the omegaconf module

Indices and tables

• Index

• Module Index

• Search Page