chanfig 0.0.0__py3-none-any.whl

chanfig-0.0.0.dist-info/LICENSES/LICENSE.MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Zhiyuan Chen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

chanfig-0.0.0.dist-info/METADATA

@@ -0,0 +1,178 @@
+Metadata-Version: 2.1
+Name: chanfig
+Version: 0.0.0
+Summary: Easier Configuration
+Home-page: https://chanfig.danling.org
+Keywords: Machine Learning,Config,Dict
+Author: Zhiyuan Chen
+Author-email: this@zyc.ai
+Maintainer: Zhiyuan Chen
+Maintainer-email: this@zyc.ai
+Requires-Python: >=3,<4
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Project-URL: Documentation, https://chanfig.danling.org
+Project-URL: Repository, https://github.com/ZhiyuanChen/CHANfiG
+Description-Content-Type: text/markdown
+
+# CHANfiG
+
+Read this in English: [English](README.md), [简体中文](README.cn.md)
+
+在其他语言中阅读本文：[简体中文](README.cn.md)、[English](README.md)
+
+[Document site](https://chanfig.danling.org)
+
+## Introduction
+
+CHANfiG aims to make your configuration easier.
+
+There are tons of configurable parameters in training a Machine Learning model.
+To configure all these parameters, researchers usually need to write gigantic config files, sometimes even thousands of lines.
+Most of the configs are just replicates of the default arguments of certain functions, resulting in many unnecessary declarations.
+It is also very hard to alter the configurations.
+One needs to navigate and open the right configuration file, make changes, save and exit.
+These had wasted an incountable[^incountable] amount of precious time ~~and is no doubt a crime~~.
+Using `argparse` could relieve the burdens to some extent, however, it takes a lot of work to make it compatible with existing config files, and its lack of nesting limits its potential.
+CHANfiG would like to make a change.
+
+You just run your experiment with arguments, and leave everything else to CHANfiG.
+
+CHANfiG is highly inspired by [YACS](https://github.com/rbgirshick/yacs).
+Different to the paradigm of YACS(
+`your code + a YACS config for experiment E (+ external dependencies + hardware + other nuisance terms ...) = reproducible experiment E`),
+The paradigm of CHANfiG is:
+
+`your code + command line arguments (+ optional CHANfiG config + external dependencies + hardware + other nuisance terms ...) = reproducible experiment E (+ optional CHANfiG config for experiment E)`
+
+## Usage
+
+CHANfiG has great backward compatibility with previous configs.
+
+No matter your old config is json or yaml, you could directly read from them.
+
+And if you are using yacs, just replace `CfgNode` with `Config` and enjoy all the additional benefits that CHANfiG provides.
+
+```python
+from chanfig import Config
+
+
+class Model:
+    def __init__(self, encoder, dropout=0.1, activation='ReLU'):
+        self.encoder = Encoder(**encoder)
+        self.dropout = Dropout(dropout)
+        self.activation = getattr(Activation, activation)
+
+def main(config):
+    model = Model(**config.model)
+    optimizer = Optimizer(**config.optimizer)
+    scheduler = Scheduler(**config.scheduler)
+    dataset = Dataset(**config.dataset)
+    dataloader = Dataloader(**config.dataloader)
+
+
+class TestConfig(Config):
+    def __init__(self):
+        super().__init__()
+        self.data.batch_size = 64
+        self.model.encoder.num_layers = 6
+        self.model.decoder.num_layers = 6
+        self.activation = "GELU"
+        self.optim.lr = 1e-3
+
+
+if __name__ == '__main__':
+    # config = Config.read('config.yaml')  # in case you want to read from a yaml
+    # config = Config.read('config.json')  # in case you want to read from a json
+    # existing_configs = {'data.batch_size': 64, 'model.encoder.num_layers': 8}
+    # config = Config(**existing_configs)  # in case you have some config in dict to load
+    config = TestConfig()
+    config = config.parse()
+    # config.merge('dataset.yaml')  # in case you want to merge a yaml
+    # config.merge('dataset.json')  # in case you want to merge a json
+    # note that the value of merge will surpass current values
+    config.model.decoder.num_layers = 8
+    config.freeze()
+    print(config)
+    # main(config)
+    # config.yaml('config.yaml')  # in case you want to save a yaml
+    # config.json('config.json')  # in case you want to save a json
+```
+
+All you needs to do is just run a line:
+
+```shell
+python main.py --model.encoder.num_layers 8
+```
+
+You could also load a default configure file and make changes based on it:
+
+```shell
+python main.py --config meow.yaml --model.encoder.num_layers 8
+```
+
+If you have made it dump current configurations, this should be in the written file:
+
+```yaml
+data:
+  batch_size: 64
+model:
+  encoder:
+    num_layers: 8
+  decoder:
+    num_layers: 8
+  activation: GELU
+```
+
+```json
+{
+  "data": {
+    "batch_size": 64
+  },
+  "model": {
+    "encoder": {
+      "num_layers": 8
+    },
+    "decoder": {
+      "num_layers": 8
+    },
+  "activation": "GELU"
+  }
+}
+```
+
+Define the default arguments in function, put alteration in CLI, and leave the rest to CHANfiG.
+
+## Installation
+
+Install most recent stable version on pypi:
+
+```shell
+pip install chanfig
+```
+
+Install the latest version from source:
+
+```shell
+pip install git+https://github.com/ZhiyuanChen/chanfig
+```
+
+
+
+It works the way it should have worked.
+
+[^incountable]: fun fact: time is always incountable.
+

chanfig-0.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+chanfig/__init__.py,sha256=fgSn7a3fsOlDInQ_mw1Am4aJznPD0FGcjfdlHd_yGm0,183
+chanfig/config.py,sha256=Dx6YLvR3LGMYsENKyyi7csQqTjD48B6PJuqOMEqunI0,46103
+chanfig-0.0.0.dist-info/LICENSES/LICENSE.Apache2,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+chanfig-0.0.0.dist-info/LICENSES/LICENSE.BSD3,sha256=04pVVqbRLIBTShRJqfn_y32z6HRaxCEJGL-XOE3lPv0,1520
+chanfig-0.0.0.dist-info/LICENSES/LICENSE.GPL3,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+chanfig-0.0.0.dist-info/LICENSES/LICENSE.MIT,sha256=r9GSPSpivCGY_FkouhaQlI3p6C-dIKxdfpw1RcsZTPs,1069
+chanfig-0.0.0.dist-info/LICENSE,sha256=lUTrEUlpJyMzk3yOm7f9STIoiY0r3Go_LmzhzKc96-g,58
+chanfig-0.0.0.dist-info/LICENSES/LICENSE.BSD2,sha256=XSD8A3aeI-xqU_stApHLxl8DbebGTU7ze3XMKWEvd2Y,1322
+chanfig-0.0.0.dist-info/LICENSES/LICENSE.GPL2,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+chanfig-0.0.0.dist-info/WHEEL,sha256=vxFmldFsRN_Hx10GDvsdv1wroKq8r5Lzvjp6GZ4OO8c,88
+chanfig-0.0.0.dist-info/METADATA,sha256=d4ph-6ArFc0DBJipLxyfPflrfhkvQ5ZmWCFtZAIEyMc,5790
+chanfig-0.0.0.dist-info/RECORD,,

chanfig-0.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.3.2
+Root-Is-Purelib: true
+Tag: py3-none-any