mirror of
https://github.com/open-mmlab/mmocr.git
synced 2025-06-03 21:54:47 +08:00
Bump version to 0.4.0 (#672)
This commit is contained in:
Tong Gao
GitHub
parent
9104667112
commit
af9a62502c
@ -107,7 +107,7 @@ If you find this project useful in your research, please consider cite:
|
||||
|
||||
## Changelog
|
||||
|
||||
v0.3.0 was released in 2021-8-25.
|
||||
v0.4.0 was released in 2021-12-15.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
@ -107,7 +107,7 @@ MMOCR 是基于 PyTorch 和 mmdetection 的开源工具箱，专注于文本检
|
||||
|
||||
## 更新日志
|
||||
|
||||
最新的月度版本 v0.3.0 在 2021.08.25 发布。
|
||||
最新的月度版本 v0.4.0 在 2021.12.15 发布。
|
||||
|
||||
|
||||
## 安装
|
||||
|
||||
@ -1,5 +1,166 @@
|
||||
# Changelog
|
||||
|
||||
## v0.4.0 (15/12/2021)
|
||||
|
||||
### Highlights
|
||||
|
||||
1. We release a new text recognition model - [ABINet](https://arxiv.org/pdf/2103.06495.pdf) (CVPR 2021, Oral). With it dedicated model design and useful data augmentation transforms, ABINet can achieve the best performance on irregular text recognition tasks. [Check it out!](https://mmocr.readthedocs.io/en/latest/textrecog_models.html#read-like-humans-autonomous-bidirectional-and-iterative-language-modeling-for-scene-text-recognition)
|
||||
2. We are also working hard to fulfill the requests from our community.
|
||||
[OpenSet KIE](https://mmocr.readthedocs.io/en/latest/kie_models.html#wildreceiptopenset) is one of the achievement, which extends the application of SDMGR from text node classification to node-pair relation extraction. We also provide
|
||||
a demo script to convert WildReceipt to open set domain, though it cannot
|
||||
take the full advantage of OpenSet format. For more information, please read our
|
||||
[tutorial](https://mmocr.readthedocs.io/en/latest/tutorials/kie_closeset_openset.html).
|
||||
3. APIs of models can be exposed through TorchServe. [Docs](https://mmocr.readthedocs.io/en/latest/model_serving.html)
|
||||
|
||||
### Breaking Changes & Migration Guide
|
||||
|
||||
#### Postprocessor
|
||||
|
||||
Some refactoring processes are still going on. For all text detection models, we unified their `decode` implementations into a new module category, `POSTPROCESSOR`, which is responsible for decoding different raw outputs into boundary instances. In all text detection configs, the `text_repr_type` argument in `bbox_head` is deprecated and will be removed in the future release.
|
||||
|
||||
**Migration Guide**: Find a similar line from detection model's config:
|
||||
```
|
||||
text_repr_type=xxx,
|
||||
```
|
||||
And replace it with
|
||||
```
|
||||
postprocessor=dict(type='{MODEL_NAME}Postprocessor', text_repr_type=xxx)),
|
||||
```
|
||||
Take a snippet of PANet's config as an example. Before the change, its config for `bbox_head` looks like:
|
||||
```
|
||||
bbox_head=dict(
|
||||
type='PANHead',
|
||||
text_repr_type='poly',
|
||||
in_channels=[128, 128, 128, 128],
|
||||
out_channels=6,
|
||||
loss=dict(type='PANLoss')),
|
||||
```
|
||||
Afterwards:
|
||||
```
|
||||
bbox_head=dict(
|
||||
type='PANHead',
|
||||
in_channels=[128, 128, 128, 128],
|
||||
out_channels=6,
|
||||
loss=dict(type='PANLoss'),
|
||||
postprocessor=dict(type='PANPostprocessor', text_repr_type='poly')),
|
||||
```
|
||||
There are other postprocessors and each takes different arguments. Interested users can find their interfaces or implementations in `mmocr/models/textdet/postprocess` or through our [api docs](https://mmocr.readthedocs.io/en/latest/api.html#textdet-postprocess).
|
||||
|
||||
#### New Config Structure
|
||||
|
||||
We reorganized the `configs/` directory by extracting reusable sections into `configs/_base_`. Now the directory tree of `configs/_base_` is organized as follows:
|
||||
|
||||
```
|
||||
_base_
|
||||
├── det_datasets
|
||||
├── det_models
|
||||
├── det_pipelines
|
||||
├── recog_datasets
|
||||
├── recog_models
|
||||
├── recog_pipelines
|
||||
└── schedules
|
||||
```
|
||||
|
||||
Most of model configs are making full use of base configs now, which makes the overall structural clearer and facilitates fair
|
||||
comparison across models. Despite the seemingly significant hierarchical difference, **these changes would not break the backward compatibility** as the names of model configs remain the same.
|
||||
|
||||
### New Features
|
||||
* Support openset kie by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/498
|
||||
* Add converter for the Open Images v5 text annotations by Krylov et al. by @baudm in https://github.com/open-mmlab/mmocr/pull/497
|
||||
* Support Chinese for kie show result by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/464
|
||||
* Add TorchServe support for text detection and recognition by @Harold-lkk in https://github.com/open-mmlab/mmocr/pull/522
|
||||
* Save filename in text detection test results by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/570
|
||||
* Add codespell pre-commit hook and fix typos by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/520
|
||||
* Avoid duplicate placeholder docs in CN by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/582
|
||||
* Save results to json file for kie. by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/589
|
||||
* Add SAR_CN to ocr.py by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/579
|
||||
* mim extension for windows by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/641
|
||||
* Support muitiple pipelines for different datasets by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/657
|
||||
* ABINet Framework by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/651
|
||||
|
||||
### Refactoring
|
||||
* Refactor textrecog config structure by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/617
|
||||
* Refactor text detection config by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/626
|
||||
* refactor transformer modules by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/618
|
||||
* refactor textdet postprocess by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/640
|
||||
|
||||
### Docs
|
||||
* C++ example section by @apiaccess21 in https://github.com/open-mmlab/mmocr/pull/593
|
||||
* install.md Chinese section by @A465539338 in https://github.com/open-mmlab/mmocr/pull/364
|
||||
* Add Chinese Translation of deployment.md. by @fatfishZhao in https://github.com/open-mmlab/mmocr/pull/506
|
||||
* Fix a model link and add the metafile for SATRN by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/473
|
||||
* Improve docs style by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/474
|
||||
* Enhancement & sync Chinese docs by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/492
|
||||
* TorchServe docs by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/539
|
||||
* Update docs menu by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/564
|
||||
* Docs for KIE CloseSet & OpenSet by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/573
|
||||
* Fix broken links by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/576
|
||||
* Docstring for text recognition models by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/562
|
||||
* Add MMFlow & MIM by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/597
|
||||
* Add MMFewShot by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/621
|
||||
* Update model readme by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/604
|
||||
* Add input size check to model_inference by @mpena-vina in https://github.com/open-mmlab/mmocr/pull/633
|
||||
* Docstring for textdet models by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/561
|
||||
* Add MMHuman3D in readme by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/644
|
||||
* Use shared menu from theme instead by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/655
|
||||
* Refactor docs structure by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/662
|
||||
* Docs fix by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/664
|
||||
|
||||
### Enhancements
|
||||
* Use bounding box around polygon instead of within polygon by @alexander-soare in https://github.com/open-mmlab/mmocr/pull/469
|
||||
* Add CITATION.cff by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/476
|
||||
* Add py3.9 CI by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/475
|
||||
* update model-index.yml by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/484
|
||||
* Use container in CI by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/502
|
||||
* CircleCI Setup by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/611
|
||||
* Remove unnecessary custom_import from train.py by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/603
|
||||
* Change the upper version of mmcv to 1.5.0 by @zhouzaida in https://github.com/open-mmlab/mmocr/pull/628
|
||||
* Update CircleCI by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/631
|
||||
* Pass custom_hooks to MMCV by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/609
|
||||
* Skip CI when some specific files were changed by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/642
|
||||
* Add markdown linter in pre-commit hook by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/643
|
||||
* Use shape from loaded image by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/652
|
||||
* Cancel previous runs that are not completed by @Harold-lkk in https://github.com/open-mmlab/mmocr/pull/666
|
||||
|
||||
### Bug Fixes
|
||||
* Modify algorithm "sar" weights path in metafile by @ShoupingShan in https://github.com/open-mmlab/mmocr/pull/581
|
||||
* Fix Cuda CI by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/472
|
||||
* Fix image export in test.py for KIE models by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/486
|
||||
* Allow invalid polygons in intersection and union by default by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/471
|
||||
* Update checkpoints' links for SATRN by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/518
|
||||
* Fix converting to onnx bug because of changing key from img_shape to resize_shape by @Harold-lkk in https://github.com/open-mmlab/mmocr/pull/523
|
||||
* Fix PyTorch 1.6 incompatible checkpoints by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/540
|
||||
* Fix paper field in metafiles by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/550
|
||||
* Unify recognition task names in metafiles by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/548
|
||||
* Fix py3.9 CI by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/563
|
||||
* Always map location to cpu when loading checkpoint by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/567
|
||||
* Fix wrong model builder in recog_test_imgs by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/574
|
||||
* Improve dbnet r50 by fixing img std by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/578
|
||||
* Fix resource warning: unclosed file by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/577
|
||||
* Fix bug that same start_point for different texts in draw_texts_by_pil by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/587
|
||||
* Keep original texts for kie by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/588
|
||||
* Fix random seed by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/600
|
||||
* Fix DBNet_r50 config by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/625
|
||||
* Change SBC case to DBC case by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/632
|
||||
* Fix kie demo by @innerlee in https://github.com/open-mmlab/mmocr/pull/610
|
||||
* fix type check by @cuhk-hbsun in https://github.com/open-mmlab/mmocr/pull/650
|
||||
* Remove depreciated image validator in totaltext converter by @gaotongxiao in https://github.com/open-mmlab/mmocr/pull/661
|
||||
* Fix change locals() dict by @Fei-Wang in https://github.com/open-mmlab/mmocr/pull/663
|
||||
* fix #614: textsnake targets by @HolyCrap96 in https://github.com/open-mmlab/mmocr/pull/660
|
||||
|
||||
## New Contributors
|
||||
* @alexander-soare made their first contribution in https://github.com/open-mmlab/mmocr/pull/469
|
||||
* @A465539338 made their first contribution in https://github.com/open-mmlab/mmocr/pull/364
|
||||
* @fatfishZhao made their first contribution in https://github.com/open-mmlab/mmocr/pull/506
|
||||
* @baudm made their first contribution in https://github.com/open-mmlab/mmocr/pull/497
|
||||
* @ShoupingShan made their first contribution in https://github.com/open-mmlab/mmocr/pull/581
|
||||
* @apiaccess21 made their first contribution in https://github.com/open-mmlab/mmocr/pull/593
|
||||
* @zhouzaida made their first contribution in https://github.com/open-mmlab/mmocr/pull/628
|
||||
* @mpena-vina made their first contribution in https://github.com/open-mmlab/mmocr/pull/633
|
||||
* @Fei-Wang made their first contribution in https://github.com/open-mmlab/mmocr/pull/663
|
||||
|
||||
**Full Changelog**: https://github.com/open-mmlab/mmocr/compare/v0.3.0...0.4.0
|
||||
|
||||
## v0.3.0 (25/8/2021)
|
||||
|
||||
### Highlights
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Copyright (c) Open-MMLab. All rights reserved.
|
||||
|
||||
__version__ = '0.3.0'
|
||||
__version__ = '0.4.0'
|
||||
short_version = __version__
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user