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

style: use postponed evaluation of annotations and update doctring style #135

Merged
merged 5 commits into from
Feb 15, 2023

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)

Use postponed evaluation of annotations and update doctring style.

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)

@XuehaiPan XuehaiPan self-assigned this Feb 15, 2023
@XuehaiPan XuehaiPan added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 15, 2023
@XuehaiPan XuehaiPan added this to the 0.7.0 milestone Feb 15, 2023
Benjamin-eecs
Benjamin-eecs previously approved these changes Feb 15, 2023
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!

@codecov
Copy link

codecov bot commented Feb 15, 2023

Codecov Report

Base: 91.73% // Head: 91.70% // Decreases project coverage by -0.03% ⚠️

Coverage data is based on head (905db2a) compared to base (c67476b).
Patch coverage: 99.28% of modified lines in pull request are covered.

❗ Current head 905db2a differs from pull request most recent head 00aba85. Consider uploading reports for the commit 00aba85 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #135      +/-   ##
==========================================
- Coverage   91.73%   91.70%   -0.03%     
==========================================
  Files          66       66              
  Lines        2551     2553       +2     
==========================================
+ Hits         2340     2341       +1     
- Misses        211      212       +1     
Flag Coverage Δ
unittests 91.70% <99.28%> (-0.03%) ⬇️

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

Impacted Files Coverage Δ
torchopt/alias/rmsprop.py 100.00% <ø> (ø)
torchopt/alias/sgd.py 100.00% <ø> (ø)
torchopt/optim/meta/rmsprop.py 90.00% <ø> (ø)
torchopt/optim/meta/sgd.py 88.89% <ø> (ø)
torchopt/optim/rmsprop.py 100.00% <ø> (ø)
torchopt/optim/sgd.py 100.00% <ø> (ø)
torchopt/schedule/polynomial.py 80.95% <ø> (ø)
torchopt/update.py 100.00% <ø> (ø)
torchopt/linalg/ns.py 41.38% <80.00%> (+1.72%) ⬆️
torchopt/accelerated_op/__init__.py 91.67% <100.00%> (-8.33%) ⬇️
... and 45 more

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 at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@XuehaiPan XuehaiPan merged commit e2157de into metaopt:main Feb 15, 2023
@XuehaiPan XuehaiPan deleted the type-annotations branch February 15, 2023 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants