Fix devices_list type validation error in TrainerConfig #586
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
When specifying
devices_list
inTrainerConfig
, users encountered an OmegaConf validation error:Error:
Root Cause
The
devices
field inTrainerConfig
was typed asOptional[int]
, but the__post_init__
method assigns thedevices_list
(a list) todevices
when provided. When OmegaConf wraps the config withOmegaConf.structured()
, it validates types and rejects the list assignment.Solution
Changed the type annotation of the
devices
field fromOptional[int]
toAny
. This approach:Union[int, List[int]]
is not supported by OmegaConf for container types)Changes
src/pytorch_tabular/config/config.py:
devices
field type fromOptional[int]
toAny
devices
acceptsUnion[int, List[int]]
tests/test_config.py (new file):
devices_list=[0, 1]
)devices
valuesTesting
All scenarios now work correctly:
Backward Compatibility
✅ Fully backward compatible - all existing code using
devices=<int>
continues to work unchanged.Fixes #issue_number
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
archive.ics.uci.edu
python -m pytest tests/test_config.py -v
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.