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
  • 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
    • Lists
    • Dictionaries
    • Nested dict and list annotations
    • Unions
    • 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
  • API Reference
    • The OmegaConf API
    • Utility functions importable from the omegaconf module

Indices and tables¶

  • Index

  • Module Index

  • Search Page

OmegaConf

Navigation

  • Usage
  • Resolvers
  • Structured Configs
  • The OmegaConf grammar
  • How-To Guides
  • API Reference

Related Topics

  • Documentation overview
    • Next: Usage

Quick search

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