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] Use PyTorch sphinx theme #1321

Merged
merged 6 commits into from
Sep 14, 2021

Conversation

zhouzaida
Copy link
Collaborator

@zhouzaida zhouzaida commented Sep 8, 2021

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

Use PyTorch sphinx theme

Modification

  • docs
  • docs_zh_CN

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, like MMDet or MMCls.
  • CLA has been signed and all committers have signed the CLA in this PR.

@codecov
Copy link

codecov bot commented Sep 8, 2021

Codecov Report

Merging #1321 (a844ee6) into master (9016fef) will increase coverage by 0.32%.
The diff coverage is 92.72%.

❗ Current head a844ee6 differs from pull request most recent head cae1614. Consider uploading reports for the commit cae1614 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1321      +/-   ##
==========================================
+ Coverage   68.81%   69.14%   +0.32%     
==========================================
  Files         161      162       +1     
  Lines       10742    10746       +4     
  Branches     1972     1978       +6     
==========================================
+ Hits         7392     7430      +38     
+ Misses       2962     2927      -35     
- Partials      388      389       +1     
Flag Coverage Δ
unittests 69.14% <92.72%> (+0.32%) ⬆️

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

Impacted Files Coverage Δ
mmcv/cnn/utils/sync_bn.py 84.61% <84.61%> (ø)
mmcv/cnn/bricks/conv_module.py 100.00% <100.00%> (ø)
mmcv/cnn/utils/__init__.py 100.00% <100.00%> (ø)
mmcv/ops/cc_attention.py 90.90% <100.00%> (+52.19%) ⬆️
mmcv/runner/checkpoint.py 74.41% <100.00%> (+0.94%) ⬆️
mmcv/utils/config.py 90.12% <100.00%> (+0.02%) ⬆️
mmcv/version.py 82.35% <100.00%> (ø)
mmcv/cnn/utils/weight_init.py 85.92% <0.00%> (+0.36%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9016fef...cae1614. Read the comment docs.

@zhouzaida zhouzaida added the WIP label Sep 8, 2021
@zhouzaida zhouzaida mentioned this pull request Sep 13, 2021
16 tasks
@zhouzaida zhouzaida removed the WIP label Sep 13, 2021
@ZwwWayne ZwwWayne merged commit 1216e5f into open-mmlab:master Sep 14, 2021
@zhouzaida zhouzaida deleted the use-pytorch-sphinx-theme branch September 20, 2021 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants