Skip to main content

A fork of hydra-core's configen with extended type-compatibility.

Project description

configen

Automatically generates Structured Configs that can be used with hydra.utils.instantiate()

This is optional at two levels:

  1. Structured Configs are optional, one can use Hydra without them.
  2. One can manually code these dataclasses. The advantage of this tool is that it does the work automatically.

Setup

Configen requires config file per project. The config indicates what classes to generate code for, where to put the generated code etc. Configen will suggest creating a config on the first run:

$ configen 
[2020-08-14 12:06:11,359][configen.configen][ERROR] - Use --config-dir DIR.
If you have no config dir yet use the following command to create an initial config in the `conf` dir:
        configen init_config_dir=conf
$ configen init_config_dir=conf
[2020-08-14 12:07:07,752][configen.configen][INFO] - Initializing config in 'conf'

This will generate a basic config similar to:

$ cat conf/configen.yaml 
configen:
  # output directory
  output_dir: ${hydra:runtime.cwd}/gen

  header: |
    # Generated by configen, do not edit.
    # See https://github.com/facebookresearch/hydra/tree/master/tools/configen

  # The directory of each module under output_dir
  module_dir: '{{module_path}}/conf'

  # list of modules to generate configs for
  modules:
    - name: configen.samples.user
      # for each module, a list of classes
      classes:
        - User

Configen comes with a few samples classes that are being processed by the default config. For example:

class User:
    def __init__(self, age: int, name: str):
        self.age = age
        self.name = name

Running configen with this config directory:

$ configen --config-dir conf
[2020-08-14 12:44:54,990][configen.configen][INFO] - configen.samples.user.User -> /home/omry/tmp/configen/gen/configen/samples/user/conf/User.py

Will result in a file gen/configen/samples/user/conf/User.py like:

# Generated by configen, do not edit.
# See https://github.com/facebookresearch/hydra/tree/master/tools/configen
# fmt: off
# isort:skip_file
# flake8: noqa

from dataclasses import dataclass
from typing import *

from omegaconf import MISSING


@dataclass
class UserConf:
    _target_: str = "configen.samples.user.User"
    age: int = MISSING
    name: str = MISSING

The generated code can be used by a Hydra application to instantiate the user object. See the example aplication.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neoconfigen-2.5.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

neoconfigen-2.5.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file neoconfigen-2.5.0.tar.gz.

File metadata

  • Download URL: neoconfigen-2.5.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.1 CPython/3.11.6 Linux/6.5.0-25-generic

File hashes

Hashes for neoconfigen-2.5.0.tar.gz
Algorithm Hash digest
SHA256 90b82bfa8f157279732438cec5f1580d5c034a56e846245ae6fb12b0c0f90dfa
MD5 9d5fe7697b6d085ace2a50ec1aabb3ea
BLAKE2b-256 956886eb74fd22ebc4e22bf647656918a7681a8ac71a4c55b84525eda781dd12

See more details on using hashes here.

File details

Details for the file neoconfigen-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: neoconfigen-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.1 CPython/3.11.6 Linux/6.5.0-25-generic

File hashes

Hashes for neoconfigen-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36d7b87dbfe3405a82fe3a2c3f03d2f016cc04abfed764deb98aa047991f907a
MD5 cfb9856834fb2e38ced0c49b3b57ad39
BLAKE2b-256 97b4b6e96820f66a747f8c053893a6fcb0e7fb3d3c64a7bb92f6d8fa84c34f46

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page