Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow tree-map with mixed inputs of ordered and unordered dictionaries #42

Merged
merged 6 commits into from
Mar 11, 2023

Conversation

XuehaiPan
Copy link
Member

Description

Describe your changes in detail.

>>> from collections import *
>>> tree1 = {'a': 1, 'b': 2}
>>> tree2 = OrderedDict(b=2, a=1)
>>> tree3 = defaultdict(int, {'a': 1, 'b': 2})
>>> optree.tree_map(lambda x, y, z: x + y + z, tree1, tree2, tree3)
{'a': 3, 'b': 6}
>>> optree.tree_map(lambda x, y, z: x + y + z, tree2, tree1, tree3)
OrderedDict([('b', 6), ('a', 3)])
>>> optree.tree_map(lambda x, y, z: x + y + z, tree3, tree1, tree2)
defaultdict(<class 'int'>, {'a': 3, 'b': 6})
>>> optree.tree_map(lambda x, y: x + y, {'a': 1, 'b': 2}, defaultdict(int, {'a': 1}))
ValueError: dictionary key mismatch; expected key(s): ['a', 'b'], got key(s): ['a'], missing key(s): ['b']; dict: defaultdict(<class 'int'>, {'a': 1}).

Motivation and Context

Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax close #15213 if this solves the issue #15213

  • I have raised an issue to propose this change (required for new features and bug fixes)

Resolves #27

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.
  • I have reformatted the code using make format. (required)
  • I have checked the code using make lint. (required)
  • I have ensured make test pass. (required)

@XuehaiPan XuehaiPan self-assigned this Mar 6, 2023
@XuehaiPan XuehaiPan added enhancement New feature or request cxx Something related to the CXX source code py Something related to the Python source code labels Mar 6, 2023
@XuehaiPan XuehaiPan added this to the 0.8.0 milestone Mar 6, 2023
@XuehaiPan XuehaiPan requested a review from JieRen98 March 6, 2023 12:58
@codecov
Copy link

codecov bot commented Mar 6, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (f608bfb) 100.00% compared to head (9ce80da) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #42   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          384       420   +36     
=========================================
+ Hits           384       420   +36     
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
optree/ops.py 100.00% <100.00%> (ø)
optree/registry.py 100.00% <100.00%> (ø)
optree/utils.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

JieRen98
JieRen98 previously approved these changes Mar 8, 2023
@Benjamin-eecs Benjamin-eecs requested a review from JieRen98 March 8, 2023 16:42
@XuehaiPan XuehaiPan merged commit fc2b0a1 into metaopt:main Mar 11, 2023
@XuehaiPan XuehaiPan deleted the mix-dict branch March 11, 2023 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cxx Something related to the CXX source code enhancement New feature or request py Something related to the Python source code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Allow tree-map with mixed inputs of ordered and unordered dictionaries
2 participants