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]Update README according to OpenMMLab standard. #65

Merged
merged 6 commits into from
Feb 16, 2022

Conversation

pppppM
Copy link
Collaborator

@pppppM pppppM commented Jan 26, 2022

Motivation

As the title.

Modification

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:

  • 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 tests 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.

@pppppM pppppM requested a review from humu789 January 26, 2022 14:00
@codecov
Copy link

codecov bot commented Jan 26, 2022

Codecov Report

Merging #65 (f2a39bb) into master (64ccbc0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #65   +/-   ##
=======================================
  Coverage   56.58%   56.58%           
=======================================
  Files          83       83           
  Lines        2932     2932           
  Branches      540      540           
=======================================
  Hits         1659     1659           
  Misses       1197     1197           
  Partials       76       76           
Flag Coverage Δ
unittests 56.58% <ø> (ø)

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


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 64ccbc0...f2a39bb. Read the comment docs.

…lab#60)

* Deprecate the support for ``python setup.py test``

* Update requirements
Copy link
Collaborator

@humu789 humu789 left a comment

Choose a reason for hiding this comment

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

README title and paper title had better not all caps, which is not convenient to read.

@humu789 humu789 self-requested a review February 16, 2022 09:59
@humu789 humu789 merged commit 5ec2327 into open-mmlab:master Feb 16, 2022
pppppM added a commit to pppppM/mmrazor that referenced this pull request Jul 15, 2022
* Update README according to OpenMMLab standard.

* [Refactor]Deprecate the support for ``python setup.py test`` (open-mmlab#60)

* Deprecate the support for ``python setup.py test``

* Update requirements

* Upgrade isort in pre-commit hook (open-mmlab#70)

* Update README according to OpenMMLab standard.

* modify uppercase and lowercase

Co-authored-by: whcao <41630003+HIT-cwh@users.noreply.github.com>
pppppM added a commit to pppppM/mmrazor that referenced this pull request Jul 15, 2022
* Update README according to OpenMMLab standard.

* [Refactor]Deprecate the support for ``python setup.py test`` (open-mmlab#60)

* Deprecate the support for ``python setup.py test``

* Update requirements

* Upgrade isort in pre-commit hook (open-mmlab#70)

* Update README according to OpenMMLab standard.

* modify uppercase and lowercase

Co-authored-by: whcao <41630003+HIT-cwh@users.noreply.github.com>
humu789 pushed a commit to humu789/mmrazor that referenced this pull request Feb 13, 2023
* add export info

* add dump-info funciton

* add collect info

* fix lint

* add docstring

* docstring

* docstring
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.

3 participants