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

metaopt / optree

OpTree: Optimized PyTree Utilities

Apache License 2.0

136 stars 6 forks source link

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:

python/cpython#102757
python/cpython#102759

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

[X] I have raised an issue to propose this change (required for new features and bug fixes)
python/cpython#102757
python/cpython#102759

Types of changes

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

[X] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds core functionality)
[X] 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!

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

Codecov Report

Patch coverage: 100.00% and no project coverage change.

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

:exclamation: 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

```diff @@ 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](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=metaopt#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/metaopt/optree/pull/47?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=metaopt) | Coverage Δ | | |---|---|---| | [optree/ops.py](https://codecov.io/gh/metaopt/optree/pull/47?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=metaopt#diff-b3B0cmVlL29wcy5weQ==) | `100.00% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=metaopt). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=metaopt)

metaopt / optree