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

[Doc] Add a tutorial for nuScenes dataset #793

Merged
merged 6 commits into from
Jul 31, 2021

Conversation

Tai-Wang
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.
Add a tutorial for nuScenes dataset.

Modification

Please briefly describe what modification is made in this PR.

  1. Add a tutorial for nuScenes dataset.
  2. Add a Chinese placeholder for the nuScenes tutorial.

BC-breaking (Optional)

Does the modification introduce changes that break the back-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.
No.

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.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@codecov
Copy link

codecov bot commented Jul 27, 2021

Codecov Report

Merging #793 (ad62ac0) into master (9312b34) will increase coverage by 0.09%.
The diff coverage is 65.09%.

❗ Current head ad62ac0 differs from pull request most recent head ec8d944. Consider uploading reports for the commit ec8d944 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master     #793      +/-   ##
==========================================
+ Coverage   48.94%   49.03%   +0.09%     
==========================================
  Files         208      210       +2     
  Lines       15884    15964      +80     
  Branches     2538     2547       +9     
==========================================
+ Hits         7774     7828      +54     
- Misses       7608     7634      +26     
  Partials      502      502              
Flag Coverage Δ
unittests 49.03% <65.09%> (+0.09%) ⬆️

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

Impacted Files Coverage Δ
mmdet3d/apis/test.py 15.78% <0.00%> (ø)
mmdet3d/core/visualizer/show_result.py 66.38% <ø> (ø)
mmdet3d/ops/group_points/group_points.py 31.18% <0.00%> (ø)
mmdet3d/ops/pointnet_modules/paconv_sa_module.py 28.57% <ø> (ø)
mmdet3d/models/segmentors/encoder_decoder.py 20.94% <19.04%> (-0.70%) ⬇️
mmdet3d/models/segmentors/base.py 29.78% <33.33%> (+0.89%) ⬆️
mmdet3d/models/decode_heads/paconv_head.py 43.75% <43.75%> (ø)
mmdet3d/datasets/pipelines/transforms_3d.py 90.39% <60.00%> (-0.48%) ⬇️
mmdet3d/datasets/builder.py 62.06% <100.00%> (+1.35%) ⬆️
mmdet3d/models/decode_heads/__init__.py 100.00% <100.00%> (ø)
... and 7 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 9312b34...ec8d944. Read the comment docs.

Copy link
Contributor

@Wuziyi616 Wuziyi616 left a comment

Choose a reason for hiding this comment

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

Do you think it's reasonable to explain a bit about nuScenes' coordinate system, e.g. NuscBox's definition with our coordinate system? There are several related operation in the codebase. I understand that after refactoring the hack of rotation, the related code is less now. They exist in, e.g. nuscenes_converter.py and output_to_nusc_box in nusc_mono_dataset.

docs/datasets/nuscenes_det.md Outdated Show resolved Hide resolved
docs/datasets/nuscenes_det.md Outdated Show resolved Hide resolved
docs/datasets/nuscenes_det.md Outdated Show resolved Hide resolved
docs/datasets/nuscenes_det.md Outdated Show resolved Hide resolved
docs/datasets/nuscenes_det.md Outdated Show resolved Hide resolved
@Tai-Wang
Copy link
Member Author

Do you think it's reasonable to explain a bit about nuScenes' coordinate system, e.g. NuscBox's definition with our coordinate system? There are several related operation in the codebase. I understand that after refactoring the hack of rotation, the related code is less now. They exist in, e.g. nuscenes_converter.py and output_to_nusc_box in nusc_mono_dataset.

Yes, I add a "Notes" section to explain questions like that.

Copy link
Contributor

@Wuziyi616 Wuziyi616 left a comment

Choose a reason for hiding this comment

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

Great tutorial!

@ZwwWayne ZwwWayne merged commit 3d8eaa2 into open-mmlab:master Jul 31, 2021
@Tai-Wang Tai-Wang deleted the nus_doc branch September 30, 2021 12:08
tpoisonooo added a commit to tpoisonooo/mmdetection3d that referenced this pull request Sep 5, 2022
* make -install -> make install (open-mmlab#621)

change `make -install` to `make install`

open-mmlab/mmdeploy#618

* [Fix] fix csharp api detector release result (open-mmlab#620)

* fix csharp api detector release result

* fix wrong count arg of xxx_release_result in c# api

* [Enhancement] Support two-stage rotated detector TensorRT. (open-mmlab#530)

* upload

* add fake_multiclass_nms_rotated

* delete unused code

* align with pytorch

* Update delta_midpointoffset_rbbox_coder.py

* add trt rotated roi align

* add index feature in nms

* not good

* fix index

* add ut

* add benchmark

* move to csrc/mmdeploy

* update unit test

Co-authored-by: zytx121 <592267829@qq.com>

* Reduce mmcls version dependency (open-mmlab#635)

* fix shufflenetv2 with trt (open-mmlab#645)

* fix shufflenetv2 and pspnet

* fix ci

* remove print

* ' -> " (open-mmlab#654)

If there is a variable in the string, single quotes will ignored it, while double quotes will bring the variable into the string after parsing

* ' -> " (open-mmlab#655)

same with open-mmlab/mmdeploy#654

* Support deployment of Segmenter (open-mmlab#587)

* support segmentor with ncnn

* update regression yml

* replace chunk with split to support ts

* update regression yml

* update docs

* fix segmenter ncnn inference failure brought by open-mmlab#477

* add test

* fix test for ncnn and trt

* fix lint

* export nn.linear to Gemm op in onnx for ncnn

* fix ci

* simplify `Expand` (open-mmlab#617)

* Fix typo (open-mmlab#625)

* Add make install in en docs

* Add make install in zh docs

* Fix typo

* Merge and add windows build

Co-authored-by: tripleMu <865626@163.com>

* [Enhancement] Fix ncnn unittest (open-mmlab#626)

* optmize-csp-darknet

* replace floordiv to torch.div

* update csp_darknet default implement

* fix test

* [Enhancement] TensorRT Anchor generator plugin (open-mmlab#646)

* custom trt anchor generator

* add ut

* add docstring, update doc

* Add partition doc and sample code (open-mmlab#599)

* update torch2onnx tool to support onnx partition

* add model partition of yolov3

* add cn doc

* update torch2onnx tool to support onnx partition

* add model partition of yolov3

* add cn doc

* add to index.rst

* resolve comment

* resolve comments

* fix lint

* change caption level in docs

* update docs (open-mmlab#624)

* Add java apis and demos (open-mmlab#563)

* add java classifier detector

* add segmentor

* fix lint

* add ImageRestorer java apis and demo

* remove useless count parameter for Segmentor and Restorer, add PoseDetector

* add RotatedDetection java api and demo

* add Ocr java demo and apis

* remove mmrotate ncnn java api and demo

* fix lint

* sync java api folder after rebase to master

* fix include

* remove record

* fix java apis dir path in cmake

* add java demo readme

* fix lint mdformat

* add test javaapi ci

* fix lint

* fix flake8

* fix test javaapi ci

* refactor readme.md

* fix install opencv for ci

* fix install opencv : add permission

* add all codebases and mmcv install

* add torch

* install mmdeploy

* fix image path

* fix picture path

* fix import ncnn

* fix import ncnn

* add submodule of pybind

* fix pybind submodule

* change download to git clone for submodule

* fix ncnn dir

* fix README error

* simplify the github ci

* fix ci

* fix yapf

* add JNI as required

* fix Capitalize

* fix Capitalize

* fix copyright

* ignore .class changed

* add OpenJDK installation docs

* install target of javaapi

* simplify ci

* add jar

* fix ci

* fix ci

* fix test java command

* debugging what failed

* debugging what failed

* debugging what failed

* add java version info

* install openjdk

* add java env var

* fix export

* fix export

* fix export

* fix export

* fix picture path

* fix picture path

* fix file name

* fix file name

* fix README

* remove java_api strategy

* fix python version

* format task name

* move args position

* extract common utils code

* show image class result

* add detector result

* segmentation result format

* add ImageRestorer result

* add PoseDetection java result format

* fix ci

* stage ocr

* add visualize

* move utils

* fix lint

* fix ocr bugs

* fix ci demo

* fix java classpath for ci

* fix popd

* fix ocr demo text garbled

* fix ci

* fix ci

* fix ci

* fix path of utils ci

* update the circleci config file by adding workflows both for linux, windows and linux-gpu (open-mmlab#368)

* update circleci by adding more workflows

* fix test workflow failure on windows platform

* fix docker exec command for SDK unittests

* Fixed tensorrt plugin not found in Windows (open-mmlab#672)

* update introduction.png (open-mmlab#674)

* [Enhancement] Add fuse select assign pass (open-mmlab#589)

* Add fuse select assign pass

* move code to csrc

* add config flag

* remove bool cast

* fix export sdk info of input shape (open-mmlab#667)

* Update get_started.md (open-mmlab#675)

Fix backend model assignment

* Update get_started.md (open-mmlab#676)

Fix backend model assignment

* [Fix] fix clang build (open-mmlab#677)

* fix clang build

* fix ndk build

* fix ndk build

* switch to `std::filesystem` for clang-7 and later

* Deploy the Swin Transformer on TensorRT. (open-mmlab#652)

* resolve conflicts

* update ut and docs

* fix ut

* refine docstring

* add comments and refine UT

* resolve comments

* resolve comments

* update doc

* add roll export

* check backend

* update regression test

* bump version to 0.6.0 (open-mmlab#680)

* bump vertion to 0.6.0

* update version

* pass img_metas while exporting to onnx (open-mmlab#681)

* pass img_metas while exporting to onnx

* remove try-catch in tools for beter debugging

* use get

* fix typo

* [Fix] fix ssd ncnn ut (open-mmlab#692)

* fix ssd ncnn ut

* fix yapf

* fix passing img_metas to pytorch2onnx for mmedit (open-mmlab#700)

* fix passing img_metas for mmdet3d (open-mmlab#707)

* [Fix] Fix android build (open-mmlab#698)

* fix android build

* fix cmake

* fix url link

* fix wrong exit code in pipeline_manager (open-mmlab#715)

* fix exit

* change to general exit errorcode=1

* fix passing wrong backend type (open-mmlab#719)

* Rename onnx2ncnn to mmdeploy_onnx2ncnn (open-mmlab#694)

* improvement(tools/onnx2ncnn.py): rename to mmdeploy_onnx2ncnn

* format(tools/deploy.py): clean code

* fix(init_plugins.py): improve if condition

* fix(CI): update target

* fix(test_onnx2ncnn.py): update desc

* Update init_plugins.py

* [Fix] Fix mmdet ort static shape bug (open-mmlab#687)

* fix shape

* add device

* fix yapf

* fix rewriter for transforms

* reverse image shape

* fix ut of distance2bbox

* fix rewriter name

* fix c4 for torchscript (open-mmlab#724)

* [Enhancement] Standardize C API (open-mmlab#634)

* unify C API naming

* fix demo and move apis/c/* -> apis/c/mmdeploy/*

* fix lint

* fix C# project

* fix Java API

* [Enhancement] Support Slide Vertex TRT (open-mmlab#650)

* reorgnize mmrotate

* fix

* add hbb2obb

* add ut

* fix rotated nms

* update docs

* update benchmark

* update test

* remove ort regression test, remove comment

* Fix get-started rendering issues in readthedocs (open-mmlab#740)

* fix mermaid markdown rendering issue in readthedocs

* fix error in C++ example

* fix error in c++ example in zh_cn get_started doc

* [Fix] set default topk for dump info (open-mmlab#702)

* set default topk for dump info

* remove redundant docstrings

* add ci densenet

* fix classification warnings

* fix mmcls version

* fix logger.warnings

* add version control (open-mmlab#754)

* fix satrn for ORT (open-mmlab#753)

* fix satrn for ORT

* move rewrite into pytorch

* Add inference latency test tool (open-mmlab#665)

* add profile tool

* remove print envs in profile tool

* set cudnn_benchmark to True

* add doc

* update tests

* fix typo

* support test with images from a directory

* update doc

* resolve comments

* [Enhancement] Add CSE ONNX pass (open-mmlab#647)

* Add fuse select assign pass

* move code to csrc

* add config flag

* Add fuse select assign pass

* Add CSE for ONNX

* remove useless code

* Test robot

Just test robot

* Update README.md

Revert

* [Fix] fix yolox point_generator (open-mmlab#758)

* fix yolox point_generator

* add a UT

* resolve comments

* fix comment lines

* limit markdown version (open-mmlab#773)

* [Enhancement] Better index put ONNX export. (open-mmlab#704)

* Add rewriter for tensor setitem

* add version check

* Upgrade Dockerfile to use TensorRT==8.2.4.2 (open-mmlab#706)

* Upgrade TensorRT to 8.2.4.2

* upgrade pytorch&mmcv in CPU Dockerfile

* Delete redundant port example in Docker

* change 160x160-608x608 to 64x64-608x608 for yolov3

* [Fix] reduce log verbosity & improve error reporting (open-mmlab#755)

* reduce log verbosity & improve error reporting

* improve error reporting

* [Enhancement] Support latest ppl.nn & ppl.cv (open-mmlab#564)

* support latest ppl.nn

* fix pplnn for model convertor

* fix lint

* update memory policy

* import algo from buffer

* update ppl.cv

* use `ppl.cv==0.7.0`

* document supported ppl.nn version

* skip pplnn dependency when building shared libs

* [Fix][P0] Fix for torch1.12 (open-mmlab#751)

* fix for torch1.12

* add comment

* fix check env (open-mmlab#785)

* [Fix] fix cascade mask rcnn (open-mmlab#787)

* fix cascade mask rcnn

* fix lint

* add regression

* [Feature] Support RoITransRoIHead (open-mmlab#713)

* [Feature] Support RoITransRoIHead

* Add docs

* Add mmrotate models regression test

* Add a draft for test code

* change the argument name

* fix test code

* fix minor change for not class agnostic case

* fix sample for test code

* fix sample for test code

* Add mmrotate in requirements

* Revert "Add mmrotate in requirements"

This reverts commit 043490075e6dbe4a8fb98e94b2b583b91fc5038d.

* [Fix] fix triu (open-mmlab#792)

* fix triu

* triu -> triu_default

* [Enhancement] Install Optimizer by setuptools (open-mmlab#690)

* Add fuse select assign pass

* move code to csrc

* add config flag

* Add fuse select assign pass

* Add CSE for ONNX

* remove useless code

* Install optimizer by setup tools

* fix comment

* [Feature] support MMRotate model with le135 (open-mmlab#788)

* support MMRotate model with le135

* cse before fuse select assign

* remove unused import

* [Fix] Support macOS build (open-mmlab#762)

* fix macOS build

* fix missing

* add option to build & install examples (open-mmlab#822)

* [Fix] Fix setup on non-linux-x64 (open-mmlab#811)

* fix setup

* replace long to int64_t

* [Feature] support build single sdk library (open-mmlab#806)

* build single lib for c api

* update csharp doc & project

* update test build

* fix test build

* fix

* update document for building android sdk (open-mmlab#817)

Co-authored-by: dwSun <dwsunny@icloud.com>

* [Enhancement] support kwargs in SDK python bindings (open-mmlab#794)

* support-kwargs

* make '__call__' as single image inference and add 'batch' API to deal with batch images inference

* fix linting error and typo

* fix lint

* improvement(sdk): add sdk code coverage (open-mmlab#808)

* feat(doc): add CI

* CI(sdk): add sdk coverage

* style(test): code format

* fix(CI): update coverage.info path

* improvement(CI): use internal image

* improvement(CI): push coverage info once

* [Feature] Add C++ API for SDK (open-mmlab#831)

* add C++ API

* unify result type & add examples

* minor fix

* install cxx API headers

* fix Mat, add more examples

* fix monolithic build & fix lint

* install examples correctly

* fix lint

* feat(tools/deploy.py): support snpe (open-mmlab#789)

* fix(tools/deploy.py): support snpe

* improvement(backend/snpe): review advices

* docs(backend/snpe): update build

* docs(backend/snpe): server support specify port

* docs(backend/snpe): update path

* fix(backend/snpe): time counter missing argument

* docs(backend/snpe): add missing argument

* docs(backend/snpe): update download and using

* improvement(snpe_net.cpp): load model with modeldata

* Support setup on environment with no PyTorch (open-mmlab#843)

* support test with multi batch (open-mmlab#829)

* support test with multi batch

* resolve comment

* import algorithm from buffer (open-mmlab#793)

* [Enhancement] build sdk python api in standard-alone manner (open-mmlab#810)

* build sdk python api in standard-alone manner

* enable MMDEPLOY_BUILD_SDK_MONOLITHIC and MMDEPLOY_BUILD_EXAMPLES in prebuild config

* link mmdeploy to python target when monolithic option is on

* checkin README to describe precompiled package build procedure

* use packaging.version.parse(python_version) instead of list(python_version)

* fix according to review results

* rebase master

* rollback cmake.in and apis/python/CMakeLists.txt

* reorganize files in install/example

* let cmake detect visual studio instead of specifying 2019

* rename whl name of precompiled package

* fix according to review results

* Fix SDK backend (open-mmlab#844)

* fix mmpose python api (open-mmlab#852)

* add prebuild package usage docs on windows (open-mmlab#816)

* add prebuild package usage docs on windows

* fix lint

* update

* try fix lint

* add en docs

* update

* update

* udpate faq

* fix typo (open-mmlab#862)

* [Enhancement] Improve get_started documents and bump version to 0.7.0 (open-mmlab#813)

* simplify commands in get_started

* add installation commands for Windows

* fix typo

* limit markdown and sphinx_markdown_tables version

* adopt html <details open> tag

* bump mmdeploy version

* bump mmdeploy version

* update get_started

* update get_started

* use python3.8 instead of python3.7

* remove duplicate section

* resolve issue open-mmlab#856

* update according to review results

* add reference to prebuilt_package_windows.md

* fix error when build sdk demos

* fix mmcls

Co-authored-by: Ryan_Huang <44900829+DrRyanHuang@users.noreply.github.com>
Co-authored-by: Chen Xin <xinchen.tju@gmail.com>
Co-authored-by: q.yao <yaoqian@sensetime.com>
Co-authored-by: zytx121 <592267829@qq.com>
Co-authored-by: Li Zhang <lzhang329@gmail.com>
Co-authored-by: tripleMu <gpu@163.com>
Co-authored-by: tripleMu <865626@163.com>
Co-authored-by: hanrui1sensetime <83800577+hanrui1sensetime@users.noreply.github.com>
Co-authored-by: lvhan028 <lvhan_028@163.com>
Co-authored-by: Bryan Glen Suello <11388006+bgsuello@users.noreply.github.com>
Co-authored-by: zambranohally <63218980+zambranohally@users.noreply.github.com>
Co-authored-by: AllentDan <41138331+AllentDan@users.noreply.github.com>
Co-authored-by: tpoisonooo <khj.application@aliyun.com>
Co-authored-by: Hakjin Lee <nijkah@gmail.com>
Co-authored-by: 孙德伟 <5899962+dwSun@users.noreply.github.com>
Co-authored-by: dwSun <dwsunny@icloud.com>
Co-authored-by: Chen Xin <irexyc@gmail.com>
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