Bump version to 1.1.0 (open-mmlab#2380)

* init commit * add contribution guides link * polish docs * rename 1.1.0 and corresponding modification * polish docs * polish docs * minor fix
autowarefoundation · Apr 6, 2023 · 3603925 · 3603925
1 parent bfaf809
commit 3603925
Show file tree

Hide file tree

Showing 30 changed files with 118 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@
   </div>
   <div>&nbsp;</div>
 
-[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdetection3d.readthedocs.io/en/1.1/)
+[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdetection3d.readthedocs.io/en/latest/)
 [![badge](https://github.com/open-mmlab/mmdetection3d/workflows/build/badge.svg)](https://github.com/open-mmlab/mmdetection3d/actions)
 [![codecov](https://codecov.io/gh/open-mmlab/mmdetection3d/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdetection3d)
 [![license](https://img.shields.io/github/license/open-mmlab/mmdetection3d.svg)](https://github.com/open-mmlab/mmdetection3d/blob/master/LICENSE)
@@ -52,6 +52,10 @@
 **We have renamed the branch `1.1`  to `main` and switched the default branch from `master` to `main`. We encourage
 users to migrate to the latest version, though it comes with some cost. Please refer to [Migration Guide](docs/en/migration.md) for more details.**
 
+**v1.1.0** was released in 6/4/2023
+
+We have supported more LiDAR-based segmentation methods, including Cylinder3D, MinkUNet and SPVCNN. More new features about 3D perception are on the way. Please stay tuned!
+
 **v1.1.0rc3** was released in 7/1/2023
 
 The compatibilities of models are broken due to the unification and simplification of coordinate systems after v1.0.0rc0. For now, most models are benchmarked with similar performance, though few models are still being benchmarked. In the following release, we will update all the model checkpoints and benchmarks. See more details in the [Changelog](docs/en/notes/changelog.md) and [Changelog-v1.0.x](docs/en/notes/changelog_v1.0.x.md).
@@ -78,7 +82,7 @@ a part of the OpenMMLab project developed by [MMLab](http://mmlab.ie.cuhk.edu.hk
 - **Support indoor/outdoor 3D detection out of box**
 
   It directly supports popular indoor and outdoor 3D detection datasets, including ScanNet, SUNRGB-D, Waymo, nuScenes, Lyft, and KITTI.
-  For nuScenes dataset, we also support [nuImages dataset](https://github.com/open-mmlab/mmdetection3d/tree/1.1/configs/nuimages).
+  For nuScenes dataset, we also support [nuImages dataset](https://github.com/open-mmlab/mmdetection3d/tree/latest/configs/nuimages).
 
 - **Natural integration with 2D detection**
 
@@ -104,7 +108,7 @@ This project is released under the [Apache 2.0 license](LICENSE).
 
 ## Changelog
 
-**1.1.0rc3** was released in 7/1/2023.
+**1.1.0** was released in 6/4/2023.
 
 Please refer to [changelog.md](docs/en/notes/changelog.md) for details and release history.
 
@@ -299,7 +303,7 @@ If you find this project useful in your research, please consider cite:
 
 ## Contributing
 
-We appreciate all contributions to improve MMDetection3D. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.
+We appreciate all contributions to improve MMDetection3D. Please refer to [CONTRIBUTING.md](./docs/en/notes/contribution_guides.md) for the contributing guideline.
 
 ## Acknowledgement
 

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -18,7 +18,7 @@
   </div>
   <div>&nbsp;</div>
 
-[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdetection3d.readthedocs.io/zh_CN/1.1/)
+[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdetection3d.readthedocs.io/zh_CN/latest/)
 [![badge](https://github.com/open-mmlab/mmdetection3d/workflows/build/badge.svg)](https://github.com/open-mmlab/mmdetection3d/actions)
 [![codecov](https://codecov.io/gh/open-mmlab/mmdetection3d/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdetection3d)
 [![license](https://img.shields.io/github/license/open-mmlab/mmdetection3d.svg)](https://github.com/open-mmlab/mmdetection3d/blob/master/LICENSE)
@@ -49,6 +49,10 @@
 
 **我们将 `1.1` 分支重命名为 `main` 并将默认分支从 `master` 切换到 `main`。我们鼓励用户迁移到最新版本，请参考 [迁移指南](docs/en/migration.md) 以了解更多细节。**
 
+**v1.1.0** 版本已经在 2023.4.6 发布。
+
+我们已经支持了更多基于 LiDAR 的 3D 分割算法。更多关于 3D 感知的新特性正在开发中，请拭目以待！
+
 **v1.1.0rc3** 版本已经在 2023.1.7 发布。
 
 由于坐标系的统一和简化，模型的兼容性会受到影响。目前，大多数模型都以类似的性能对齐了精度，但仍有少数模型在进行基准测试。在接下来的版本中，我们将更新所有的模型权重文件和基准。您可以在[变更日志](docs/zh_cn/notes/changelog.md)和 [v1.0.x 版本变更日志](docs/zh_cn/notes/changelog_v1.0.x.md)中查看更多详细信息。
@@ -74,7 +78,7 @@ MMDetection3D 是一个基于 PyTorch 的目标检测开源工具箱，下一代
 - **支持户内/户外的数据集**
 
   支持室内/室外的 3D 检测数据集，包括 ScanNet，SUNRGB-D，Waymo，nuScenes，Lyft，KITTI。
-  对于 nuScenes 数据集，我们也支持 [nuImages 数据集](https://github.com/open-mmlab/mmdetection3d/tree/1.1/configs/nuimages)。
+  对于 nuScenes 数据集，我们也支持 [nuImages 数据集](https://github.com/open-mmlab/mmdetection3d/tree/latest/configs/nuimages)。
 
 - **与 2D 检测器的自然整合**
 

diff --git a/configs/_base_/datasets/kitti-3d-3class.py b/configs/_base_/datasets/kitti-3d-3class.py
@@ -12,7 +12,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/kitti/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/kitti-3d-car.py b/configs/_base_/datasets/kitti-3d-car.py
@@ -12,7 +12,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/kitti/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/kitti-mono3d.py b/configs/_base_/datasets/kitti-mono3d.py
@@ -10,7 +10,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/kitti/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/lyft-3d-range100.py b/configs/_base_/datasets/lyft-3d-range100.py
@@ -24,7 +24,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/lyft/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/lyft-3d.py b/configs/_base_/datasets/lyft-3d.py
@@ -19,7 +19,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/lyft/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/nuim-instance.py b/configs/_base_/datasets/nuim-instance.py
@@ -11,7 +11,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/nuimages/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/nus-3d.py b/configs/_base_/datasets/nus-3d.py
@@ -23,7 +23,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/nuscenes/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/nus-mono3d.py b/configs/_base_/datasets/nus-mono3d.py
@@ -15,7 +15,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/nuscenes/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/s3dis-3d.py b/configs/_base_/datasets/s3dis-3d.py
@@ -8,7 +8,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/s3dis/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/s3dis-seg.py b/configs/_base_/datasets/s3dis-seg.py
@@ -16,7 +16,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/s3dis/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/scannet-3d.py b/configs/_base_/datasets/scannet-3d.py
@@ -14,7 +14,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/scannet/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/scannet-seg.py b/configs/_base_/datasets/scannet-seg.py
@@ -18,7 +18,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/scannet/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/semantickitti.py b/configs/_base_/datasets/semantickitti.py
@@ -57,7 +57,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/semantickitti/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/sunrgbd-3d.py b/configs/_base_/datasets/sunrgbd-3d.py
@@ -11,7 +11,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/sunrgbd/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/waymoD5-3d-3class.py b/configs/_base_/datasets/waymoD5-3d-3class.py
@@ -11,7 +11,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/waymo/kitti_format/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/waymoD5-3d-car.py b/configs/_base_/datasets/waymoD5-3d-car.py
@@ -10,7 +10,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/waymo/kitti_format/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/waymoD5-fov-mono3d-3class.py b/configs/_base_/datasets/waymoD5-fov-mono3d-3class.py
@@ -12,7 +12,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/waymo/kitti_format/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/waymoD5-mv-mono3d-3class.py b/configs/_base_/datasets/waymoD5-mv-mono3d-3class.py
@@ -12,7 +12,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/waymo/kitti_format/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/_base_/datasets/waymoD5-mv3d-3class.py b/configs/_base_/datasets/waymoD5-mv3d-3class.py
@@ -10,7 +10,7 @@
 
 # data_root = 's3://openmmlab/datasets/detection3d/waymo/kitti_format/'
 
-# Method 2: Use backend_args, file_client_args in versions before 1.1.0rc4
+# Method 2: Use backend_args, file_client_args in versions before 1.1.0
 # backend_args = dict(
 #     backend='petrel',
 #     path_mapping=dict({

diff --git a/configs/cylinder3d/metafile.yml b/configs/cylinder3d/metafile.yml
@@ -12,7 +12,7 @@ Collections:
     README: configs/cylinder3d/README.md
     Code:
       URL: https://github.com/open-mmlab/mmdetection3d/blob/dev-1.x/mmdet3d/models/segmentors/cylinder3d.py#L13
-      Version: v1.1.0rc4
+      Version: v1.1.0
 
 Models:
   - Name:

diff --git a/configs/minkunet/metafile.yml b/configs/minkunet/metafile.yml
@@ -11,7 +11,7 @@ Collections:
     README: configs/minkunet/README.md
     Code:
       URL: https://github.com/open-mmlab/mmdetection3d/blob/1.1/mmdet3d/models/segmentors/minkunet.py#L13
-      Version: v1.1.0rc4
+      Version: v1.1.0
 
 Models:
   - Name: minkunet_w16_8xb2-15e_semantickitti

diff --git a/configs/spvcnn/metafile.yml b/configs/spvcnn/metafile.yml
@@ -11,7 +11,7 @@ Collections:
     README: configs/spvcnn/README.md
     Code:
       URL: https://github.com/open-mmlab/mmdetection3d/blob/1.1/mmdet3d/models/backbones/spvcnn_backone.py#L22
-      Version: v1.1.0rc4
+      Version: v1.1.0
 
 Models:
   - Name: spvcnn_w16_8xb2-15e_semantickitti

diff --git a/docs/en/migration.md b/docs/en/migration.md
@@ -6,6 +6,15 @@ MMDet3D 1.1 depends on the new foundational library [MMEngine](https://github.co
 
 The configuration files in our new version have a lot of modifications because of the differences between MMCV 1.x and MMEngine. The guides for migration from MMCV to MMEngine can be seen [here](https://github.com/open-mmlab/mmengine/tree/main/docs/en/migration).
 
+We have renamed the names of the remote branches in MMDet3D 1.1 (renaming 1.1 to main, master to 1.0, and dev to dev-1.0). If your local branches in the git system are not aligned with branches of the remote repo, you can use the following commands to resolve it:
+
+```
+git fetch origin
+git checkout main
+git branch main_backup  # backup your main branch
+git reset --hard origin/main
+```
+
 ## Dataset
 
 You should update the annotation files generated in the 1.0 version since some key words and structures of annotation in MMDet3D 1.1 have changed. Taking KITTI as an example, the update script is as follows:

diff --git a/docs/en/notes/changelog.md b/docs/en/notes/changelog.md
@@ -1,5 +1,55 @@
 # Changelog of v1.1
 
+### v1.1.0 (6/4/2023)
+
+#### Highlights
+
+- Support [Cylinder3D](https://arxiv.org/pdf/2011.10033.pdf) (#2291, #2344, #2350)
+- Support [MinkUnet](https://arxiv.org/abs/1904.08755) (#2294, #2358)
+- Support [SPVCNN](https://arxiv.org/abs/2007.16100) (#2320，#2372)
+- Support [TR3D](https://arxiv.org/abs/2302.02858) detector in `projects` (#2274)
+- Support the inference of [BEVFusion](https://arxiv.org/abs/2205.13542) in `projects` (#2175)
+- Support [DETR3D](https://arxiv.org/abs/2110.06922) in `projects` (#2173)
+
+#### New Features
+
+- Support [Cylinder3D](https://arxiv.org/pdf/2011.10033.pdf) (#2291, #2344, #2350)
+- Support [MinkUnet](https://arxiv.org/abs/1904.08755) (#2294, #2358)
+- Support [SPVCNN](https://arxiv.org/abs/2007.16100) (#2320，#2372)
+- Support [TR3D](https://arxiv.org/abs/2302.02858) detector in `projects` (#2274)
+- Support the inference of [BEVFusion](https://arxiv.org/abs/2205.13542) in `projects` (#2175)
+- Support [DETR3D](https://arxiv.org/abs/2110.06922) in `projects` (#2173)
+- Support PolarMix and LaserMix augmentation (#2265, #2302)
+- Support loading annotation of panoptic segmentation (#2223)
+- Support panoptic segmentation metric (#2230)
+- Add inferencer for LiDAR-based, monocular and multi-modality 3D detection (#2208, #2190, #2342)
+- Add inferencer for LiDAR-based segmentation (#2304)
+
+#### Improvements
+
+- Support `lazy_init` for CBGSDataset (#2271)
+- Support generating annotation files for test set on Waymo  (#2180)
+- Enhance the support for SemanticKitti (#2253, #2323)
+- File I/O migration and reconstruction (#2319)
+- Support `format_only` option for Lyft, NuScenes and Waymo datasets (#2333, #2151)
+- Replace `np.transpose` with `torch.permute` to speed up (#2277)
+- Allow setting local-rank for pytorch 2.0 (#2387)
+
+#### Bug Fixes
+
+- Fix the problem of reversal of length and width when drawing heatmap in CenterFormer (#2362)
+- Deprecate old type alias due to the new version of numpy (#2339)
+- Lose `trimesh` version requirements to fix numpy random state (#2340)
+- Fix the device mismatch error in CenterPoint (#2308)
+- Fix bug of visualization when there are no bboxes (#2231)
+- Fix bug of counting ignore index in IOU in segmentation evaluation (#2229)
+
+#### Contributors
+
+A total of 14 developers contributed to this release.
+
+@ZLTJohn, @SekiroRong, @shufanwu, @vansin, @triple-Mu, @404Vector, @filaPro, @sunjiahao1999, @Ginray, @Xiangxu-0103, @JingweiZhang12, @DezeZhao, @ZCMax, @roger-lcc
+
 ### v1.1.0rc3 (7/1/2023)
 
 #### Highlights

diff --git a/docs/en/notes/changelog_v1.0.x.md b/docs/en/notes/changelog_v1.0.x.md
@@ -1,5 +1,23 @@
 # Changelog of v1.0.x
 
+### v1.0.0 (6/4/2023)
+
+#### Improvements
+
+- Add BN in FPN to avoid loss Nan in MVXNet (#2282)
+- Update `s3dis_data_utils.py` (#2232)
+
+#### Bug Fixes
+
+- Fix precision error when using mixed precision on CenterPoint (#2341)
+- Replace `np.transpose` with `torch.permute` to speed up (@2273)
+- Update links of SECOND checkpoints (#2185)
+
+#### Contributors
+
+A total of 7 developers contributed to this release.
+@JingweiZhang12, @ZCMax, @Xiangxu-0103, @vansinhu, @cs1488, @sunjiahao1999, @Ginray
+
 ### v1.0.0rc7 (7/1/2023)
 
 #### Improvements

diff --git a/docs/en/notes/faq.md b/docs/en/notes/faq.md
@@ -10,7 +10,8 @@ We list some potential troubles encountered by users and developers, along with
 
   | MMDetection3D version |     MMEngine version     |      MMCV version       |   MMDetection version    |
   | --------------------- | :----------------------: | :---------------------: | :----------------------: |
-  | dev-1.x               | mmengine>=0.6.0, \<1.0.0 | mmcv>=2.0.0rc4, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 |
+  | dev-1.x               | mmengine>=0.7.1, \<1.0.0 | mmcv>=2.0.0rc4, \<2.1.0 |  mmdet>=3.0.0, \<3.1.0   |
+  | main                  | mmengine>=0.7.1, \<1.0.0 | mmcv>=2.0.0rc4, \<2.1.0 |  mmdet>=3.0.0, \<3.1.0   |
   | v1.1.0rc3             | mmengine>=0.1.0, \<1.0.0 | mmcv>=2.0.0rc3, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 |
   | v1.1.0rc2             | mmengine>=0.1.0, \<1.0.0 | mmcv>=2.0.0rc3, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 |
   | v1.1.0rc1             | mmengine>=0.1.0, \<1.0.0 | mmcv>=2.0.0rc0, \<2.1.0 | mmdet>=3.0.0rc0, \<3.1.0 |

diff --git a/mmdet3d/__init__.py b/mmdet3d/__init__.py
@@ -10,11 +10,11 @@
 mmcv_maximum_version = '2.1.0'
 mmcv_version = digit_version(mmcv.__version__)
 
-mmengine_minimum_version = '0.6.0'
+mmengine_minimum_version = '0.7.1'
 mmengine_maximum_version = '1.0.0'
 mmengine_version = digit_version(mmengine.__version__)
 
-mmdet_minimum_version = '3.0.0rc0'
+mmdet_minimum_version = '3.0.0'
 mmdet_maximum_version = '3.1.0'
 mmdet_version = digit_version(mmdet.__version__)