From 7dc5695d6dfdbc211e95ff500794d3f3b5602a13 Mon Sep 17 00:00:00 2001 From: lizz Date: Sat, 10 Apr 2021 18:04:36 +0800 Subject: [PATCH] Add methods to readme Signed-off-by: lizz --- README.md | 21 ++++++++++++ configs/textdet/maskrcnn/README.md | 12 +++++++ configs/textdet/psenet/README.md | 9 ++--- configs/textrecog/crnn/README.md | 8 ++--- configs/textrecog/nrtr/README.md | 38 +++++++++++----------- configs/textrecog/robust_scanner/README.md | 8 ++--- 6 files changed, 65 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 930d48a7..71266be2 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,27 @@ Documentation: https://mmocr.readthedocs.io/en/latest/. The toolbox provides a comprehensive set of utilities which can help users assess the performance of models. It includes visualizers which allow visualization of images, ground truths as well as predicted bounding boxes, and a validation tool for evaluating checkpoints during training. It also includes data converters to demonstrate how to convert your own data to the annotation files which the toolbox supports. +## [Model Zoo](https://mmocr.readthedocs.io/en/latest/modelzoo.html) + +Supported algorithms: + +
+(click to collapse) + +- [x] [DBNet](configs/textdet/dbnet/README.md) (AAAI'2020) +- [x] [Mask R-CNN](configs/textdet/maskrcnn/README.md) (ICCV'2017) +- [x] [PANet](configs/textdet/panet/README.md) (ICCV'2019) +- [x] [PSENet](configs/textdet/psenet/README.md) (CVPR'2019) +- [x] [TextSnake](configs/textdet/textsnake/README.md) (ECCV'2018) +- [x] [CRNN](configs/textrecog/crnn/crnn_academic_dataset.py) (TPAMI'2016) +- [x] [NRTR](configs/textrecog/nrtr/README.md) (ICDAR'2019) +- [x] [RobustScanner](configs/textrecog/robust_scanner/README.md) (ECCV'2020) +- [x] [SAR](configs/textrecog/sar/README.md) (AAAI'2019) +- [x] [SegOCR](configs/bottom_up/higherhrnet/README.md) (Manuscript'2021) +- [x] [SDMG-R](configs/kie/sdmgr/README.md) (ArXiv'2021) + +
+ ## License This project is released under the [Apache 2.0 license](LICENSE). diff --git a/configs/textdet/maskrcnn/README.md b/configs/textdet/maskrcnn/README.md index 520a9606..805469d5 100644 --- a/configs/textdet/maskrcnn/README.md +++ b/configs/textdet/maskrcnn/README.md @@ -4,6 +4,18 @@ [ALGORITHM] +```bibtex +@INPROCEEDINGS{8237584, + author={K. {He} and G. {Gkioxari} and P. {Dollár} and R. {Girshick}}, + booktitle={2017 IEEE International Conference on Computer Vision (ICCV)}, + title={Mask R-CNN}, + year={2017}, + pages={2980-2988}, + doi={10.1109/ICCV.2017.322}} +``` + +In tuning parameters, we refer to the baseline method in the following article: + ```bibtex @article{pmtd, author={Jingchao Liu and Xuebo Liu and Jie Sheng and Ding Liang and Xin Li and Qingjie Liu}, diff --git a/configs/textdet/psenet/README.md b/configs/textdet/psenet/README.md index 9995b4d8..d88801ac 100644 --- a/configs/textdet/psenet/README.md +++ b/configs/textdet/psenet/README.md @@ -5,11 +5,12 @@ [ALGORITHM] ```bibtex -@article{li2018shape, +@inproceedings{wang2019shape, title={Shape robust text detection with progressive scale expansion network}, - author={Li, Xiang and Wang, Wenhai and Hou, Wenbo and Liu, Ruo-Ze and Lu, Tong and Yang, Jian}, - journal={arXiv preprint arXiv:1806.02559}, - year={2018} + author={Wang, Wenhai and Xie, Enze and Li, Xiang and Hou, Wenbo and Lu, Tong and Yu, Gang and Shao, Shuai}, + booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition}, + pages={9336--9345}, + year={2019} } ``` diff --git a/configs/textrecog/crnn/README.md b/configs/textrecog/crnn/README.md index 186a2bae..57ee0cba 100644 --- a/configs/textrecog/crnn/README.md +++ b/configs/textrecog/crnn/README.md @@ -31,7 +31,7 @@ ## Results and models -| methods | | Regular Text | | | | Irregular Text | | download | -| :-----: | :----: | :----------: | :---: | :---: | :---: | :------------: | :---: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| methods | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | -| [CRNN](/configs/textrecog/crnn/crnn_academic_dataset.py) | 80.5 | 81.5 | 86.5 | | - | - | - | [model](https://download.openmmlab.com/mmocr/textrecog/crnn/crnn_academic-a723a1c5.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/crnn/20210326_111035.log.json) | +| methods | | Regular Text | | | | Irregular Text | | download | +| :------------------------------------------------------: | :----: | :----------: | :--: | :-: | :--: | :------------: | :--: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| methods | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | +| [CRNN](/configs/textrecog/crnn/crnn_academic_dataset.py) | 80.5 | 81.5 | 86.5 | | - | - | - | [model](https://download.openmmlab.com/mmocr/textrecog/crnn/crnn_academic-a723a1c5.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/crnn/20210326_111035.log.json) | diff --git a/configs/textrecog/nrtr/README.md b/configs/textrecog/nrtr/README.md index 011f76a9..3d63deab 100644 --- a/configs/textrecog/nrtr/README.md +++ b/configs/textrecog/nrtr/README.md @@ -33,31 +33,31 @@ ### Train Dataset -| trainset | instance_num | repeat_num | source | -| :--------: | :----------: | :--------: | :----------------------: | -| SynthText | 7266686 | 1 | synth | -| Syn90k | 8919273 | 1 | synth | +| trainset | instance_num | repeat_num | source | +| :-------: | :----------: | :--------: | :----: | +| SynthText | 7266686 | 1 | synth | +| Syn90k | 8919273 | 1 | synth | ### Test Dataset -| testset | instance_num | type | -| :-----: | :----------: | :-------------------------: | -| IIIT5K | 3000 | regular | -| SVT | 647 | regular | -| IC13 | 1015 | regular | -| IC15 | 2077 | irregular | -| SVTP | 645 | irregular | -| CT80 | 288 | irregular | +| testset | instance_num | type | +| :-----: | :----------: | :-------: | +| IIIT5K | 3000 | regular | +| SVT | 647 | regular | +| IC13 | 1015 | regular | +| IC15 | 2077 | irregular | +| SVTP | 645 | irregular | +| CT80 | 288 | irregular | ## Results and Models -| Methods | Backbone || Regular Text |||| Irregular Text ||download| -| :-------: | :---------: | :----: | :----: | :--: | :-: | :--: | :------: | :--: | :-----: | -| | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | -| [NRTR](/configs/textrecog/nrtr/nrtr_r31_1by16_1by8_academic.py) | R31-1/16-1/8 | 93.9 | 90.0| 93.5 | | 74.5 | 78.5 | 86.5 | [model](https://download.openmmlab.com/mmocr/textrecog/nrtr/nrtr_r31_academic_20210406-954db95e.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/nrtr/20210406_010150.log.json) | -| [NRTR](/configs/textrecog/nrtr/nrtr_r31_1by8_1by4_academic.py) | R31-1/8-1/4 | 94.7 | 87.5| 93.3 | | 75.1 | 78.9 | 87.9 | [model](https://download.openmmlab.com/mmocr/textrecog/nrtr/nrtr_r31_1by8_1by4_academic_20210406-ce16e7cc.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/nrtr/20210406_160845.log.json) | +| Methods | Backbone | | Regular Text | | | | Irregular Text | | download | +| :-------------------------------------------------------------: | :----------: | :----: | :----------: | :--: | :-: | :--: | :------------: | :--: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | +| [NRTR](/configs/textrecog/nrtr/nrtr_r31_1by16_1by8_academic.py) | R31-1/16-1/8 | 93.9 | 90.0 | 93.5 | | 74.5 | 78.5 | 86.5 | [model](https://download.openmmlab.com/mmocr/textrecog/nrtr/nrtr_r31_academic_20210406-954db95e.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/nrtr/20210406_010150.log.json) | +| [NRTR](/configs/textrecog/nrtr/nrtr_r31_1by8_1by4_academic.py) | R31-1/8-1/4 | 94.7 | 87.5 | 93.3 | | 75.1 | 78.9 | 87.9 | [model](https://download.openmmlab.com/mmocr/textrecog/nrtr/nrtr_r31_1by8_1by4_academic_20210406-ce16e7cc.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/nrtr/20210406_160845.log.json) | **Notes:** -- `R31-1/16-1/8` means the height of feature from backbone is 1/16 of input image, where 1/8 for width. -- `R31-1/8-1/4` means the height of feature from backbone is 1/8 of input image, where 1/4 for width. +- `R31-1/16-1/8` means the height of feature from backbone is 1/16 of input image, where 1/8 for width. +- `R31-1/8-1/4` means the height of feature from backbone is 1/8 of input image, where 1/4 for width. diff --git a/configs/textrecog/robust_scanner/README.md b/configs/textrecog/robust_scanner/README.md index 90151d5c..722a43b6 100644 --- a/configs/textrecog/robust_scanner/README.md +++ b/configs/textrecog/robust_scanner/README.md @@ -41,10 +41,10 @@ ## Results and Models -| Methods | GPUs | | Regular Text | | | | Irregular Text | | download | -| :-----------------------------------------------------------------------------: | :---: | :----: | :----------: | :---: | :---: | :---: | :------------: | :---: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | -| [RobustScanner](configs/textrecog/robust_scanner/robustscanner_r31_academic.py) | 16 | 95.1 | 89.2 | 93.1 | | 77.8 | 80.3 | 90.3 | [model](https://download.openmmlab.com/mmocr/textrecog/robustscanner/robustscanner_r31_academic-5f05874f.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/robustscanner/20210401_170932.log.json) | +| Methods | GPUs | | Regular Text | | | | Irregular Text | | download | +| :-----------------------------------------------------------------------------: | :--: | :----: | :----------: | :--: | :-: | :--: | :------------: | :--: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| | | IIIT5K | SVT | IC13 | | IC15 | SVTP | CT80 | +| [RobustScanner](configs/textrecog/robust_scanner/robustscanner_r31_academic.py) | 16 | 95.1 | 89.2 | 93.1 | | 77.8 | 80.3 | 90.3 | [model](https://download.openmmlab.com/mmocr/textrecog/robustscanner/robustscanner_r31_academic-5f05874f.pth) \| [log](https://download.openmmlab.com/mmocr/textrecog/robustscanner/20210401_170932.log.json) | ## References