Fix docstring format #495

triple-Mu · 2022-05-18T08:13:23Z

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily receiving feedbacks. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
Describe the feature
As shown in the following picture, there are unpleasant blanks in the strings.
We need to remove them.

Motivation

There are unpleasant blanks in the strings in doc common，we need to remove them.
So I fix doc common and remove '' which is used for switching a new line.

Modification

Files change
mmdeploy/apis/calibration.py ,
mmdeploy/apis/inference.py ,
mmdeploy/apis/pytorch2onnx.py ,
mmdeploy/apis/visualize.py ,
mmdeploy/backend/tensorrt/onnx2tensorrt.py

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

Pre-commit or other linting tools are used to fix the potential lint issues.
The modification is covered by complete unit tests. If not, please add more unit tests to ensure the correctness.
If the modification has a dependency on downstream projects of a newer version, this PR should be tested with all supported versions of downstream projects.
The documentation has been modified accordingly, like docstring or example tutorials.

codecov · 2022-05-18T08:26:23Z

Codecov Report

Merging #495 (21f7f0d) into master (a4de9f3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #495   +/-   ##
=======================================
  Coverage   63.13%   63.13%           
=======================================
  Files         212      212           
  Lines        7177     7177           
  Branches     1110     1110           
=======================================
  Hits         4531     4531           
  Misses       2322     2322           
  Partials      324      324

Flag	Coverage Δ
unittests	`63.13% <ø> (ø)`

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

Impacted Files	Coverage Δ
mmdeploy/apis/calibration.py	`19.04% <ø> (ø)`
mmdeploy/apis/inference.py	`40.00% <ø> (ø)`
mmdeploy/apis/pytorch2onnx.py	`64.51% <ø> (ø)`
mmdeploy/apis/visualize.py	`28.00% <ø> (ø)`
mmdeploy/backend/tensorrt/onnx2tensorrt.py	`0.00% <ø> (ø)`

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 a4de9f3...21f7f0d. Read the comment docs.

lvhan028 · 2022-05-18T09:36:07Z

Hi, @triple-Mu Could you please describe this PR more clearly in the title?

lvhan028 · 2022-05-20T02:39:52Z

mmdeploy/apis/calibration.py

+        >>> model_cfg = ('mmdetection/configs/fcos/'
+                         'fcos_r50_caffe_fpn_gn-head_1x_coco.py')
+        >>> model_checkpoint = ('checkpoints/'
+                                'fcos_r50_caffe_fpn_gn-head_1x_coco-821213aa.pth')
        >>> create_calib_table(calib_file, deploy_cfg, \


Can '\' be also removed from create_calib_table?

lvhan028 · 2022-05-20T02:40:38Z

mmdeploy/apis/inference.py

+        >>> model_cfg = ('mmdetection/configs/fcos/'
+                         'fcos_r50_caffe_fpn_gn-head_1x_coco.py')
+        >>> deploy_cfg = ('configs/mmdet/detection/'
+                          'detection_onnxruntime_dynamic.py')
        >>> backend_files = ['work_dir/fcos.onnx']
        >>> img = 'demo.jpg'
        >>> device = 'cpu'
        >>> model_output = inference_model(model_cfg, deploy_cfg, \


Can '\' be also removed from inference_model?

mmdeploy/backend/tensorrt/onnx2tensorrt.py

lvhan028 · 2022-05-23T06:48:42Z

related issue #488

RunningLeon

LGTM

* Fix doc common * Fix bugs (cherry picked from commit de3f18f)

* fix pose demo and windows build (#307) * add postprocessing_masks gpu version (#276) * add postprocessing_masks gpu version * default device cpu * pre-commit fix Co-authored-by: hadoop-basecv <hadoop-basecv@set-gh-basecv-serving-classify11.mt> * fixed a bug causes text-recognizer to fail when (non-NULL) empty bboxes list is passed (#310) * [Fix] include missing <type_traits> for formatter.h (#313) * fix formatter * relax GCC version requirement * [Fix] MMEditing cannot save results when testing (#336) * fix show * lint * remove redundant codes * resolve comment * type hint * docs(build): fix typo (#352) * docs(build): add missing build option * docs(build): add onnx install * style(doc): trim whitespace * docs(build): revert install onnx * docs(build): add ncnn LD_LIBRARY_PATH * docs(build): fix path error * fix openvino export tmp model, add binary flag (#353) * init circleci (#348) * fix wrong input mat type (#362) * fix wrong input mat type * fix lint * fix(docs): remove redundant doc tree (#360) * fix missing ncnn_DIR & InferenceEngine_DIR (#364) * Fix mmdet openvino dynamic 300x300 cfg base (#372) * Fix: add onnxruntime building option in gpu dockerfile (#366) * Tutorial 03: torch2onnx (#365) * upload doc * add images * resolve comments * update translation * [Docs] fix ncnn docs (#378) * fix ncnn docs` * update 0216 * typo-fix (#397) * add CUDA_TOOKIT_ROOT_DIR as tensorrt detect dir (#357) * add CUDA_TOOKIT_ROOT_DIR as tensorrt detect dir * Update FindTENSORRT.cmake * Fix docs (#398) * ort_net ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL (#383) * fix wrong buffer which will case onnxruntime-gpu crash with segmentaion (#363) * fix wrong buffer which will case onnxruntime-gpu crash with segmentaion * fix check * fix build error * remove unused header * fix benchmark (#411) * Add `sm_53` in cuda.cmake for Jetson Nano which will cashe when process sdk predict. (#407) * [Fix] fix feature test for `std::source_location` (#416) * fix feature test for `std::source_location` * suppress msvc warnings * fix consistency * fix format string (#417) * [Fix] Fix seg name (#394) * fix seg name * use default name Co-authored-by: dongchunyu.vendor <dongchunyu@pjlab.org.cn> * 【Docs】Add ipython notebook tutorial (#234) * add ipynb file * rename file * add open in colab tag * fix lint and add img show * fix open in colab link * fix comments * fix pre-commit config * fix mmpose api (#396) * fix mmpose api * use fmt::format instead * fix potential nullptr access * [Fix] support latest spdlog (#423) * support formatting `PixelFormat` & `DataType` * format enum for legacy spdlog * fix format * fix pillarencode (#331) * fix ONNXRuntime cuda test bug (#438) * Fix ci in master branch (#441) * [Doc] Improve Jetson tutorial install doc (#381) * Improve Jetson build doc * add torchvision in the doc * Fix lint * Fix lint * Fix lint * Fix arg bug * remove incorrect process * Improve doc * Add more detail on `Conda` * Add python version detail * Install `onnx` instead of `onnxruntime` * Fix gramma * Fix gramma * Update Installation detail and fix some doc detail * Update how_to_install_mmdeploy_on_jetsons.md * Fix tensorrt and cudnn path * Improve FAQ * Improve FAQs * pplcv not switch branch since the `sm_53` missing * Update how_to_install_mmdeploy_on_jetsons.md * Update how_to_install_mmdeploy_on_jetsons.md * Update how_to_install_mmdeploy_on_jetsons.md * Update how_to_install_mmdeploy_on_jetsons.md * Improve doc * Update how_to_install_mmdeploy_on_jetsons.md * export `TENSORRT_DIR` * Using pre-build cmake to update * Improve sentence and add jetpack version * Improve sentence * move TENSORRT_DIR in the `Make TensorRT env` step * Improve CUDA detail * Update how_to_install_mmdeploy_on_jetsons.md * Update how_to_install_mmdeploy_on_jetsons.md * Improve conda installation * Improve TensorRT installation * Fix lint * Add pip crash detail and FAQ * Improve pip crash * refine the jetson installation guide * Improve python version * Improve doc, added some detail * Fix lint * Add detail for `Runtime` problem * Fix word * Update how_to_install_mmdeploy_on_jetsons.md Co-authored-by: lvhan028 <lvhan_028@163.com> * Version comments added, torch install steps added. (#449) * [Docs] Fix API documentation (#443) * [Docs] Fix API documentation * add onnx dependency in readthedocs.txt * fix dependencies * [Fix] Fix display bugs for windows (#451) * fix issue 330 for windows * fix code * fix lint * fix all platform * [Docs] Minor fixes and translation of installation tutorial for Jetson (#415) * minor fixes * add Jetson installation * updated zh_cn based on new en version * If a cuda launch error occurs, verify if cuda device requires top_k t… (#479) * If a cuda launch error occurs, verify if cuda device requires top_k to be reduced. * Fixed lint * Clang format * Fixed lint, clang-format * [Fix] set optional arg a default value (#483) * optional default value * resolve comments Co-authored-by: dongchunyu.vendor <dongchunyu@pjlab.org.cn> * Update: Optimize document (#484) * Update: Optimize document - Minor fixes in styling and grammar - Add support for Jetson Xavier NX (Tested and worked) - Add hardware recommendation - Change JetPack installation guide URL from jp5.0 to jp4.6.1 - Add a note to select "Jetson SDK Components" when using NVIDIA SDK Manager - Change PyTorch wheel save location - Add more dependencies needed for torchvision installation. Otherwise installation error - Simplify torchvision git cloning branch - Add installation times for torchvision, MMCV, versioned-hdf5, ppl.cv, model converter, SDK libraries - Delete "snap" from cmake removal as "apt-get purge" is enough - Add a note on which scenarios you need to append cu da path and libraries to PATH and LD_LIBRARY_PATH - Simplify MMCV git cloning branch - Delete "skip if you don't need MMDeploy C/C++ Inference SDK", because that is the only available inference SDK at the moment - Add more details to object detection demo using C/C++ Inference SDK such as installing MMDetection and converting a model - Add image of inference result - Delete "set env for pip" in troubleshooting because this is already mentioned under "installing Archiconda" Signed-off-by: Lakshantha Dissanayake <lakshanthad@seeed.cc> * Fix: note style on doc * Fix: Trim trailing whitespaces * Update: add source image before inference * fix: bbox_nms not onnxizing if batch size > 1 (#501) A typo prevents nms from onnxizing correctly if batch size is static and greater than 1. * change seperator of function marker (#499) * [docs] Fix typo in tutorial (#509) * Fix docstring format (#495) * Fix doc common * Fix bugs * Tutorial 04: onnx custom op (#508) * Add tutorial04 * lint * add image * resolve comment * fix mmseg twice resize (#480) * fix mmseg twich resize * remove comment * Fix mask test with mismatched device (#511) * align mask output to cpu device * align ncnn ssd output to torch.Tensor type * --amend * compat mmpose v0.26 (#518) * [Docs] adding new backends when using MMDeploy as a third package (#482) * update doc * refine expression * cn doc * Tutorial 05: ONNX Model Editing (#517) * tutorial 05 * Upload image * resolve comments * resolve comment * fix pspnet torchscript conversion (#538) * fix pspnet torchscript conversion * resolve comment * add IR to rewrite * changing the onnxwrapper script for gpu issue (#532) * changing the onnxwrapper script * gpu_issue * Update wrapper.py * Update wrapper.py * Update runtime.txt * Update runtime.txt * Update wrapper.py Co-authored-by: Chen Xin <xinchen.tju@gmail.com> Co-authored-by: Shengxi Li <982783556@qq.com> Co-authored-by: hadoop-basecv <hadoop-basecv@set-gh-basecv-serving-classify11.mt> Co-authored-by: lzhangzz <lzhang329@gmail.com> Co-authored-by: Yifan Zhou <singlezombie@163.com> Co-authored-by: tpoisonooo <khj.application@aliyun.com> Co-authored-by: HinGwenWoong <peterhuang0323@outlook.com> Co-authored-by: Junjie <61398820+Adenialzz@users.noreply.github.com> Co-authored-by: hanrui1sensetime <83800577+hanrui1sensetime@users.noreply.github.com> Co-authored-by: q.yao <streetyao@live.com> Co-authored-by: Song Lin <92794867+triple-Mu@users.noreply.github.com> Co-authored-by: zly19540609 <31341706+zly19540609@users.noreply.github.com> Co-authored-by: RunningLeon <mnsheng@yeah.net> Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> Co-authored-by: AllentDan <41138331+AllentDan@users.noreply.github.com> Co-authored-by: dongchunyu.vendor <dongchunyu@pjlab.org.cn> Co-authored-by: VVsssssk <88368822+VVsssssk@users.noreply.github.com> Co-authored-by: NagatoYuki0943 <72508155+NagatoYuki0943@users.noreply.github.com> Co-authored-by: Johannes L <tehkillerbee@users.noreply.github.com> Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com> Co-authored-by: chaoqun <cdongae@connect.ust.hk> Co-authored-by: Lakshantha Dissanayake <lakshanthad@yahoo.com> Co-authored-by: Yifan Gu <gyf304@users.noreply.github.com> Co-authored-by: Zhiqiang Wang <zhiqwang@foxmail.com> Co-authored-by: sanjaypavo <93761297+sanjaypavo@users.noreply.github.com>

Fix doc common

56ba799

lvhan028 requested review from hanrui1sensetime and RunningLeon May 18, 2022 09:35

lvhan028 reviewed May 20, 2022

View reviewed changes

triple-Mu and others added 2 commits May 22, 2022 19:57

Merge branch 'open-mmlab:master' into tripleMu-1

15e031f

Fix bugs

21f7f0d

lvhan028 changed the title ~~Fix doc common~~ Fix docstring format May 23, 2022

lvhan028 approved these changes May 23, 2022

View reviewed changes

RunningLeon approved these changes May 23, 2022

View reviewed changes

RunningLeon merged commit de3f18f into open-mmlab:master May 23, 2022

lvhan028 mentioned this pull request May 27, 2022

[Refactor][API2.0] Api partition calibration #433

Merged

1 task

RunningLeon mentioned this pull request May 30, 2022

[Refactor][API2.0] API for TensorRT #519

Merged

2 tasks

lvhan028 pushed a commit to lvhan028/mmdeploy that referenced this pull request Jun 7, 2022

Fix docstring format (open-mmlab#495)

1037265

* Fix doc common * Fix bugs (cherry picked from commit de3f18f)

lvhan028 mentioned this pull request Jun 16, 2022

[Docs] Replace markdownlint with mdformat and configure myst-parser #493

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix docstring format #495

Fix docstring format #495

triple-Mu commented May 18, 2022 •

edited

Loading

codecov bot commented May 18, 2022 •

edited

Loading

lvhan028 commented May 18, 2022

lvhan028 May 20, 2022

lvhan028 May 20, 2022

lvhan028 commented May 23, 2022 •

edited

Loading

RunningLeon left a comment

Fix docstring format #495

Fix docstring format #495

Conversation

triple-Mu commented May 18, 2022 • edited Loading

Motivation

Modification

BC-breaking (Optional)

Use cases (Optional)

Checklist

codecov bot commented May 18, 2022 • edited Loading

Codecov Report

lvhan028 commented May 18, 2022

lvhan028 May 20, 2022

Choose a reason for hiding this comment

lvhan028 May 20, 2022

Choose a reason for hiding this comment

lvhan028 commented May 23, 2022 • edited Loading

RunningLeon left a comment

Choose a reason for hiding this comment

triple-Mu commented May 18, 2022 •

edited

Loading

codecov bot commented May 18, 2022 •

edited

Loading

lvhan028 commented May 23, 2022 •

edited

Loading