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}
  • Debugger integration
  • Custom resolvers
  • Built-in resolvers
    • oc.env
    • oc.create
    • oc.deprecated
    • oc.decode
    • oc.select
    • oc.dict.{keys,value}
  • Structured config
    • Simple types
    • Static type checker support
    • Runtime type validation and conversion
    • Nesting structured configs
  • Containers
    • Lists
    • Dictionaries
  • Misc
    • Mandatory missing values
    • Optional fields
    • Interpolations
    • Frozen
  • Merging with other configs

Indices and tables¶

  • Index
  • Module Index
  • Search Page

OmegaConf

Navigation

  • Installation
  • Creating
  • Access and manipulation
  • Serialization
  • Variable interpolation
  • Merging configurations
  • Configuration flags
  • Utility functions
  • Debugger integration
  • Custom resolvers
  • Built-in resolvers
  • Structured config
  • Containers
  • Misc
  • Merging with other configs

Related Topics

  • Documentation overview
    • Next: Installation

Quick search

©2022 Omry Yadan. | Powered by Sphinx 1.8.6 & Alabaster 0.7.12 | Page source