Files
pytorch/test/test_utils_config_module.py
Colin L. Rice a0e095dd9f config: Modify install_config_module to use a layered approach (#138758)
This modifies the config system, to use a single mapping of config ->
ConfigEntry and to store the default and user values within them.

We could have used multiple dicts (i.e. user_override and default), but
as we add more fields (justknobs in this PR, perhaps testing and env
variables later), it quickly becomes painful.

There are a couple design decisions we could change.
1) All configs we save store the resolved value - not the default and
   user override seperately
2) All configs we load, apply the resolved value as a user override.

This means that certain complexities of default behvaiour and deletion
(as well as JK), will change if you save + load a config.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/138758
Approved by: https://github.com/ezyang
2024-10-29 23:19:36 +00:00

273 lines
9.3 KiB
Python

# Owner(s): ["module: unknown"]
import pickle
from torch.testing._internal import fake_config_module as config
from torch.testing._internal.common_utils import run_tests, TestCase
from torch.utils._config_module import _UNSET_SENTINEL
class TestConfigModule(TestCase):
def test_base_value_loading(self):
self.assertTrue(config.e_bool)
self.assertTrue(config.nested.e_bool)
self.assertEqual(config.e_int, 1)
self.assertEqual(config.e_float, 1.0)
self.assertEqual(config.e_string, "string")
self.assertEqual(config.e_list, [1])
self.assertEqual(config.e_set, {1})
self.assertEqual(config.e_tuple, (1,))
self.assertEqual(config.e_dict, {1: 2})
self.assertEqual(config.e_none, None)
with self.assertRaises(
AttributeError, msg="fake_config_module.does_not_exist does not exist"
):
config.does_not_exist
def test_overrides(self):
config.e_bool = False
self.assertFalse(config.e_bool)
config.nested.e_bool = False
self.assertFalse(config.nested.e_bool)
config.e_int = 2
self.assertEqual(config.e_int, 2)
config.e_float = 2.0
self.assertEqual(config.e_float, 2.0)
config.e_string = "string2"
self.assertEqual(config.e_string, "string2")
config.e_list = [2]
self.assertEqual(config.e_list, [2])
config.e_set = {2}
self.assertEqual(config.e_set, {2})
config.e_tuple = (2,)
self.assertEqual(config.e_tuple, (2,))
config.e_dict = {2: 3}
self.assertEqual(config.e_dict, {2: 3})
config.e_none = "not none"
self.assertEqual(config.e_none, "not none")
config.e_none = None
self.assertEqual(config.e_none, None)
with self.assertRaises(
AttributeError, msg="fake_config_module.does_not_exist does not exist"
):
config.does_not_exist = 0
# Config changes get persisted between test cases
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_none_override_semantics(self):
config.e_bool = None
self.assertIsNone(config.e_bool)
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_reference_semantics(self):
config.e_list.append(2)
self.assertEqual(config.e_list, [1, 2])
config.e_set.add(2)
self.assertEqual(config.e_set, {1, 2})
config.e_dict[2] = 3
self.assertEqual(config.e_dict, {1: 2, 2: 3})
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_save_config(self):
p = config.save_config()
self.assertEqual(
pickle.loads(p),
{
"_cache_config_ignore_prefix": ["magic_cache_config"],
"e_bool": True,
"e_dict": {1: 2},
"e_float": 1.0,
"e_int": 1,
"e_list": [1],
"e_none": None,
"e_set": {1},
"e_string": "string",
"e_tuple": (1,),
"nested.e_bool": True,
"_e_ignored": True,
"e_compile_ignored": True,
"magic_cache_config_ignored": True,
"_save_config_ignore": ["e_ignored"],
},
)
config.e_bool = False
config.e_ignored = False
config.load_config(p)
self.assertTrue(config.e_bool)
self.assertFalse(config.e_ignored)
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_save_config_portable(self):
p = config.save_config_portable()
self.assertEqual(
p,
{
"e_bool": True,
"e_dict": {1: 2},
"e_float": 1.0,
"e_int": 1,
"e_list": [1],
"e_none": None,
"e_set": {1},
"e_string": "string",
"e_tuple": (1,),
"nested.e_bool": True,
"e_ignored": True,
"e_compile_ignored": True,
},
)
config.e_bool = False
config._e_ignored = False
config.load_config(p)
self.assertTrue(config.e_bool)
self.assertFalse(config._e_ignored)
# Config changes get persisted between test cases
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_codegen_config(self):
config.e_bool = False
config.e_ignored = False
code = config.codegen_config()
self.assertEqual(
code,
"""torch.testing._internal.fake_config_module.e_bool = False
torch.testing._internal.fake_config_module.e_list = [1]
torch.testing._internal.fake_config_module.e_set = {1}
torch.testing._internal.fake_config_module.e_dict = {1: 2}
torch.testing._internal.fake_config_module._save_config_ignore = ['e_ignored']""",
)
# Config changes get persisted between test cases
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_get_hash(self):
self.assertEqual(
config.get_hash(), b"\xcd\x96\x93\xf5(\xf8(\xa5\x1c+O\n\xd3_\x0b\xa6"
)
# Test cached value
self.assertEqual(
config.get_hash(), b"\xcd\x96\x93\xf5(\xf8(\xa5\x1c+O\n\xd3_\x0b\xa6"
)
self.assertEqual(
config._hash_digest, b"\xcd\x96\x93\xf5(\xf8(\xa5\x1c+O\n\xd3_\x0b\xa6"
)
config._hash_digest = "fake"
self.assertEqual(config.get_hash(), "fake")
# BUG
config.e_bool = False
self.assertNotEqual(
config.get_hash(), b"\xcd\x96\x93\xf5(\xf8(\xa5\x1c+O\n\xd3_\x0b\xa6"
)
config.e_bool = True
# Test ignored values
config.e_compile_ignored = False
self.assertEqual(
config.get_hash(), b"\xcd\x96\x93\xf5(\xf8(\xa5\x1c+O\n\xd3_\x0b\xa6"
)
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_dict_copy_semantics(self):
p = config.shallow_copy_dict()
self.assertEqual(
p,
{
"e_bool": True,
"e_dict": {1: 2},
"e_float": 1.0,
"e_int": 1,
"e_list": [1],
"e_none": None,
"e_set": {1},
"e_string": "string",
"e_tuple": (1,),
"nested.e_bool": True,
"e_ignored": True,
"_e_ignored": True,
"e_compile_ignored": True,
"_cache_config_ignore_prefix": ["magic_cache_config"],
"_save_config_ignore": ["e_ignored"],
"magic_cache_config_ignored": True,
},
)
p2 = config.to_dict()
self.assertEqual(
p2,
{
"e_bool": True,
"e_dict": {1: 2},
"e_float": 1.0,
"e_int": 1,
"e_list": [1],
"e_none": None,
"e_set": {1},
"e_string": "string",
"e_tuple": (1,),
"nested.e_bool": True,
"e_ignored": True,
"_e_ignored": True,
"e_compile_ignored": True,
"_cache_config_ignore_prefix": ["magic_cache_config"],
"_save_config_ignore": ["e_ignored"],
"magic_cache_config_ignored": True,
},
)
p3 = config.get_config_copy()
self.assertEqual(
p3,
{
"e_bool": True,
"e_dict": {1: 2},
"e_float": 1.0,
"e_int": 1,
"e_list": [1],
"e_none": None,
"e_set": {1},
"e_string": "string",
"e_tuple": (1,),
"nested.e_bool": True,
"e_ignored": True,
"_e_ignored": True,
"e_compile_ignored": True,
"_cache_config_ignore_prefix": ["magic_cache_config"],
"_save_config_ignore": ["e_ignored"],
"magic_cache_config_ignored": True,
},
)
# Shallow + deep copy semantics
config.e_dict[2] = 3
self.assertEqual(p["e_dict"], {1: 2})
self.assertEqual(p2["e_dict"], {1: 2})
self.assertEqual(p3["e_dict"], {1: 2})
for k in config._config:
config._config[k].user_override = _UNSET_SENTINEL
def test_patch(self):
self.assertTrue(config.e_bool)
with config.patch("e_bool", False):
self.assertFalse(config.e_bool)
self.assertTrue(config.e_bool)
with config.patch(e_bool=False):
self.assertFalse(config.e_bool)
self.assertTrue(config.e_bool)
with self.assertRaises(AssertionError):
with config.patch("does_not_exist"):
pass
def test_make_closur_patcher(self):
revert = config._make_closure_patcher(e_bool=False)()
self.assertFalse(config.e_bool)
revert()
self.assertTrue(config.e_bool)
if __name__ == "__main__":
run_tests()