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

docs: refactor documentation #127

Merged
merged 89 commits into from
Feb 2, 2023
Merged

Conversation

Benjamin-eecs
Copy link
Member

Description

Describe your changes in detail.

Types of changes

  • Documentation (update in the documentation)

Checklist

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • 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 changed the title refactor: documentations docs: refactor documentation Jan 5, 2023
@XuehaiPan XuehaiPan added the documentation Improvements or additions to documentation label Jan 5, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jan 9, 2023

Codecov Report

Base: 70.35% // Head: 69.52% // Decreases project coverage by -0.83% ⚠️

Coverage data is based on head (e3b1686) compared to base (2c0a0df).
Patch has no changes to coverable lines.

❗ Current head e3b1686 differs from pull request most recent head c048570. Consider uploading reports for the commit c048570 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #127      +/-   ##
==========================================
- Coverage   70.35%   69.52%   -0.83%     
==========================================
  Files          72       69       -3     
  Lines        3009     2901     -108     
==========================================
- Hits         2117     2017     -100     
+ Misses        892      884       -8     
Flag Coverage Δ
unittests 69.52% <ø> (-0.83%) ⬇️

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

Impacted Files Coverage Δ
torchopt/diff/zero_order/__init__.py 90.90% <0.00%> (-9.10%) ⬇️
torchopt/accelerated_op/adam_op.py 71.42% <0.00%> (-3.26%) ⬇️
torchopt/diff/zero_order/decorator.py 95.00% <0.00%> (-1.95%) ⬇️
torchopt/distributed/world.py 52.74% <0.00%> (-1.02%) ⬇️
torchopt/base.py 76.92% <0.00%> (-0.69%) ⬇️
torchopt/nn/module.py 39.81% <0.00%> (-0.28%) ⬇️
torchopt/typing.py 95.45% <0.00%> (-0.20%) ⬇️
torchopt/diff/implicit/decorator.py 95.67% <0.00%> (-0.09%) ⬇️
torchopt/utils.py 56.85% <0.00%> (ø)
torchopt/alias/utils.py 92.85% <0.00%> (ø)
... and 11 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 previously approved these changes Feb 2, 2023
@XuehaiPan XuehaiPan merged commit 773d140 into metaopt:main Feb 2, 2023
@Benjamin-eecs Benjamin-eecs deleted the refactor/docs branch February 8, 2023 07:44
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants