CLI Config
latest

Contents:

  • Installation
  • Quick start
    • Use tags
  • Edge cases
  • Processing
    • Why a flat dict?
    • Processing order
    • Create basic processing
      • Processing that modify a single value
      • Pre-merge/post-merge processing that protect a property from being modified
    • Create your processing classes (Advanced)
      • Manipulate the tags
      • Merge, save or load configs in processing
      • Change processing list in processing (Still more advanced)
  • Alternative ways to create a config
    • From a python dict
    • From a yaml file without command line arguments (useful for notebooks)
    • From a config (make a copy)
    • From two dicts (or configs) to merge one into the other
    • From a list of arguments
    • From a yaml formatted string
  • Hyperparameter search with Weights&Biases
  • CLI Config API
    • cliconfig.config_routines
      • make_config()
      • load_config()
      • save_config()
      • show_config()
      • flatten_config()
      • unflatten_config()
      • update_config()
      • copy_config()
    • cliconfig.processing
      • cliconfig.processing.create
        • create_processing_value()
        • create_processing_keep_property()
      • cliconfig.processing.builtin
        • ProcessMerge
        • ProcessCopy
        • ProcessDef
        • ProcessTyping
        • ProcessSelect
        • ProcessDelete
        • ProcessNew
        • ProcessDict
        • ProcessCheckTags
        • DefaultProcessings
      • cliconfig.processing.base
        • Processing
    • cliconfig.process_routines
      • merge_flat_processing()
      • merge_flat_paths_processing()
      • save_processing()
      • load_processing()
      • end_build_processing()
    • cliconfig.dict_routines
      • merge_flat()
      • merge_flat_paths()
      • flatten()
      • unflatten()
      • clean_pre_flat()
      • save_dict()
      • load_dict()
      • show_dict()
    • cliconfig.tag_routines
      • clean_tag()
      • clean_all_tags()
      • dict_clean_tags()
      • is_tag_in()
    • cliconfig.cli_parser
      • parse_cli()
    • cliconfig.base
      • Config
  • How to contribute
  • License
CLI Config
  • CLI Config API
  • cliconfig.processing
  • Edit on GitHub
Previous Next

cliconfig.processing

  • cliconfig.processing.create
    • create_processing_value()
    • create_processing_keep_property()
  • cliconfig.processing.builtin
    • ProcessMerge
    • ProcessCopy
    • ProcessDef
    • ProcessTyping
    • ProcessSelect
    • ProcessDelete
    • ProcessNew
    • ProcessDict
    • ProcessCheckTags
    • DefaultProcessings
  • cliconfig.processing.base
    • Processing
Previous Next

© Copyright 2023, Valentin Goldite. Revision 18026525.

Built with Sphinx using a theme provided by Read the Docs.