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] Add Chinese documentation for inferencer. #884

Merged
merged 14 commits into from
Jan 16, 2023

Conversation

HAOCHENYE
Copy link
Collaborator

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 repos?
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

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

HAOCHENYE and others added 14 commits January 6, 2023 14:14
* Update BaseInferencer

* Fix ci

* Fix CI and rename iferencer to infer

* Fix CI

* Add renamed file

* Add test file

* Adjust interface sequence

* refine preprocess

* Update unit test

Update unit test

* Update unit test

* Fix unit test

* Fix as comment

* Minor refine

* Fix docstring and support load image from different backend

* Support load collate_fn from downstream repos, refine dispatch

* Minor refine

* Fix lint

* refine grammar

* Remove FileClient

* Refine docstring

* add rich

* Add list_models

* Add list_models

* Remove backend args

* Minor refine
* Add preprocess inputs

* Add type hint

* update api/infer in index.rst

* rename preprocess_inputs to _inputs_to_list

* Fix doc format

* Update infer.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
* first commit

* [Enhance] Support build model from weight

* minor refine

* Fix type hint

* refine comments

* Update docstring

* refine as comment

* Add  method

* Refine docstring

* Fix as comment

* refine comments

* Refine warning message

* Fix unit test and refine comments
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
@HAOCHENYE HAOCHENYE changed the title [Docs] Add documentation for inferencer. [Docs] Add Chinese documentation for inferencer. Jan 16, 2023
@codecov
Copy link

codecov bot commented Jan 16, 2023

Codecov Report

Base: 78.66% // Head: 78.19% // Decreases project coverage by -0.47% ⚠️

Coverage data is based on head (9577b7d) compared to base (fe26c65).
Patch coverage: 66.75% of modified lines in pull request are covered.

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #884      +/-   ##
==========================================
- Coverage   78.66%   78.19%   -0.48%     
==========================================
  Files         128      132       +4     
  Lines        9348     9967     +619     
  Branches     1848     1992     +144     
==========================================
+ Hits         7354     7794     +440     
- Misses       1679     1836     +157     
- Partials      315      337      +22     
Flag Coverage Δ
unittests 78.19% <66.75%> (-0.48%) ⬇️

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

Impacted Files Coverage Δ
mmengine/device/utils.py 66.66% <0.00%> (-2.30%) ⬇️
mmengine/model/base_model/base_model.py 80.48% <0.00%> (-4.13%) ⬇️
mmengine/model/wrappers/__init__.py 66.66% <ø> (-3.34%) ⬇️
mmengine/optim/__init__.py 100.00% <ø> (ø)
mmengine/optim/optimizer/zero_optimizer.py 52.17% <0.00%> (-4.97%) ⬇️
mmengine/optim/scheduler/__init__.py 100.00% <ø> (ø)
mmengine/registry/build_functions.py 80.20% <ø> (ø)
mmengine/registry/default_scope.py 100.00% <ø> (ø)
mmengine/structures/label_data.py 100.00% <ø> (ø)
mmengine/utils/dl_utils/parrots_wrapper.py 44.77% <ø> (-3.76%) ⬇️
... and 49 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 50465a2 into open-mmlab:main Jan 16, 2023
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