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

fix(ops): align kwargs for tree_reduce with functools.reduce with the Python C implementation #47

Merged
merged 3 commits into from
Mar 20, 2023

Conversation

XuehaiPan
Copy link
Member

Description

Describe your changes in detail.

The argument in tree_reduce was changed from initial to initializer in #39. I realized this is a documentation issue in Python. The signature in Python C code is initial. This PR reverts the changes for the argument name in tree_reduce.

Ref:

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

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 20, 2023
@XuehaiPan XuehaiPan added bug Something isn't working documentation Improvements or additions to documentation py Something related to the Python source code labels Mar 20, 2023
@XuehaiPan XuehaiPan added this to the 0.9.0 milestone Mar 20, 2023
@XuehaiPan XuehaiPan requested a review from Benjamin-eecs March 20, 2023 08:48
@XuehaiPan XuehaiPan changed the title fix(ops): align kwargs for tree_reduce with functools.reduce with the Python C implementation fix(ops): align kwargs for tree_reduce with functools.reduce with the Python C implementation Mar 20, 2023
@codecov
Copy link

codecov bot commented Mar 20, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (68a0143) 100.00% compared to head (8215d39) 100.00%.

❗ Current head 8215d39 differs from pull request most recent head 24d53e8. Consider uploading reports for the commit 24d53e8 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #47   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          424       424           
=========================================
  Hits           424       424           
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%> (ø)

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.

Copy link
Member

@Benjamin-eecs Benjamin-eecs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@XuehaiPan XuehaiPan merged commit 9e150ce into metaopt:main Mar 20, 2023
@XuehaiPan XuehaiPan deleted the reduce-signature branch March 20, 2023 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation py Something related to the Python source code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants