{"id":16872777,"url":"https://github.com/zhiyuanchen/chanfig","last_synced_at":"2026-02-11T14:05:59.638Z","repository":{"id":45837443,"uuid":"488542508","full_name":"ZhiyuanChen/CHANfiG","owner":"ZhiyuanChen","description":"Easier Configuration","archived":false,"fork":false,"pushed_at":"2026-02-02T21:22:43.000Z","size":18759,"stargazers_count":29,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-03T10:57:42.782Z","etag":null,"topics":["config","deep-learning","dict","python","yaml"],"latest_commit_sha":null,"homepage":"https://chanfig.danling.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ZhiyuanChen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-05-04T10:21:44.000Z","updated_at":"2026-01-06T04:04:52.000Z","dependencies_parsed_at":"2023-11-07T03:15:56.293Z","dependency_job_id":"9ea31ba6-b1e6-4084-b89b-b795561ea0cd","html_url":"https://github.com/ZhiyuanChen/CHANfiG","commit_stats":{"total_commits":349,"total_committers":5,"mean_commits":69.8,"dds":0.1289398280802292,"last_synced_commit":"0a437faa4c7a77afdbadbbdf8875ac4815473b16"},"previous_names":[],"tags_count":90,"template":false,"template_full_name":null,"purl":"pkg:github/ZhiyuanChen/CHANfiG","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZhiyuanChen%2FCHANfiG","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZhiyuanChen%2FCHANfiG/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZhiyuanChen%2FCHANfiG/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZhiyuanChen%2FCHANfiG/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ZhiyuanChen","download_url":"https://codeload.github.com/ZhiyuanChen/CHANfiG/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZhiyuanChen%2FCHANfiG/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29334011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T12:42:24.625Z","status":"ssl_error","status_checked_at":"2026-02-11T12:41:23.344Z","response_time":97,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["config","deep-learning","dict","python","yaml"],"created_at":"2024-10-13T15:16:06.165Z","updated_at":"2026-02-11T14:05:59.609Z","avatar_url":"https://github.com/ZhiyuanChen.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [CHANfiG](https://chanfig.danling.org)\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/75f2ee4ba5a64458afb488615e36adcb)](https://app.codacy.com/gh/ZhiyuanChen/CHANfiG/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/75f2ee4ba5a64458afb488615e36adcb)](https://app.codacy.com/gh/ZhiyuanChen/CHANfiG/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![CodeCov](https://codecov.io/gh/ZhiyuanChen/CHANfiG/graph/badge.svg?token=G9WGWCOFQE)](https://codecov.io/gh/ZhiyuanChen/CHANfiG)\n\n[![PyPI - Version](https://img.shields.io/pypi/v/chanfig)](https://pypi.org/project/chanfig/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/chanfig)](https://pypi.org/project/chanfig/)\n[![Downloads](https://static.pepy.tech/badge/chanfig/month)](https://chanfig.danling.org)\n\n[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n\n## Introduction\n\nCHANfiG aims to make your configuration easier.\n\nThere are tons of configurable parameters in training a Machine Learning model.\nTo configure all these parameters, researchers usually need to write gigantic config files, sometimes even thousands of lines.\nMost of the configs are just replicates of the default arguments of certain functions, resulting in many unnecessary declarations.\nIt is also very hard to alter the configurations.\nOne needs to navigate and open the right configuration file, make changes, save and exit.\nThese had wasted an uncountable[^uncountable] amount of precious time ~~and are no doubt a crime~~.\nUsing [`argparse`][argparse] could relieve the burdens to some extent.\nHowever, it takes a lot of work to make it compatible with existing config files, and its lack of nesting limits its potential.\n\nCHANfiG would like to make a change.\n\nYou just type the alternations in the command line, and leave everything else to CHANfiG.\n\nCHANfiG is highly inspired by [YACS](https://github.com/rbgirshick/yacs).\nDifferent from the paradigm of YACS(\n`your code + a YACS config for experiment E (+ external dependencies + hardware + other nuisance terms ...) = reproducible experiment E`),\nThe paradigm of CHANfiG is:\n\n`your code + command line arguments (+ optional CHANfiG config + external dependencies + hardware + other nuisance terms ...) = reproducible experiment E (+ optional CHANfiG config for experiment E)`\n\n## Components\n\nA Config is basically a nested dict structure.\n\nHowever, the default Python dict is hard to manipulate.\n\nThe only way to access a dict member is through `dict['name']`, which is obviously extremely complex.\nEven worse, if the dict is nested like a config, member access could be something like `dict['parent']['children']['name']`.\n\nEnough is enough, it is time to make a change.\n\nWe need attribute-style access, and we need it now.\n`dict.name` and `dict.parent.children.name` is all you need.\n\nAlthough there have been some other works that achieve a similar functionality of attribute-style access to dict members.\nTheir Config object either uses a separate dict to store information from attribute-style access (EasyDict), which may lead to inconsistency between attribute-style access and dict-style access;\nor reuse the existing `__dict__` and redirect dict-style access (ml_collections), which may result in confliction between attributes and members of Config.\n\nTo overcome the aforementioned limitations, we inherit the Python built-in [`dict`][dict] to create [`FlatDict`][chanfig.FlatDict], [`DefaultDict`][chanfig.DefaultDict], [`NestedDict`][chanfig.NestedDict], [`Config`][chanfig.Config], and [`Registry`][chanfig.Registry].\nWe also introduce [`Variable`][chanfig.Variable] to allow sharing a value across multiple places, and [`ConfigParser`][chanfig.ConfigParser] to parse command line arguments.\n\n### FlatDict\n\n[`FlatDict`][chanfig.FlatDict] improves the default [`dict`][dict] in 3 aspects.\n\n#### Dict Operations\n\n[`FlatDict`][chanfig.FlatDict] supports variable interpolation.\nSet a member's value to another member's name wrapped in `${}`, then call [`interpolate`][chanfig.FlatDict.interpolate] method. The value of this member will be automatically replaced with the value of another member.\n\nInterpolation is lazy and placeholder-aware:\n\n```python\nfrom chanfig import FlatDict\n\nconfig = FlatDict(a=1, b=\"${a}\", c=\"${a} * 2\").interpolate()\nassert config.dict()[\"c\"] == \"${a} * 2\"          # placeholders preserved for saving\nassert config.resolved()[\"c\"] == 2               # arithmetic is safely auto-evaluated\nconfig.a += 1\nassert config.resolved()[\"b\"] == 2               # shared storage keeps aliases in sync\n```\n\nOnly basic arithmetic (`+`, `-`, `*`, `/`, `//`, `%`, `**`) is evaluated; unsupported expressions stay as strings.\n\nUse [`dict`][chanfig.FlatDict.dict] / [`yaml`][chanfig.FlatDict.yaml] to persist placeholders, and [`resolved`][chanfig.FlatDict.resolved] when you need the evaluated values in memory.\n\n[`dict`][dict] in Python is ordered since Python 3.7, but there isn't a built-in method to help you sort a [`dict`][dict]. [`FlatDict`][chanfig.FlatDict] supports [`sort`][chanfig.FlatDict.sort] to help you manage your dict.\n\n[`FlatDict`][chanfig.FlatDict] incorporates a [`merge`][chanfig.FlatDict.merge] method that allows you to merge a `Mapping`, an `Iterable`, or a path to the [`FlatDict`][chanfig.FlatDict].\nDifferent from built-in [`update`][dict.update], [`merge`][chanfig.FlatDict.merge] assign values instead of replace, which makes it work better with [`DefaultDict`][chanfig.DefaultDict].\n\nMoreover, [`FlatDict`][chanfig.FlatDict] comes with [`difference`][chanfig.FlatDict.difference] and [`intersect`][chanfig.FlatDict.intersect], which makes it very easy to compare a [`FlatDict`][chanfig.FlatDict] with other `Mapping`, `Iterable`, or a path.\n\n#### Dataclass Operations\n\n[`FlatDict`][chanfig.FlatDict] is compatible with [PEP 557](https://peps.python.org/pep-0557/), and will inspect the type annotations in subclasses and make them as members of the [`FlatDict`][chanfig.FlatDict].\nIt also features [`validate`](chanfig.FlatDict.validate) method which will be called internally to validate the type of the members.\nEven better, [`FlatDict`][chanfig.FlatDict] will automatically convert value to the type of the annotation when setting the member.\n\n#### ML Operations\n\n[`FlatDict`][chanfig.FlatDict] supports [`to`][chanfig.FlatDict.to] method similar to PyTorch Tensor.\nYou can simply convert all member values of [`FlatDict`][chanfig.FlatDict] to a certain type or pass to a device in the same way.\n\n[`FlatDict`][chanfig.FlatDict] also integrates [`cpu`][chanfig.FlatDict.cpu], [`gpu`][chanfig.FlatDict.gpu] ([`cuda`][chanfig.FlatDict.cuda]), and [`tpu`][chanfig.FlatDict.tpu] ([`xla`][chanfig.FlatDict.xla]) methods for easier access.\n\n#### IO Operations\n\n[`FlatDict`][chanfig.FlatDict] provides [`json`][chanfig.FlatDict.json], [`jsons`][chanfig.FlatDict.jsons], [`yaml`][chanfig.FlatDict.yaml] and [`yamls`][chanfig.FlatDict.yamls] methods to dump [`FlatDict`][chanfig.FlatDict] to a file or string.\nIt also provides [`from_json`][chanfig.FlatDict.from_json], [`from_jsons`][chanfig.FlatDict.from_jsons], [`from_yaml`][chanfig.FlatDict.from_yaml] and [`from_yamls`][chanfig.FlatDict.from_yamls] methods to build a [`FlatDict`][chanfig.FlatDict] from a string or file.\n\n[`FlatDict`][chanfig.FlatDict] also includes `dump` and `load` methods which determine the type by their extension and dump/load [`FlatDict`][chanfig.FlatDict] to/from a file.\n\n### DefaultDict\n\nTo facilitate the needs of default values, we incorporate [`DefaultDict`][chanfig.DefaultDict] which accepts `default_factory` and works just like a [`collections.defaultdict`][collections.defaultdict].\n\n### NestedDict\n\nSince most Configs are in a nested structure, we further propose a [`NestedDict`][chanfig.NestedDict].\n\nBased on [`DefaultDict`][chanfig.DefaultDict], [`NestedDict`][chanfig.NestedDict] provides [`all_keys`][chanfig.NestedDict.all_keys], [`all_values`][chanfig.NestedDict.all_values], and [`all_items`][chanfig.NestedDict.all_items] methods to allow iterating over the whole nested structure at once.\n\n[`NestedDict`][chanfig.NestedDict] also comes with [`apply`][chanfig.NestedDict.apply] and [`apply_`][chanfig.NestedDict.apply_] methods, which make it easier to manipulate the nested structure.\n\n### Config\n\n[`Config`][chanfig.Config] extends the functionality by supporting [`freeze`][chanfig.Config.freeze] and [`defrost`][chanfig.Config.defrost], and by adding a built-in [`ConfigParser`][chanfig.ConfigParser] to pare command line arguments.\n\nNote that [`Config`][chanfig.Config] also has `default_factory=Config()` by default for convenience.\n\n### Registry\n\n[`Registry`][chanfig.Registry] extends the [`NestedDict`][chanfig.NestedDict] and supports [`register`][chanfig.Registry.register], [`lookup`][chanfig.Registry.lookup], and [`build`][chanfig.Registry.build] to help you register constructors and build objects from a [`Config`][chanfig.Config].\n\n[`ConfigRegistry`][chanfig.ConfigRegistry] is a subclass of [`Registry`][chanfig.Registry] that is specifically designed for building objects from a [`Config`][chanfig.Config] or a [`dataclass`][dataclasses.dataclass].\nJust specify the `key` when creating the registry and pass `config` to the `build` method, and you will get the object you want.\n\n### Variable\n\nHave one value for multiple names at multiple places? We got you covered.\n\nJust wrap the value with [`Variable`][chanfig.Variable], and one alteration will be reflected everywhere.\n\n[`Variable`][chanfig.Variable] supports `type`, `choices`, `validator`, and `required` to ensure the correctness of the value.\n\nTo make it even easier, [`Variable`][chanfig.Variable] also support `help` to provide a description when using [`ConfigParser`][chanfig.ConfigParser].\n\n### ConfigParser\n\n[`ConfigParser`][chanfig.ConfigParser] extends [`ArgumentParser`][argparse.ArgumentParser] and provides [`parse`][chanfig.ConfigParser.parse] and [`parse_config`][chanfig.ConfigParser.parse_config] to parse command line arguments.\n\n## Usage\n\nCHANfiG has great backward compatibility with previous configs.\n\nNo matter if your old config is json or yaml, you could directly read from them.\n\nAnd if you are using yacs, just replace `CfgNode` with [`Config`][chanfig.Config] and enjoy all the additional benefits that CHANfiG provides.\n\nMoreover, if you find a name in the config is too long for command-line, you could simply call [`self.add_argument`][chanfig.Config.add_argument] with proper `dest` to use a shorter name in command-line, as you do with `argparse`.\n\n```python\n--8\u003c-- \"demo/config.py\"\n```\n\nAll you need to do is just run a line:\n\n```shell\npython main.py --model.encoder.num_layers 8 --model.dropout=0.2 --lr 5e-3\n```\n\nYou could also load a default configure file and make changes based on it:\n\nNote, you must specify `config.parse(default_config='config')` to correctly load the default config.\n\n```shell\npython main.py --config meow.yaml --model.encoder.num_layers 8 --model.dropout=0.2 --lr 5e-3\n```\n\nIf you have made it dump current configurations, this should be in the written file:\n\n=== \"yaml\"\n\n    ``` yaml\n    --8\u003c-- \"demo/config.yaml\"\n    ```\n\n=== \"json\"\n\n    ``` json\n    --8\u003c-- \"demo/config.json\"\n    ```\n\nDefine the default arguments in function, put alterations in CLI, and leave the rest to CHANfiG.\n\n## Installation\n\n=== \"Install the most recent stable version on pypi\"\n\n    ```shell\n    pip install chanfig\n    ```\n\n=== \"Install the latest version from source\"\n\n    ```shell\n    pip install git+https://github.com/ZhiyuanChen/CHANfiG\n    ```\n\nIt works the way it should have worked.\n\n## License\n\nCHANfiG is multi-licensed under the following licenses:\n\n=== \"The Unlicense\"\n\n    ```\n    --8\u003c-- \"LICENSES/LICENSE.Unlicense\"\n    ```\n\n=== \"GNU Affero General Public License v3.0 or later\"\n\n    ```\n    --8\u003c-- \"LICENSES/LICENSE.AGPL\"\n    ```\n\n=== \"GNU General Public License v2.0 or later\"\n\n    ```\n    --8\u003c-- \"LICENSES/LICENSE.GPLv2\"\n    ```\n\n=== \"BSD 4-Clause \"Original\" or \"Old\" License\"\n\n    ```\n    --8\u003c-- \"LICENSES/LICENSE.BSD\"\n    ```\n\n=== \"MIT License\"\n\n    ```\n    --8\u003c-- \"LICENSES/LICENSE.MIT\"\n    ```\n\n=== \"Apache License 2.0\"\n\n    ```\n    --8\u003c-- \"LICENSES/LICENSE.Apache\"\n    ```\n\nYou can choose any (one or more) of these licenses if you use this work.\n\n`SPDX-License-Identifier: Unlicense OR AGPL-3.0-or-later OR GPL-2.0-or-later OR BSD-4-Clause OR MIT OR Apache-2.0`\n\n[^uncountable]: fun fact: time is always uncountable.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhiyuanchen%2Fchanfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhiyuanchen%2Fchanfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhiyuanchen%2Fchanfig/lists"}