update docs

open-mmlab · Sep 13, 2023 · a5f31dc · a5f31dc
1 parent 8a095ac
commit a5f31dc
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 66 deletions.
diff --git a/docs/en/04-supported-codebases/mmdet3d.md b/docs/en/04-supported-codebases/mmdet3d.md
@@ -12,49 +12,28 @@ ______________________________________________________________________
 
 ## Install mmdet3d
 
-These branches are required for mmdet3d deployment
-
-| codebase |  commit   |
-| :------: | :-------: |
-| mmdet3d  | v1.1.0rc1 |
-|   mmcv   | v2.0.0rc1 |
-|  mmdet   | v3.0.0rc1 |
-|  mmseg   | v1.0.0rc0 |
-
-First checkout and install mmcv/mmdet/mmseg/mmdet3d
-
-```bash
-python3 -m pip install openmim --user
-python3 -m mim install mmcv==2.0.0rc1 mmdet==3.0.0rc1 mmseg==1.0.0rc0 --user
-
-git clone https://github.com/open-mmlab/mmdetection3d --branch v1.1.0rc1
-cd mmdetection3d
-python3 -m pip install .
-cd -
-```
-
-After installation, `tools/check_env.py` should display mmdet3d version normally
+We could install mmdet3d through [mim](https://github.com/open-mmlab/mim).
+For other ways of installation, please refer to [here](https://mmdetection3d.readthedocs.io/en/latest/get_started.html#installation)
 
 ```bash
-python3 tools/check_env.py
-..
-11/11 13:56:19 - mmengine - INFO - **********Codebase information**********
-11/11 13:56:19 - mmengine - INFO - mmdet:       3.0.0rc1
-11/11 13:56:19 - mmengine - INFO - mmseg:       1.0.0rc0
-..
-11/11 13:56:19 - mmengine - INFO - mmdet3d:     1.1.0rc1
+python3 -m pip install -U openmim
+python3 -m mim install "mmdet3d>=1.1.0"
 ```
 
 ## Convert model
 
 For example, use `tools/deploy.py` to convert centerpoint to onnxruntime format
 
 ```bash
-export MODEL_CONFIG=/path/to/mmdetection3d/configs/centerpoint/centerpoint_pillar02_second_secfpn_head-circlenms_8xb4-cyclic-20e_nus-3d.py
+# cd to mmdeploy root directory
+# download config and model
+mim download mmdet3d --config centerpoint_pillar02_second_secfpn_head-circlenms_8xb4-cyclic-20e_nus-3d --dest .
+
+export MODEL_CONFIG=centerpoint_pillar02_second_secfpn_head-circlenms_8xb4-cyclic-20e_nus-3d.py
 
-export MODEL_PATH=https://download.openmmlab.com/mmdetection3d/v1.0.0_models/centerpoint/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus_20210816_064624-0f3299c0.pth
+export MODEL_PATH=centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus_20220811_031844-191a3822.pth
 
-export TEST_DATA=/path/to/mmdetection3d/tests/data/nuscenes/sweeps/LIDAR_TOP/n008-2018-09-18-12-07-26-0400__LIDAR_TOP__1537287083900561.pcd.bin
+export TEST_DATA=tests/data/n008-2018-08-01-15-16-36-0400__LIDAR_TOP__1533151612397179.pcd.bin
 
 python3 tools/deploy.py configs/mmdet3d/voxel-detection/voxel-detection_onnxruntime_dynamic.py $MODEL_CONFIG $MODEL_PATH $TEST_DATA --work-dir centerpoint
 ```
@@ -82,4 +61,4 @@ The caller needs to refer to the corresponding [python implementation](../../../
 |            [pointpillars](https://github.com/open-mmlab/mmdetection3d/blob/main/configs/pointpillars/pointpillars_hv_secfpn_8xb6-160e_kitti-3d-3class.py)            |   voxel detection   |  KITTI   |     ✔️      |    ✔️    |     ✔️     |
 |                   [smoke](https://github.com/open-mmlab/mmdetection3d/blob/main/configs/smoke/smoke_dla34_dlaneck_gn-all_4xb8-6x_kitti-mono3d.py)                    | monocular detection |  KITTI   |     ✔️      |    x     |     ✔️     |
 
-- Make sure trt >= 8.4 for some bug fixed, such as ScatterND, dynamic shape crash and so on.
+- Make sure trt >= 8.6 for some bug fixed, such as ScatterND, dynamic shape crash and so on.
diff --git a/docs/zh_cn/04-supported-codebases/mmdet3d.md b/docs/zh_cn/04-supported-codebases/mmdet3d.md
@@ -12,49 +12,28 @@ ______________________________________________________________________
 
 ## 安装 mmdet3d
 
-因为依赖的 codebase 不在 master 分支，所以要切到相应分支：
-
-| codebase |  commit   |
-| :------: | :-------: |
-| mmdet3d  | v1.1.0rc1 |
-|   mmcv   | v2.0.0rc1 |
-|  mmdet   | v3.0.0rc1 |
-|  mmseg   | v1.0.0rc0 |
-
-先安装前置依赖 mmcv/mmdet/mmseg，再安装 mmdet3d
-
-```bash
-python3 -m pip install openmim --user
-python3 -m mim install mmcv==2.0.0rc1 mmdet==3.0.0rc1 mmseg==1.0.0rc0 --user
-
-git clone https://github.com/open-mmlab/mmdetection3d --branch v1.1.0rc1
-cd mmdetection3d
-python3 -m pip install .
-cd -
-```
-
-成功后 `tools/check_env.py` 应能正常显示 mmdet3d 版本号。
+我们可以通过 [mim](https://github.com/open-mmlab/mim) 来安装 mmdet3d.
+更多安装方式可参考该[文档](https://mmdetection3d.readthedocs.io/en/latest/get_started.html#installation)
 
 ```bash
-python3 tools/check_env.py
-..
-11/11 13:56:19 - mmengine - INFO - **********Codebase information**********
-11/11 13:56:19 - mmengine - INFO - mmdet:       3.0.0rc1
-11/11 13:56:19 - mmengine - INFO - mmseg:       1.0.0rc0
-..
-11/11 13:56:19 - mmengine - INFO - mmdet3d:     1.1.0rc1
+python3 -m pip install -U openmim
+python3 -m mim install "mmdet3d>=1.1.0"
 ```
 
 ## 模型转换
 
 使用 `tools/deploy.py` 把 mmdet3d 转到相应后端，以 centerpoint onnxruntime 为例：
 
 ```bash
-export MODEL_CONFIG=/path/to/mmdetection3d/configs/centerpoint/centerpoint_pillar02_second_secfpn_head-circlenms_8xb4-cyclic-20e_nus-3d.py
+# 切换到 mmdeploy 根目录
+# 通过mim下载centerpoint模型
+mim download mmdet3d --config centerpoint_pillar02_second_secfpn_head-circlenms_8xb4-cyclic-20e_nus-3d --dest .
+
+export MODEL_CONFIG=centerpoint_pillar02_second_secfpn_head-circlenms_8xb4-cyclic-20e_nus-3d.py
 
-export MODEL_PATH=https://download.openmmlab.com/mmdetection3d/v1.0.0_models/centerpoint/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus_20210816_064624-0f3299c0.pth
+export MODEL_PATH=centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus_20220811_031844-191a3822.pth
 
-export TEST_DATA=/path/to/mmdetection3d/tests/data/nuscenes/sweeps/LIDAR_TOP/n008-2018-09-18-12-07-26-0400__LIDAR_TOP__1537287083900561.pcd.bin
+export TEST_DATA=tests/data/n008-2018-08-01-15-16-36-0400__LIDAR_TOP__1533151612397179.pcd.bin
 
 python3 tools/deploy.py configs/mmdet3d/voxel-detection/voxel-detection_onnxruntime_dynamic.py $MODEL_CONFIG $MODEL_PATH $TEST_DATA --work-dir centerpoint
 ```
@@ -80,4 +59,4 @@ ls -lah centerpoint
 |            [pointpillars](https://github.com/open-mmlab/mmdetection3d/blob/main/configs/pointpillars/pointpillars_hv_secfpn_8xb6-160e_kitti-3d-3class.py)            |   voxel detection   |  KITTI   |     ✔️      |    ✔️    |     ✔️     |
 |                   [smoke](https://github.com/open-mmlab/mmdetection3d/blob/main/configs/smoke/smoke_dla34_dlaneck_gn-all_4xb8-6x_kitti-mono3d.py)                    | monocular detection |  KITTI   |     ✔️      |    x     |     ✔️     |
 
-- 考虑到 ScatterND、动态 shape 等已知问题，请确保 trt >= 8.4
+- 考虑到 ScatterND、动态 shape 等已知问题，请确保 trt >= 8.6