Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Enhance] Improve Swin Doc and Add Tabs enxtation #1145

Merged
merged 13 commits into from
Nov 4, 2022

Conversation

Ezra-Yu
Copy link
Collaborator

@Ezra-Yu Ezra-Yu commented Oct 27, 2022

Motivation

Improve Swin Doc

Modification

  1. Add Tabs enxtation
    image

  2. folded the abstract

  3. improve the readme of swin and swinv2.

Use cases (Optional)

<!-- [TABS-BEGIN] -->

**Predict image**  # tab1

Content1  without "**xxxx**"

**Use the model**    # tab2

Content2  without "**xxxx**"

**Command**          # tab3

Content3 without "**xxxx**"

<!-- [TABS-END] -->

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

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

@codecov
Copy link

codecov bot commented Oct 28, 2022

Codecov Report

Base: 0.02% // Head: 91.29% // Increases project coverage by +91.27% 🎉

Coverage data is based on head (b53dbd0) compared to base (b8b31e9).
Patch has no changes to coverable lines.

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

Additional details and impacted files
@@             Coverage Diff              @@
##           dev-1.x    #1145       +/-   ##
============================================
+ Coverage     0.02%   91.29%   +91.27%     
============================================
  Files          121      136       +15     
  Lines         8217     9988     +1771     
  Branches      1368     1577      +209     
============================================
+ Hits             2     9119     +9117     
+ Misses        8215      660     -7555     
- Partials         0      209      +209     
Flag Coverage Δ
unittests 91.29% <ø> (+91.27%) ⬆️

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

Impacted Files Coverage Δ
mmcls/apis/inference.py 0.00% <0.00%> (ø)
mmcls/datasets/transforms/compose.py
mmcls/models/backbones/deit3.py 94.52% <0.00%> (ø)
mmcls/structures/utils.py 77.77% <0.00%> (ø)
mmcls/models/backbones/swin_transformer_v2.py 89.47% <0.00%> (ø)
mmcls/models/backbones/mobilevit.py 91.15% <0.00%> (ø)
mmcls/models/backbones/mvit.py 92.46% <0.00%> (ø)
mmcls/models/retrievers/__init__.py 100.00% <0.00%> (ø)
mmcls/models/backbones/mobileone.py 94.47% <0.00%> (ø)
mmcls/models/retrievers/base.py 100.00% <0.00%> (ø)
... and 126 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.

configs/swin_transformer/README.md Outdated Show resolved Hide resolved
configs/swin_transformer/README.md Outdated Show resolved Hide resolved
configs/swin_transformer/README.md Show resolved Hide resolved
Copy link
Collaborator

@tonysy tonysy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mzr1996 mzr1996 merged commit 63b124e into open-mmlab:dev-1.x Nov 4, 2022
mzr1996 added a commit to mzr1996/mmpretrain that referenced this pull request Nov 24, 2022
* improve_swin_doc

* fix requirments

* improve swin2 docs

* improve swin2 docs

* update

* update CN doc

* update CN doc

* update comments

* fix error

* update register_all_modules

* Update README.md

* Update stat.py

* Update readme

Co-authored-by: mzr1996 <mzr1996@163.com>
@Ezra-Yu Ezra-Yu deleted the improve_swin_doc branch April 13, 2023 11:57
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants