paramflow 0.1.8__tar.gz → 0.2__tar.gz

{paramflow-0.1.8/paramflow.egg-info → paramflow-0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: paramflow
-Version: 0.1.8
+Version: 0.2
 Home-page: https://github.com/mduszyk/paramflow
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
@@ -45,6 +45,7 @@ pip install "paramflow[dotenv]"
 ```toml
 [default]
 learning_rate = 0.001
+batch_size = 64
 ```
 
 ```app.py```
@@ -54,6 +55,18 @@ params = pf.load('params.toml')
 print(params.learning_rate)
 ```
 
+```shell
+python app.py --help
+usage: app.py [-h] [--learning_rate LEARNING_RATE] [--batch_size BATCH_SIZE]
+
+options:
+  -h, --help            show this help message and exit
+  --learning_rate LEARNING_RATE
+                        learning_rate = 0.001
+  --batch_size BATCH_SIZE
+                        batch_size = 64
+```
+
 ## Meta-parameter Layering
 Meta-parameter layering controls how ```paramflow.load``` reads its own configuration.
 
@@ -87,7 +100,7 @@ params = pf.load(['params.toml', 'env', '.env', 'args'])
  
 Overwrite parameter value:
 ```shell
-python print_params.py --profile dqn-adam --lr 0.0002
+python print_params.py --profile dqn-adam --learning_rate 0.0002
 ```
 
 ## ML hyper-parameters profiles

{paramflow-0.1.8 → paramflow-0.2}/README.md

@@ -27,6 +27,7 @@ pip install "paramflow[dotenv]"
 ```toml
 [default]
 learning_rate = 0.001
+batch_size = 64
 ```
 
 ```app.py```
@@ -36,6 +37,18 @@ params = pf.load('params.toml')
 print(params.learning_rate)
 ```
 
+```shell
+python app.py --help
+usage: app.py [-h] [--learning_rate LEARNING_RATE] [--batch_size BATCH_SIZE]
+
+options:
+  -h, --help            show this help message and exit
+  --learning_rate LEARNING_RATE
+                        learning_rate = 0.001
+  --batch_size BATCH_SIZE
+                        batch_size = 64
+```
+
 ## Meta-parameter Layering
 Meta-parameter layering controls how ```paramflow.load``` reads its own configuration.
 
@@ -69,7 +82,7 @@ params = pf.load(['params.toml', 'env', '.env', 'args'])
  
 Overwrite parameter value:
 ```shell
-python print_params.py --profile dqn-adam --lr 0.0002
+python print_params.py --profile dqn-adam --learning_rate 0.0002
 ```
 
 ## ML hyper-parameters profiles

{paramflow-0.1.8 → paramflow-0.2}/paramflow/params.py

@@ -44,13 +44,13 @@ def load(source: Optional[Union[str, List[str]]] = None,
         profile_key: profile,
     }
     meta_env_parser = EnvParser(ENV_PREFIX, DEFAULT_PROFILE)
-    meta_args_parser = ArgsParser(ARGS_PREFIX, DEFAULT_PROFILE)
+    meta_args_parser = ArgsParser(ARGS_PREFIX, DEFAULT_PROFILE, add_help=False)
     meta = deep_merge(meta, meta_env_parser(meta))
     meta = deep_merge(meta, meta_args_parser(meta))
     meta = freeze(meta)
 
     if meta.source is None:
-        sys.exit('file meta param is missing')
+        sys.exit('source meta param is missing')
 
     sources = list(meta.source) if isinstance(meta.source, list) else [meta.source]
     if ENV_SOURCE not in sources and meta.env_prefix is not None:

{paramflow-0.1.8 → paramflow-0.2}/paramflow/parser.py

@@ -124,16 +124,17 @@ class EnvParser(Parser):
 
 class ArgsParser(Parser):
 
-    def __init__(self, prefix: str, default_profile: str, target_profile: str = None):
+    def __init__(self, prefix: str, default_profile: str, target_profile: str = None, **kwargs):
         self.prefix = prefix
         self.default_profile = default_profile
         self.target_profile = target_profile
+        self.kwargs = kwargs
 
     def __call__(self, params: Dict[str, any]) -> Dict[str, any]:
         if self.target_profile is None and self.default_profile in params:
             self.target_profile = self.default_profile
         params = params.get(self.default_profile, params)
-        parser = argparse.ArgumentParser()
+        parser = argparse.ArgumentParser(**self.kwargs)
         for key, value in params.items():
             typ = type(value)
             if typ is dict or typ is list or typ is bool or value is None:

{paramflow-0.1.8 → paramflow-0.2/paramflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: paramflow
-Version: 0.1.8
+Version: 0.2
 Home-page: https://github.com/mduszyk/paramflow
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
@@ -45,6 +45,7 @@ pip install "paramflow[dotenv]"
 ```toml
 [default]
 learning_rate = 0.001
+batch_size = 64
 ```
 
 ```app.py```
@@ -54,6 +55,18 @@ params = pf.load('params.toml')
 print(params.learning_rate)
 ```
 
+```shell
+python app.py --help
+usage: app.py [-h] [--learning_rate LEARNING_RATE] [--batch_size BATCH_SIZE]
+
+options:
+  -h, --help            show this help message and exit
+  --learning_rate LEARNING_RATE
+                        learning_rate = 0.001
+  --batch_size BATCH_SIZE
+                        batch_size = 64
+```
+
 ## Meta-parameter Layering
 Meta-parameter layering controls how ```paramflow.load``` reads its own configuration.
 
@@ -87,7 +100,7 @@ params = pf.load(['params.toml', 'env', '.env', 'args'])
  
 Overwrite parameter value:
 ```shell
-python print_params.py --profile dqn-adam --lr 0.0002
+python print_params.py --profile dqn-adam --learning_rate 0.0002
 ```
 
 ## ML hyper-parameters profiles

{paramflow-0.1.8 → paramflow-0.2}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='paramflow',
-    version='0.1.8',
+    version='0.2',
     packages=find_packages(),
     install_requires=[
         "pyyaml",