Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions src/quantem/core/ml/optimizer_mixin.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,11 @@ def parse_dict(cls, d: dict):
Accepts either ``"name"`` or ``"type"`` as the optimizer key.
"""
d = dict(d) # avoid mutating caller's dict
name = d.pop("name", "none") or d.pop("type", "none")
name = d.pop("name", None)
type_ = d.pop("type", None)
name = name or type_
if name is None:
raise ValueError("Must provide either 'name' or 'type' key")
if isinstance(name, type):
name = name.__name__.lower()
elif isinstance(name, str):
Expand All @@ -172,6 +176,8 @@ def parse_dict(cls, d: dict):
return OptimizerParams.AdamW(**d)
elif name == "sgd":
return OptimizerParams.SGD(**d)
elif name == "none":
return OptimizerParams.NoneOptimizer()
else:
raise ValueError(f"Unknown optimizer type: {name.lower()}")

Expand Down Expand Up @@ -444,7 +450,11 @@ def parse_dict(cls, d: dict):
Accepts either ``"name"`` or ``"type"`` as the scheduler key.
"""
d = dict(d) # avoid mutating caller's dict
name = d.pop("name", "none") or d.pop("type", "none")
name = d.pop("name", None)
type_ = d.pop("type", None)
name = name or type_
if name is None:
raise ValueError("Must provide either 'name' or 'type' key")
if isinstance(name, type):
name = name.__name__.lower()
elif isinstance(name, str):
Expand Down
59 changes: 57 additions & 2 deletions tests/ml/test_optimizermixin.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,61 @@ def test_parse_invalid_name_type_raises(self):
OptimizerParams.parse_dict({"name": 42})


# ─── parse_dict "name" vs "type" key handling ───────────────────────────────


class TestOptimizerParseDictKeyHandling:
def test_parse_with_type_key(self):
result = OptimizerParams.parse_dict({"type": "adam", "lr": 0.01})
assert isinstance(result, OptimizerParams.Adam)
assert result.lr == 0.01

def test_name_takes_precedence_over_type(self):
result = OptimizerParams.parse_dict({"name": "adam", "type": "sgd"})
assert isinstance(result, OptimizerParams.Adam)

def test_neither_name_nor_type_raises(self):
with pytest.raises(ValueError, match="Must provide either"):
OptimizerParams.parse_dict({"lr": 0.01})

def test_type_key_not_leaked_into_constructor(self):
"""'type' should be popped from d so it doesn't become an unexpected kwarg."""
result = OptimizerParams.parse_dict({"type": "sgd", "momentum": 0.9})
assert isinstance(result, OptimizerParams.SGD)
assert result.momentum == 0.9

def test_both_keys_popped_when_name_used(self):
"""Even when 'name' is used, 'type' should be popped so it doesn't leak."""
result = OptimizerParams.parse_dict({"name": "adam", "type": "ignored", "lr": 0.05})
assert isinstance(result, OptimizerParams.Adam)
assert result.lr == 0.05


class TestSchedulerParseDictKeyHandling:
def test_parse_with_type_key(self):
result = SchedulerParams.parse_dict({"type": "plateau", "patience": 20})
assert isinstance(result, SchedulerParams.Plateau)
assert result.patience == 20

def test_name_takes_precedence_over_type(self):
result = SchedulerParams.parse_dict({"name": "plateau", "type": "linear"})
assert isinstance(result, SchedulerParams.Plateau)

def test_neither_name_nor_type_raises(self):
with pytest.raises(ValueError, match="Must provide either"):
SchedulerParams.parse_dict({"patience": 20})

def test_type_key_not_leaked_into_constructor(self):
result = SchedulerParams.parse_dict({"type": "cyclic", "step_size_up": 50})
assert isinstance(result, SchedulerParams.Cyclic)
assert result.step_size_up == 50

def test_both_keys_popped_when_name_used(self):
result = SchedulerParams.parse_dict({"name": "plateau", "type": "ignored", "patience": 5})
assert isinstance(result, SchedulerParams.Plateau)
assert result.patience == 5


# ─── SchedulerParams defaults ───────────────────────────────────────────────


Expand Down Expand Up @@ -291,5 +346,5 @@ def test_parse_invalid_name_type_raises(self):
SchedulerParams.parse_dict({"name": 3.14})

def test_parse_default_name_is_none(self):
result = SchedulerParams.parse_dict({})
assert isinstance(result, SchedulerParams.NoneScheduler)
with pytest.raises(ValueError, match="Must provide either"):
SchedulerParams.parse_dict({})