Bump version to v1.0.0rc5 (#649)

* Bump version to v1.0.0rc5 * update changelog * Update README.md Co-authored-by: Songyang Zhang <[email protected]> * Update docs/en/notes/changelog.md Co-authored-by: Songyang Zhang <[email protected]> * Update docs/zh_cn/notes/changelog.md Co-authored-by: Songyang Zhang <[email protected]> * update * fix lint Co-authored-by: Songyang Zhang <[email protected]>
open-mmlab · Dec 30, 2022 · c152d14 · c152d14
1 parent a08faa1
commit c152d14
Show file tree

Hide file tree

Showing 11 changed files with 115 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -65,16 +65,19 @@ The master branch works with **PyTorch 1.6** or higher.
 
 ## What's New
 
+MMSelfSup **v1.0.0rc5** was released in 30/12/2022.
+
+- Support `BEiT v2`, `MixMIM`, `EVA`.
+- Support `ShapeBias` for model analysis
+- Add Solution of FGIA ACCV 2022 (1st Place)
+- Refactor t-SNE
+
 MMSelfSup **v1.0.0rc4** was released in 07/12/2022.
 
 - Support BEiT v1 and MILAN.
 - Support low-level reconstruction visualization.
 - Refine documents algorithm pages.
 
-MMSelfSup **v1.0.0rc3** was released in 01/11/2022.
-
-- Support MaskFeat.
-
 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).

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -65,16 +65,19 @@ MMSelfSup 是一个基于 PyTorch 实现的开源自监督表征学习工具箱
 
 ## 更新
 
-**v1.0.0rc3** 版本已经在 2022.12.07 发布。
+**v1.0.0rc5** 版本已经在 2022.12.30 发布。
+
+- 支持了 `BEiT v2`, `MixMIM`, `EVA`
+- 支持了模型分析工具 `ShapeBias`
+- 添加 FGIA ACCV 2022 比赛第一名方案
+- 重构了 `t-SNE`
+
+**v1.0.0rc4** 版本已经在 2022.12.07 发布。
 
 - 支持 BEiT 和 MILAN 预训练
 - 支持 low-level 重建可视化
 - 更新模型库算法页面文档
 
-**v1.0.0rc3** 版本已经在 2022.11.01 发布。
-
-- 支持 MaskFeat
-
 请参考 [更新日志](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) 中。

diff --git a/docs/en/notes/changelog.md b/docs/en/notes/changelog.md
@@ -2,6 +2,50 @@
 
 ## MMSelfSup
 
+### v1.0.0rc5 (30/12/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 `BEiT v2`, `MixMIM`, `EVA`
+- Support `ShapeBias` for model analysis
+- Add Solution of FGIA ACCV 2022 (1st Place)
+- Refactor t-SNE
+
+#### New Features
+
+- Support `BEiT v2` ([#627](https://github.com/open-mmlab/mmselfsup/pull/627))
+- Support `MixMIM` ([#626](https://github.com/open-mmlab/mmselfsup/pull/626))
+- Support `EVA` ([#632](https://github.com/open-mmlab/mmselfsup/pull/632))
+- Support `ShapeBias` metric ([#635](https://github.com/open-mmlab/mmselfsup/pull/635))
+- Add convert scripts and instructions on seg and det ([#621](https://github.com/open-mmlab/mmselfsup/pull/621))
+- Add pretraining for FGIA ([#607](https://github.com/open-mmlab/mmselfsup/pull/607))
+
+#### Bug Fixes
+
+- Change `pseudo_collect` to `default_collect` ([#616](https://github.com/open-mmlab/mmselfsup/pull/616))
+- Fix the link of SimMIM 800pt 100ft ([#622](https://github.com/open-mmlab/mmselfsup/pull/622))
+- Change `map_location` to `cpu` ([#623](https://github.com/open-mmlab/mmselfsup/pull/623))
+- Fix import error ([#631](https://github.com/open-mmlab/mmselfsup/pull/631))
+- Fix key error in configs ([#630](https://github.com/open-mmlab/mmselfsup/pull/630))
+- Change `np.int` to `int` ([#636](https://github.com/open-mmlab/mmselfsup/pull/636))
+- Fix knn multi-gpu bug ([#634](https://github.com/open-mmlab/mmselfsup/pull/634))
+
+#### Improvements
+
+- Refactor `projects/` folder ([#620](https://github.com/open-mmlab/mmselfsup/pull/620))
+- Refactor `t-SNE` ([#629](https://github.com/open-mmlab/mmselfsup/pull/629))
+- Refactor `CAE` ([#645](https://github.com/open-mmlab/mmselfsup/pull/645))
+- Refactor benchmark script and update files ([#637](https://github.com/open-mmlab/mmselfsup/pull/637))
+
+#### Docs
+
+- Update data_flow.md ([#612](https://github.com/open-mmlab/mmselfsup/pull/612))
+- Update datasets.md ([#633](https://github.com/open-mmlab/mmselfsup/pull/633))
+
 ### v1.0.0rc4 (07/12/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
@@ -12,7 +12,8 @@ Compatible MMEngine, MMCV, MMClassification, MMDetection and MMSegmentation vers
 
 | MMSelfSup version |      MMEngine version       |        MMCV version        |  MMClassification version   | MMSegmentation version | MMDetection version |
 | :---------------: | :-------------------------: | :------------------------: | :-------------------------: | :--------------------: | :-----------------: |
-|  1.0.0rc4 (1.x)   | mmengine >= 0.3.0, \< 1.0.0 | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc4, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|  1.0.0rc5 (1.x)   | mmengine >= 0.4.0, \< 1.0.0 | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc5, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|     1.0.0rc4      | mmengine >= 0.3.0, \< 1.0.0 | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc4, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
 |     1.0.0rc3      | 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  |

diff --git a/docs/zh_cn/notes/changelog.md b/docs/zh_cn/notes/changelog.md
@@ -2,6 +2,50 @@
 
 ## MMSelfSup
 
+### v1.0.0rc5 (30/12/2022)
+
+`master` 仍然是 0.x 版本，我们将会 checkout 一个新的 `1.x` 用来发布 1.x 版本。 未来我们会同时维护两个版本。
+
+我们简要的列出主要的改变。 请参考[迁移文档](../migration.md)来查看细节和迁移指引
+
+#### 亮点
+
+- 支持了 `BEiT v2`, `MixMIM`, `EVA`
+- 支持了模型分析工具 `ShapeBias`
+- 增加 FGIA ACCV 2022 第一名解决方案
+- 重构 t-SNE
+
+#### 新特性
+
+- 支持了 `BEiT v2` ([#627](https://github.com/open-mmlab/mmselfsup/pull/627))
+- 支持了 `MixMIM` ([#626](https://github.com/open-mmlab/mmselfsup/pull/626))
+- 支持了 `EVA` ([#632](https://github.com/open-mmlab/mmselfsup/pull/632))
+- 支持了 `ShapeBias` 评价方式 ([#635](https://github.com/open-mmlab/mmselfsup/pull/635))
+- 增加模型转换脚本和指引 ([#621](https://github.com/open-mmlab/mmselfsup/pull/621))
+- 增加 FGIA 比赛预训练方案 ([#607](https://github.com/open-mmlab/mmselfsup/pull/607))
+
+#### Bug 修复
+
+- 将 `pseudo_collect` 改为 `default_collect` ([#616](https://github.com/open-mmlab/mmselfsup/pull/616))
+- 修复 SimMIM 链接问题 ([#622](https://github.com/open-mmlab/mmselfsup/pull/622))
+- 修改 `map_location` 为 `cpu` ([#623](https://github.com/open-mmlab/mmselfsup/pull/623))
+  修复 import 问题 ([#631](https://github.com/open-mmlab/mmselfsup/pull/631))
+- 修复配置文件字段问题 ([#630](https://github.com/open-mmlab/mmselfsup/pull/630))
+- 修改 `np.int` 为 `int` ([#636](https://github.com/open-mmlab/mmselfsup/pull/636))
+- 修复 knn 多卡 bug ([#634](https://github.com/open-mmlab/mmselfsup/pull/634))
+
+#### 改进
+
+- 重构 `projects/` 文件夹 ([#620](https://github.com/open-mmlab/mmselfsup/pull/620))
+- 重构 `t-SNE` ([#629](https://github.com/open-mmlab/mmselfsup/pull/629))
+- 基于 `target_generator` 重构 `CAE` ([#645](https://github.com/open-mmlab/mmselfsup/pull/645))
+- 重构回归测试相关内容 ([#637](https://github.com/open-mmlab/mmselfsup/pull/637))
+
+#### 文档
+
+- 更新 data_flow.md 文档 ([#612](https://github.com/open-mmlab/mmselfsup/pull/612))
+- 更新 datasets.md 文档 ([#633](https://github.com/open-mmlab/mmselfsup/pull/633))
+
 ### v1.0.0rc4 (07/12/2022)
 
 `master` 仍然是 0.x 版本，我们将会 checkout 一个新的 `1.x` 用来发布 1.x 版本。 未来我们会同时维护两个版本。

diff --git a/docs/zh_cn/notes/faq.md b/docs/zh_cn/notes/faq.md
@@ -12,7 +12,8 @@ MMCV, MMClassification, MMDetection and MMSegmentation 的版本兼容性如下
 
 | MMSelfSup version |      MMEngine version       |        MMCV version        |  MMClassification version   | MMSegmentation version | MMDetection version |
 | :---------------: | :-------------------------: | :------------------------: | :-------------------------: | :--------------------: | :-----------------: |
-|  1.0.0rc4 (1.x)   | mmengine >= 0.3.0, \< 1.0.0 | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc4, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|  1.0.0rc5 (1.x)   | mmengine >= 0.4.0, \< 1.0.0 | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc5, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
+|     1.0.0rc4      | mmengine >= 0.3.0, \< 1.0.0 | mmcv >= 2.0.0rc1, \< 2.1.0 | mmcls >= 1.0.0rc4, \< 1.1.0 |   mmseg >= 1.0.0rc0    |  mmdet >= 3.0.0rc0  |
 |     1.0.0rc3      | 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      |      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  |

diff --git a/mmselfsup/__init__.py b/mmselfsup/__init__.py
@@ -6,15 +6,15 @@
 
 from .version import __version__
 
-mmengine_minimum_version = '0.3.0'
+mmengine_minimum_version = '0.4.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__)
 
-mmcls_minimum_version = '1.0.0rc4'
+mmcls_minimum_version = '1.0.0rc5'
 mmcls_maximum_version = '1.1.0'
 mmcls_version = digit_version(mmcls.__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.0rc4'
+__version__ = '1.0.0rc5'
 
 
 def parse_version_info(version_str):

diff --git a/requirements/mminstall.txt b/requirements/mminstall.txt
@@ -1,5 +1,5 @@
-mmcls>=1.0.0rc4,<1.1.0
+mmcls>=1.0.0rc5,<1.1.0
 mmcv>=2.0.0rc1,<2.1.0
 mmdet>=3.0.0rc0,<3.1.0
-mmengine>=0.1.0,<1.0.0
+mmengine>=0.4.0,<1.0.0
 mmsegmentation>=1.0.0rc0,<1.1.0
diff --git a/requirements/readthedocs.txt b/requirements/readthedocs.txt
@@ -1,7 +1,7 @@
-mmcls>=1.0.0rc4
+mmcls>=1.0.0rc5
 mmcv>=2.0.0rc1
 mmdet>=3.0.0rc0
-mmengine
+mmengine>=0.4.0
 mmselfsup>=1.0.0rc1
 scikit-learn
 torch

diff --git a/requirements/runtime.txt b/requirements/runtime.txt
@@ -2,7 +2,7 @@ attrs
 einops
 future
 matplotlib
-mmcls>=1.0.0rc4
+mmcls>=1.0.0rc5,<1.1.0
 numpy
 packaging
 scikit-learn