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

refactor: align argument names with PyTorch #65

Merged
merged 33 commits into from
Aug 29, 2022

Conversation

XuehaiPan
Copy link
Member

Description

Describe your changes in detail.

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)

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)
  • Example (update in the folder of example)

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)

@codecov-commenter
Copy link

codecov-commenter commented Aug 25, 2022

Codecov Report

Merging #65 (cd54216) into main (78965f2) will decrease coverage by 0.79%.
The diff coverage is 59.16%.

@@            Coverage Diff             @@
##             main      #65      +/-   ##
==========================================
- Coverage   61.20%   60.40%   -0.80%     
==========================================
  Files          27       27              
  Lines         781      841      +60     
==========================================
+ Hits          478      508      +30     
- Misses        303      333      +30     
Flag Coverage Δ
unittests 60.40% <59.16%> (-0.80%) ⬇️

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

Impacted Files Coverage Δ
torchopt/_src/hook.py 35.71% <0.00%> (ø)
torchopt/_src/optimizer/meta/base.py 33.33% <0.00%> (+1.90%) ⬆️
torchopt/_src/optimizer/meta/rmsprop.py 85.71% <ø> (-1.79%) ⬇️
torchopt/_src/optimizer/meta/sgd.py 85.71% <ø> (-1.79%) ⬇️
torchopt/_src/update.py 81.81% <ø> (ø)
torchopt/_src/alias.py 57.47% <54.16%> (-19.81%) ⬇️
torchopt/_src/transform.py 93.33% <92.30%> (-0.05%) ⬇️
torchopt/_src/accelerated_op/adam_op/adam_op.py 74.66% <100.00%> (ø)
torchopt/_src/base.py 100.00% <100.00%> (ø)
torchopt/_src/clip.py 82.35% <100.00%> (ø)
... and 6 more

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

@XuehaiPan XuehaiPan added the pytorch Something PyTorch related label Aug 26, 2022
@XuehaiPan XuehaiPan added this to the 0.5.0 milestone Aug 29, 2022
@XuehaiPan XuehaiPan force-pushed the align-pytorch branch 2 times, most recently from 8bd5101 to 169ee5b Compare August 29, 2022 09:23
@XuehaiPan XuehaiPan force-pushed the align-pytorch branch 2 times, most recently from a74a8c2 to 7e96e02 Compare August 29, 2022 12:44
@XuehaiPan XuehaiPan merged commit 5242e66 into metaopt:main Aug 29, 2022
@XuehaiPan XuehaiPan deleted the align-pytorch branch August 29, 2022 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pytorch Something PyTorch related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants