mmocr icon indicating copy to clipboard operation
mmocr copied to clipboard

Add notebook tutorials

Open TommyZihao opened this issue 3 years ago • 1 comments

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.
  • [ ] CLA has been signed and all committers have signed the CLA in this PR.

TommyZihao avatar Mar 28 '22 07:03 TommyZihao

Codecov Report

Merging #887 (7c7ffda) into main (7c90936) will decrease coverage by 0.07%. The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #887      +/-   ##
==========================================
- Coverage   84.17%   84.10%   -0.08%     
==========================================
  Files         168      168              
  Lines       10924    11013      +89     
  Branches     1673     1691      +18     
==========================================
+ Hits         9195     9262      +67     
- Misses       1374     1392      +18     
- Partials      355      359       +4     
Flag Coverage Δ
unittests 84.10% <ø> (-0.08%) :arrow_down:

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

Impacted Files Coverage Δ
mmocr/datasets/pipelines/transforms.py 82.56% <0.00%> (-1.43%) :arrow_down:
mmocr/models/textrecog/recognizer/base.py 55.69% <0.00%> (+0.56%) :arrow_up:
mmocr/utils/ocr.py 77.36% <0.00%> (+1.34%) :arrow_up:
mmocr/datasets/pipelines/crop.py 96.66% <0.00%> (+5.00%) :arrow_up:

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 7c90936...7c7ffda. Read the comment docs.

codecov[bot] avatar Mar 28 '22 16:03 codecov[bot]