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] Refine reamde and installation #2340

Merged
merged 10 commits into from
Oct 22, 2022

Conversation

zhouzaida
Copy link
Member

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

Please describe the motivation of this PR and the goal you want to achieve through this PR.

Modification

Please briefly describe what modification is made in this PR.

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.

@zhouzaida zhouzaida marked this pull request as draft October 18, 2022 11:01
@zhouzaida zhouzaida modified the milestone: 2329 Oct 19, 2022
@zhouzaida zhouzaida linked an issue Oct 19, 2022 that may be closed by this pull request
@zhouzaida zhouzaida marked this pull request as ready for review October 21, 2022 12:36
@codecov
Copy link

codecov bot commented Oct 22, 2022

Codecov Report

Base: 67.02% // Head: 67.02% // No change to project coverage 👍

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

Additional details and impacted files
@@           Coverage Diff           @@
##              2.x    #2340   +/-   ##
=======================================
  Coverage   67.02%   67.02%           
=======================================
  Files         120      120           
  Lines        7737     7737           
  Branches     1059     1059           
=======================================
  Hits         5186     5186           
  Misses       2386     2386           
  Partials      165      165           
Flag Coverage Δ
unittests 67.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out 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.

@zhouzaida zhouzaida merged commit 5b279fb into open-mmlab:2.x Oct 22, 2022
@zhouzaida zhouzaida deleted the refine-reamde-and-installation branch October 22, 2022 04:43
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.

[doc] Invalid installation command
2 participants