Skip to content

Commit d7c59f3

Browse files
gaotongxiaogaotongxiao
authored
Bump version to 1.0.0 (#1841)
* Bump version to 1.0.0 * Bump version to 1.0.0
1 parent a7e326f commit d7c59f3

File tree

7 files changed

+85
-28
lines changed

7 files changed

+85
-28
lines changed

‎README.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,16 @@ English | [简体中文](README_zh-CN.md)
6262

6363
## Latest Updates
6464

65-
**The default branch is now `main` and the code on the branch has been switched to v1.0.0. The old `main` branch (v0.6.3) code now exists on the `0.x` branch.** If you have been using the `main` branch and encounter upgrade issues, please read the [Migration Guide](https://mmocr.readthedocs.io/en/dev-1.x/migration/overview.html) and notes on [Branches](https://mmocr.readthedocs.io/en/dev-1.x/migration/branches.html) .
65+
**The default branch is now `main` and the code on the branch has been upgraded to v1.0.0. The old `main` branch (v0.6.3) code now exists on the `0.x` branch.** If you have been using the `main` branch and encounter upgrade issues, please read the [Migration Guide](https://mmocr.readthedocs.io/en/dev-1.x/migration/overview.html) and notes on [Branches](https://mmocr.readthedocs.io/en/dev-1.x/migration/branches.html) .
6666

67-
v1.0.0rc6 was released in 2023-03-07.
67+
v1.0.0 was released in 2023-04-06. Major updates from 1.0.0rc6 include:
6868

69-
1. Two new models, ABCNet v2 (inference only) and SPTS are added to `projects/` folder.
70-
2. Announcing `Inferencer`, a unified inference interface in OpenMMLab for everyone's easy access and quick inference with all the pre-trained weights. [Docs](https://mmocr.readthedocs.io/en/dev-1.x/user_guides/inference.html)
71-
3. Users can use test-time augmentation for text recognition tasks. [Docs](https://mmocr.readthedocs.io/en/dev-1.x/user_guides/train_test.html#test-time-augmentation)
72-
4. Support [batch augmentation](https://openaccess.thecvf.com/content_CVPR_2020/papers/Hoffer_Augment_Your_Batch_Improving_Generalization_Through_Instance_Repetition_CVPR_2020_paper.pdf) through [`BatchAugSampler`](https://github.com/open-mmlab/mmocr/pull/1757), which is a technique used in SPTS.
73-
5. Dataset Preparer has been refactored to allow more flexible configurations. Besides, users are now able to prepare text recognition datasets in LMDB formats. [Docs](https://mmocr.readthedocs.io/en/dev-1.x/user_guides/data_prepare/dataset_preparer.html#lmdb-format)
74-
6. Some textspotting datasets have been revised to enhance the correctness and consistency with the common practice.
75-
7. Potential spurious warnings from `shapely` have been eliminated.
69+
1. Support for SCUT-CTW1500, SynthText, and MJSynth datasets in Dataset Preparer
70+
2. Updated FAQ and documentation
71+
3. Deprecation of file_client_args in favor of backend_args
72+
4. Added a new MMOCR tutorial notebook
7673

74+
To know more about the updates in MMOCR 1.0, please refer to [What's New in MMOCR 1.x](https://mmocr.readthedocs.io/en/dev-1.x/migration/news.html), or
7775
Read [Changelog](https://mmocr.readthedocs.io/en/dev-1.x/notes/changelog.html) for more details!
7876

7977
## Introduction

‎README_zh-CN.md

+6-15
Original file line numberDiff line numberDiff line change
@@ -65,23 +65,14 @@
6565

6666
**默认分支目前为 `main`，且分支上的代码已经切换到 v1.0.0 版本。旧版 `main` 分支（v0.6.3）的代码现存在 `0.x` 分支上。** 如果您一直在使用 `main` 分支，并遇到升级问题，请阅读 [迁移指南](https://mmocr.readthedocs.io/zh_CN/dev-1.x/migration/overview.html) 和 [分支说明](https://mmocr.readthedocs.io/zh_CN/dev-1.x/migration/branches.html) 。
6767

68-
最新的版本 v1.0.0rc6 于 2023-03-07 发布。
68+
最新的版本 v1.0.0 于 2023-04-06 发布。其相对于 1.0.0rc6 的主要更新如下：
6969

70-
1. 在 `projects/` 目录中新增了 ABCNet v2 (仅支持推理) 和 SPTS 模型；
70+
1. Dataset Preparer 中支持了 SCUT-CTW1500, SynthText 和 MJSynth 数据集；
71+
2. 更新了文档和 FAQ；
72+
3. 升级文件后端；使用了 `backend_args` 替换 `file_client_args`;
73+
4. 增加了 MMOCR 教程 notebook。
7174

72-
2. 新增统一推理接口 `Inferencer`，用户可以方便直接地进行各任务的推理。[文档](https://mmocr.readthedocs.io/zh_CN/dev-1.x/user_guides/inference.html)
73-
74-
3. 支持了文本识别任务的测试时数据增强。[文档](https://mmocr.readthedocs.io/zh_CN/dev-1.x/user_guides/train_test.html#id15)
75-
76-
4. 通过 [`BatchAugSampler`](https://github.com/open-mmlab/mmocr/pull/1757) 支持了 [batch augmentation](https://openaccess.thecvf.com/content_CVPR_2020/papers/Hoffer_Augment_Your_Batch_Improving_Generalization_Through_Instance_Repetition_CVPR_2020_paper.pdf) ，这是 SPTS 中使用的一种技巧。
77-
78-
5. 重构了 Dataset Preparer ，用户现在可以更灵活地配置数据集的预处理流程。除此之外，用户现在也可以将文本识别数据集转换为 LMDB 格式。[文档](https://mmocr.readthedocs.io/zh_CN/dev-1.x/user_guides/data_prepare/dataset_preparer.html#lmdb)
79-
80-
6. 修正了一些端到端数据集的标注，保证了数据集的正确性及与常见实践的一致性。
81-
82-
7. 减少了 `shapely` 中可能出现的一些错误警告。
83-
84-
阅读[更新日志](https://mmocr.readthedocs.io/zh_CN/dev-1.x/notes/changelog.html)以获取更多信息。
75+
如果需要了解 MMOCR 1.0 相对于 0.x 的升级内容，请阅读 [MMOCR 1.x 更新汇总](https://mmocr.readthedocs.io/zh_CN/dev-1.x/migration/news.html)；或者阅读[更新日志](https://mmocr.readthedocs.io/zh_CN/dev-1.x/notes/changelog.html)以获取更多信息。
8576

8677
## 简介
8778

‎docs/en/get_started/install.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,8 @@ MMOCR has different version requirements on MMEngine, MMCV and MMDetection at ea
237237

238238
| MMOCR | MMEngine | MMCV | MMDetection |
239239
| -------------- | --------------------------- | -------------------------- | --------------------------- |
240-
| dev-1.x | 0.7.0 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
240+
| dev-1.x | 0.7.1 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
241+
| 1.0.0 | 0.7.1 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
241242
| 1.0.0rc6 | 0.6.0 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
242243
| 1.0.0rc\[4-5\] | 0.1.0 \<= mmengine \< 1.0.0 | 2.0.0rc1 \<= mmcv \< 2.1.0 | 3.0.0rc0 \<= mmdet \< 3.1.0 |
243244
| 1.0.0rc\[0-3\] | 0.0.0 \<= mmengine \< 0.2.0 | 2.0.0rc1 \<= mmcv \< 2.1.0 | 3.0.0rc0 \<= mmdet \< 3.1.0 |

‎docs/en/notes/changelog.md

+66
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,72 @@
22

33
## v1.0.0 (04/06/2023)
44

5+
We are excited to announce the first official release of MMOCR 1.0, with numerous enhancements, bug fixes, and the introduction of new dataset support!
6+
7+
### 🌟 Highlights
8+
9+
- Support for SCUT-CTW1500, SynthText, and MJSynth datasets
10+
- Updated FAQ and documentation
11+
- Deprecation of file_client_args in favor of backend_args
12+
- Added a new MMOCR tutorial notebook
13+
14+
### 🆕 New Features & Enhancement
15+
16+
- Add SCUT-CTW1500 by @Mountchicken in https://github.com/open-mmlab/mmocr/pull/1677
17+
- Cherry Pick #1205 by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1774
18+
- Make lanms-neo optional by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1772
19+
- SynthText by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1779
20+
- Deprecate file_client_args and use backend_args instead by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1765
21+
- MJSynth by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1791
22+
- Add MMOCR tutorial notebook by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1771
23+
- decouple batch_size to det_batch_size, rec_batch_size and kie_batch_size in MMOCRInferencer by @hugotong6425 in https://github.com/open-mmlab/mmocr/pull/1801
24+
- Accepts local-rank in train.py and test.py by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1806
25+
- update stitch_boxes_into_lines by @cherryjm in https://github.com/open-mmlab/mmocr/pull/1824
26+
- Add tests for pytorch 2.0 by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1836
27+
28+
### 📝 Docs
29+
30+
- FAQ by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1773
31+
- Remove LoadImageFromLMDB from docs by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1767
32+
- Mark projects in docs by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1766
33+
- add opendatalab download link by @jorie-peng in https://github.com/open-mmlab/mmocr/pull/1753
34+
- Fix some deadlinks in the docs by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1469
35+
- Fix quick run by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1775
36+
- Dataset by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1782
37+
- Update faq by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1817
38+
- more social network links by @fengshiwest in https://github.com/open-mmlab/mmocr/pull/1818
39+
- Update docs after branch switching by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1834
40+
41+
### 🛠️ Bug Fixes:
42+
43+
- Place dicts to .mim by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1781
44+
- Test svtr_small instead of svtr_tiny by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1786
45+
- Add pse weight to metafile by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1787
46+
- Synthtext metafile by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1788
47+
- Clear up some unused scripts by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1798
48+
- if dst not exists, when move a single file may raise a file not exists error. by @KevinNuNu in https://github.com/open-mmlab/mmocr/pull/1803
49+
- CTW1500 by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1814
50+
- MJSynth & SynthText Dataset Preparer config by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1805
51+
- Use poly_intersection instead of poly.intersection to avoid sup… by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1811
52+
- Abinet: fix ValueError: Blur limit must be odd when centered=True. Got: (3, 6) by @hugotong6425 in https://github.com/open-mmlab/mmocr/pull/1821
53+
- Bug generated during kie inference visualization by @Yangget in https://github.com/open-mmlab/mmocr/pull/1830
54+
- Revert sync bn in inferencer by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1832
55+
- Fix mmdet digit version by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/1840
56+
57+
### 🎉 New Contributors
58+
59+
- @jorie-peng made their first contribution in https://github.com/open-mmlab/mmocr/pull/1753
60+
- @hugotong6425 made their first contribution in https://github.com/open-mmlab/mmocr/pull/1801
61+
- @fengshiwest made their first contribution in https://github.com/open-mmlab/mmocr/pull/1818
62+
- @cherryjm made their first contribution in https://github.com/open-mmlab/mmocr/pull/1824
63+
- @Yangget made their first contribution in https://github.com/open-mmlab/mmocr/pull/1830
64+
65+
Thank you to all the contributors for making this release possible! We're excited about the new features and enhancements in this version, and we're looking forward to your feedback and continued support. Happy coding! 🚀
66+
67+
**Full Changelog**: https://github.com/open-mmlab/mmocr/compare/v1.0.0rc6...v1.0.0
68+
69+
### Highlights
70+
571
## v1.0.0rc6 (03/07/2023)
672

773
### Highlights

‎docs/zh_cn/get_started/install.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,8 @@ docker run --gpus all --shm-size=8g -it -v {实际数据目录}:/mmocr/data mmoc
236236

237237
| MMOCR | MMEngine | MMCV | MMDetection |
238238
| -------------- | --------------------------- | -------------------------- | --------------------------- |
239-
| dev-1.x | 0.7.0 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
239+
| dev-1.x | 0.7.1 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
240+
| 1.0.0 | 0.7.1 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
240241
| 1.0.0rc6 | 0.6.0 \<= mmengine \< 1.0.0 | 2.0.0rc4 \<= mmcv \< 2.1.0 | 3.0.0rc5 \<= mmdet \< 3.1.0 |
241242
| 1.0.0rc\[4-5\] | 0.1.0 \<= mmengine \< 1.0.0 | 2.0.0rc1 \<= mmcv \< 2.1.0 | 3.0.0rc0 \<= mmdet \< 3.1.0 |
242243
| 1.0.0rc\[0-3\] | 0.0.0 \<= mmengine \< 0.2.0 | 2.0.0rc1 \<= mmcv \< 2.1.0 | 3.0.0rc0 \<= mmdet \< 3.1.0 |

‎mmocr/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
mmcv_maximum_version = '2.1.0'
1717
mmcv_version = digit_version(mmcv.__version__)
1818
if mmengine is not None:
19-
mmengine_minimum_version = '0.6.0'
19+
mmengine_minimum_version = '0.7.1'
2020
mmengine_maximum_version = '1.0.0'
2121
mmengine_version = digit_version(mmengine.__version__)
2222

‎mmocr/version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Copyright (c) Open-MMLab. All rights reserved.
22

3-
__version__ = '1.0.0rc6'
3+
__version__ = '1.0.0'
44
short_version = __version__

0 commit comments

Comments
 (0)