Better error

huggingface · Sep 6, 2023 · ed85c06 · ed85c06
1 parent e0c0a0c
commit ed85c06
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/src/accelerate/commands/config/config_args.py b/src/accelerate/commands/config/config_args.py
@@ -110,10 +110,11 @@ def from_json_file(cls, json_file=None):
             config_dict["use_cpu"] = False
         if "debug" not in config_dict:
             config_dict["debug"] = False
-        extra_keys = set(config_dict.keys()) - set(cls.__dataclass_fields__.keys())
+        extra_keys = sorted(set(config_dict.keys()) - set(cls.__dataclass_fields__.keys()))
         if len(extra_keys) > 0:
             raise ValueError(
-                f"Unknown keys in the config file: {list(extra_keys)}, please try upgrading your `accelerate` version or remove them."
+                f"The config file at {json_file} had unknown keys ({extra_keys}), please try upgrading your `accelerate`"
+                " version or fix (and potentially remove) these keys from your config file."
             )
 
         return cls(**config_dict)
@@ -143,10 +144,11 @@ def from_yaml_file(cls, yaml_file=None):
             config_dict["use_cpu"] = False
         if "debug" not in config_dict:
             config_dict["debug"] = False
-        extra_keys = set(config_dict.keys()) - set(cls.__dataclass_fields__.keys())
+        extra_keys = sorted(set(config_dict.keys()) - set(cls.__dataclass_fields__.keys()))
         if len(extra_keys) > 0:
             raise ValueError(
-                f"Unknown keys in the config file: {list(extra_keys)}, please try upgrading your `accelerate` version or remove them."
+                f"The config file at {yaml_file} had unknown keys ({extra_keys}), please try upgrading your `accelerate`"
+                " version or fix (and potentially remove) these keys from your config file."
             )
         return cls(**config_dict)
 

diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -75,7 +75,8 @@ def test_config_compatibility(self):
 
     def test_invalid_keys(self):
         with self.assertRaises(
-            RuntimeError, msg="Unknown keys in the config file: ['another_invalid_key', 'invalid_key']"
+            RuntimeError,
+            msg="The config file at 'invalid_keys.yaml' had unknown keys ('another_invalid_key', 'invalid_key')",
         ):
             execute_subprocess_async(
                 self.base_cmd