resolve comments

Author: tchaton

pytorch_lightning/core/saving.py

@@ -319,8 +319,8 @@ def load_hparams_from_yaml(config_yaml: str, use_omegaconf: bool = True) -> Dict
 
         Args:
             config_yaml: Path to config yaml file
-            use_omegaconf: If both `OMEGACONF_AVAILABLE` and `use_omegaconf` are True,
-                the hparams will be converted to `DictConfig` if possible
+            use_omegaconf: If omegaconf is available and `use_omegaconf=True`,
+                the hparams will be converted to ``DictConfig`` if possible.
 
     >>> hparams = Namespace(batch_size=32, learning_rate=0.001, data_root='./any/path/here')
     >>> path_yaml = './testing-hparams.yaml'
@@ -352,8 +352,8 @@ def save_hparams_to_yaml(config_yaml, hparams: Union[dict, Namespace], use_omega
     Args:
         config_yaml: path to new YAML file
         hparams: parameters to be saved
-        use_omegaconf: If both `OMEGACONF_AVAILABLE` and `use_omegaconf` are True,
-                the hparams will be converted to `DictConfig` if possible
+            use_omegaconf: If omegaconf is available and `use_omegaconf=True`,
+                the hparams will be converted to ``DictConfig`` if possible.
 
     """
     fs = get_filesystem(config_yaml)

tests/models/test_hparams.py

@@ -493,14 +493,14 @@ class Options(str, Enum):
     )
     path_yaml = os.path.join(tmpdir, "testing-hparams.yaml")
 
-    def compare(loadedParams, defaultParams: dict):
-        assert isinstance(loadedParams, (dict, DictConfig))
-        assert loadedParams.keys() == defaultParams.keys()
-        for k, v in defaultParams.items():
+    def compare(loaded_params, default_params: dict):
+        assert isinstance(loaded_params, (dict, DictConfig))
+        assert loaded_params.keys() == default_params.keys()
+        for k, v in default_params.items():
             if isinstance(v, Enum):
-                assert v.name == loadedParams[k]
+                assert v.name == loaded_params[k]
             else:
-                assert v == loadedParams[k]
+                assert v == loaded_params[k]
 
     save_hparams_to_yaml(path_yaml, hparams)
     compare(load_hparams_from_yaml(path_yaml, use_omegaconf=False), hparams)