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

[Doc] update docstring of RDN #1326

Merged
merged 3 commits into from
Oct 18, 2022
Merged

[Doc] update docstring of RDN #1326

merged 3 commits into from
Oct 18, 2022

Conversation

zengyh1900
Copy link
Collaborator

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Currently, MMEditing supports RDN following https://github.com/yjn870/RDN-pytorch/blob/master/models.py#L21 , whose implementation is slightly different from the official implementation: https://github.com/sanghyun-son/EDSR-PyTorch

Modification

Code has been fixed in #1292 and #1311
In this pull request, we add the official implementation in the docstring.

Who can help? @ them here!

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Before PR:

  • I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
  • Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
  • Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
  • New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects.
  • CLA has been signed and all committers have signed the CLA in this PR.

@zengyh1900 zengyh1900 added priority/P0 highest priority kind/doc fix, add or improve documentations labels Oct 17, 2022
@zengyh1900 zengyh1900 added this to the 0.16.0 milestone Oct 17, 2022
@zengyh1900 zengyh1900 assigned zengyh1900 and unassigned LeoXing1996 Oct 17, 2022
@zengyh1900 zengyh1900 added priority/P1 high priority and removed priority/P0 highest priority labels Oct 17, 2022
@codecov
Copy link

codecov bot commented Oct 17, 2022

Codecov Report

Base: 83.87% // Head: 83.85% // Decreases project coverage by -0.01% ⚠️

Coverage data is based on head (60f7456) compared to base (08424a7).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1326      +/-   ##
==========================================
- Coverage   83.87%   83.85%   -0.02%     
==========================================
  Files         223      223              
  Lines       12736    12736              
  Branches     1990     1990              
==========================================
- Hits        10682    10680       -2     
- Misses       1715     1716       +1     
- Partials      339      340       +1     
Flag Coverage Δ
unittests 83.85% <ø> (-0.02%) ⬇️

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

Impacted Files Coverage Δ
mmedit/models/backbones/sr_backbones/rdn.py 86.66% <ø> (ø)
...ls/components/stylegan2/generator_discriminator.py 89.75% <0.00%> (-1.21%) ⬇️

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.

@zengyh1900 zengyh1900 merged commit 6ba09bd into master Oct 18, 2022
@zengyh1900 zengyh1900 deleted the zengyh1900-patch-1 branch October 18, 2022 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/doc fix, add or improve documentations priority/P1 high priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants