Bump version to v1.0.0rc3 (#566)

* change mmcv to mmengine * update version * update * update readme * update requirements * update changelog * fix lint
open-mmlab · Nov 3, 2022 · 7980414 · 7980414
1 parent f0d03d4
commit 7980414
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -65,18 +65,16 @@ The master branch works with **PyTorch 1.6** or higher.
 
 ## What's New
 
+MMSelfSup **v1.0.0rc3** was released in 01/11/2022.
+
+- Support MaskFeat.
+- Refine configs and documents.
+
 MMSelfSup **v1.0.0rc2** was released in 12/10/2022.
 
 - Full support of `MAE`, `SimMIM`, `MoCoV3` with different model sizes and different pre-training epochs.
 - Update documents and colab tutorial.
 
-MMSelfSup **v1.0.0rc1** was released in 01/09/2022.
-
-- Based on MMEngine and MMCV.
-- Released with refactor.
-- Refine all documents.
-- Refactor the data pipeline, which is more powerful.
-
 Please refer to [Changelog](https://mmselfsup.readthedocs.io/en/dev-1.x/notes/changelog.html) for details and release history.
 
 Differences between MMSelfSup 1.x and 0.x can be found in [Migration](https://mmselfsup.readthedocs.io/en/dev-1.x/migration.html).
@@ -134,6 +132,7 @@ Supported algorithms:
 - [x] [MoCo v3 (ICCV'2021)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/mocov3)
 - [x] [MAE (CVPR'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/mae)
 - [x] [SimMIM (CVPR'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/simmim)
+- [x] [MaskFeat (CVPR'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/maskfeat)
 - [x] [CAE (ArXiv'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/cae)
 
 More algorithms are in our plan.
@@ -186,11 +185,13 @@ This project is released under the [Apache 2.0 license](LICENSE).
 
 - [MMEngine](https://github.com/open-mmlab/mmengine): OpenMMLab foundational library for training deep learning models.
 - [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab foundational library for computer vision.
+- [MMEval](https://github.com/open-mmlab/mmeval): A unified evaluation library for multiple machine learning libraries.
 - [MIM](https://github.com/open-mmlab/mim): MIM installs OpenMMLab packages.
 - [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab image classification toolbox and benchmark.
 - [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab detection toolbox and benchmark.
 - [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab's next-generation platform for general 3D object detection.
 - [MMRotate](https://github.com/open-mmlab/mmrotate): OpenMMLab rotated object detection toolbox and benchmark.
+- [MMYOLO](https://github.com/open-mmlab/mmyolo): OpenMMLab YOLO series toolbox and benchmark.
 - [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab semantic segmentation toolbox and benchmark.
 - [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab text detection, recognition, and understanding toolbox.
 - [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab pose estimation toolbox and benchmark.

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -65,20 +65,16 @@ MMSelfSup 是一个基于 PyTorch 实现的开源自监督表征学习工具箱
 
 ## 更新
 
+**v1.0.0rc3** 版本已经在 2022.11.01 发布。
+
+- 支持 MaskFeat
+- 更新配置文件和文档
+
 **v1.0.0rc2** 版本已经在 2022.10.12 发布。
 
 - `MAE`, `SimMIM`, `MoCoV3` 算法模型的全量支持（支持多种模型尺寸和预训练轮次）。
 - 更新文档以及教程
 
-**v1.0.0rc1** 版本已经在 2022.09.01 发布。
-
-新版本亮点：
-
-- 基于 MMEngine 和 MMCV
-- 全面代码重构
-- 文档更新
-- 更强大的数据流
-
 请参考 [更新日志](https://mmselfsup.readthedocs.io/zh_CN/dev-1.x/notes/changelog.html) 获取更多细节和历史版本信息。
 
 MMSelfSup 1.x 和 0.x 的不同点写在 [迁移文档](https://mmselfsup.readthedocs.io/zh_CN/dev-1.x/migration.html) 中。
@@ -136,6 +132,7 @@ Useful Tools
 - [x] [MoCo v3 (ICCV'2021)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/mocov3)
 - [x] [MAE (CVPR'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/mae)
 - [x] [SimMIM (CVPR'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/simmim)
+- [x] [MaskFeat (CVPR'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/maskfeat)
 - [x] [CAE (ArXiv'2022)](https://github.com/open-mmlab/mmselfsup/tree/dev-1.x/configs/selfsup/cae)
 
 更多的算法实现已经在我们的计划中。
@@ -187,11 +184,13 @@ MMSelfSup 是一款由不同学校和公司共同贡献的开源项目，我们
 
 - [MMEngine](https://github.com/open-mmlab/mmengine): OpenMMLab 深度学习模型训练基础库
 - [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库
+- [MMEval](https://github.com/open-mmlab/mmeval): 统一开放的跨框架算法评测库
 - [MIM](https://github.com/open-mmlab/mim): MIM 是 OpenMMlab 项目、算法、模型的统一入口
 - [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱
 - [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab 目标检测工具箱
 - [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab 新一代通用 3D 目标检测平台
 - [MMRotate](https://github.com/open-mmlab/mmrotate): OpenMMLab 旋转框检测工具箱与测试基准
+- [MMYOLO](https://github.com/open-mmlab/mmyolo): OpenMMLab YOLO 系列工具箱和基准测试
 - [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab 语义分割工具箱
 - [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab 全流程文字检测识别理解工具箱
 - [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱

diff --git a/docs/en/notes/changelog.md b/docs/en/notes/changelog.md
@@ -2,6 +2,36 @@
 
 ## MMSelfSup
 
+### v1.0.0rc3 (01/11/2022)
+
+The `master` branch is still 0.x version and we will checkout a new `1.x` branch to release 1.x version. The two versions will be maintained simultaneously in the future.
+
+We briefly list the major breaking changes here. Please refer to the [migration guide](../migration.md) for details and migration instructions.
+
+#### Highlight
+
+- Support `MaskFeat`
+
+#### New Features
+
+- Support `MaskFeat` ([#494](https://github.com/open-mmlab/mmselfsup/pull/494))
+- Add Hog generator ([#518](https://github.com/open-mmlab/mmselfsup/pull/518))
+
+#### Bug Fixes
+
+- Fix fine-tuning config of MAE-H-448 ([#509](https://github.com/open-mmlab/mmselfsup/pull/509))
+
+#### Improvements
+
+- Refactor evaluation folder and related configs ([#538](https://github.com/open-mmlab/mmselfsup/pull/538)))
+- Refine configs ([#547](https://github.com/open-mmlab/mmselfsup/pull/547)))
+
+#### Docs
+
+- Add custom dataset tutorial ([#522](https://github.com/open-mmlab/mmselfsup/pull/522))
+- Refactor add_modules.md ([#524](https://github.com/open-mmlab/mmselfsup/pull/524))
+- Translate some documentation to Chinese
+
 ### v1.0.0rc2 (12/10/2022)
 
 The `master` branch is still 0.x version and we will checkout a new `1.x` branch to release 1.x version. The two versions will be maintained simultaneously in the future.

diff --git a/docs/en/notes/faq.md b/docs/en/notes/faq.md
@@ -10,16 +10,17 @@ We list some common troubles faced by many users and their corresponding solutio
 
 Compatible MMEngine, MMCV, MMClassification, MMDetection and MMSegmentation versions are shown below. Please install the correct version of them to avoid installation issues.
 
-| MMSelfSup version | MMEngine version  |    MMCV version     |  MMClassification version   | MMSegmentation version | MMDetection version |
-| :---------------: | :---------------: | :-----------------: | :-------------------------: | :--------------------: | :-----------------: |
-|  1.0.0rc2 (1.x)   | mmengine >= 0.1.0 |  mmcv >= 2.0.0rc1   |      mmcls >= 1.0.0rc0      |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
-|     1.0.0rc1      | mmengine >= 0.1.0 |  mmcv >= 2.0.0rc1   |      mmcls >= 1.0.0rc0      |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
-|       0.9.1       |         /         | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
-|       0.9.0       |         /         | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
-|       0.8.0       |         /         | mmcv-full >= 1.4.2  |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
-|       0.7.1       |         /         | mmcv-full >= 1.3.16 | mmcls >= 0.19.0, \<= 0.20.1 |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
-|       0.6.0       |         /         | mmcv-full >= 1.3.16 |       mmcls >= 0.19.0       |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
-|       0.5.0       |         /         | mmcv-full >= 1.3.16 |              /              |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
+| MMSelfSup version |      MMEngine version       |        MMCV version        |  MMClassification version   | MMSegmentation version | MMDetection version |
+| :---------------: | :-------------------------: | :------------------------: | :-------------------------: | :--------------------: | :-----------------: |
+|  1.0.0rc3 (1.x)   | mmengine >= 0.3.0, \< 1.0.0 | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc0, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|     1.0.0rc2      |      mmengine >= 0.1.0      | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc0, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|     1.0.0rc1      |      mmengine >= 0.1.0      | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc0, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|       0.9.1       |              /              |     mmcv-full >= 1.4.2     |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
+|       0.9.0       |              /              |     mmcv-full >= 1.4.2     |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
+|       0.8.0       |              /              |     mmcv-full >= 1.4.2     |       mmcls >= 0.21.0       |    mmseg >= 0.20.2     |   mmdet >= 2.19.0   |
+|       0.7.1       |              /              |    mmcv-full >= 1.3.16     | mmcls >= 0.19.0, \<= 0.20.1 |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
+|       0.6.0       |              /              |    mmcv-full >= 1.3.16     |       mmcls >= 0.19.0       |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
+|       0.5.0       |              /              |    mmcv-full >= 1.3.16     |              /              |    mmseg >= 0.20.2     |   mmdet >= 2.16.0   |
 
 **Note:**
 

diff --git a/mmselfsup/__init__.py b/mmselfsup/__init__.py
@@ -1,10 +1,15 @@
 # Copyright (c) OpenMMLab. All rights reserved.
 import mmcls
 import mmcv
+import mmengine
 from mmengine.utils import digit_version
 
 from .version import __version__
 
+mmengine_minimum_version = '0.3.0'
+mmengine_maximum_version = '1.0.0'
+mmengine_version = digit_version(mmengine.__version__)
+
 mmcv_minimum_version = '2.0.0rc1'
 mmcv_maximum_version = '2.1.0'
 mmcv_version = digit_version(mmcv.__version__)
@@ -13,6 +18,11 @@
 mmcls_maximum_version = '1.1.0'
 mmcls_version = digit_version(mmcls.__version__)
 
+assert (mmengine_version >= digit_version(mmengine_minimum_version)
+        and mmengine_version < digit_version(mmengine_maximum_version)), \
+    f'MMEngine=={mmengine.__version__} is used but incompatible. ' \
+    f'Please install mmengine>={mmengine_minimum_version}, ' \
+    f'<{mmengine_maximum_version}.'
 
 assert (mmcv_version >= digit_version(mmcv_minimum_version)
         and mmcv_version < digit_version(mmcv_maximum_version)), \

diff --git a/mmselfsup/version.py b/mmselfsup/version.py
@@ -1,6 +1,6 @@
 # Copyright (c) Open-MMLab. All rights reserved.
 
-__version__ = '1.0.0rc2'
+__version__ = '1.0.0rc3'
 
 
 def parse_version_info(version_str):

diff --git a/requirements/mminstall.txt b/requirements/mminstall.txt
@@ -1,5 +1,5 @@
 mmcls>=1.0.0rc0,<1.1.0
 mmcv>=2.0.0rc1,<2.1.0
 mmdet>=3.0.0rc0,<3.1.0
-mmengine>=0.1.0
+mmengine>=0.1.0,<1.0.0
 mmsegmentation>=1.0.0rc0,<1.1.0
diff --git a/tools/model_converters/publish_model.py b/tools/model_converters/publish_model.py
@@ -5,7 +5,7 @@
 from pathlib import Path
 
 import torch
-from mmcv import digit_version
+from mmengine import digit_version
 
 
 def parse_args():