mmdeploy/docs/en/codebases/mmocr.md

## MMOCR Support

MMOCR is an open-source toolbox based on PyTorch and mmdetection for text detection, text recognition, and the corresponding downstream tasks including key information extraction. It is a part of the [OpenMMLab](https://openmmlab.com/) project.

### MMOCR installation tutorial

Please refer to [install.md](https://mmocr.readthedocs.io/en/latest/install.html) for installation.

### List of MMOCR models supported by MMDeploy

| Model | Task             | OnnxRuntime | TensorRT | ncnn  | PPLNN | OpenVINO |                                  Model config                                  |
| :---- | :--------------- | :---------: | :------: | :---: | :---: | :------: | :----------------------------------------------------------------------------: |
| DBNet | text-detection   |      Y      |    Y     |   Y   |   Y   |    Y     | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textdet/dbnet)  |
| CRNN  | text-recognition |      Y      |    Y     |   Y   |   Y   |    N     | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/crnn) |
| SAR   | text-recognition |      Y      |    N     |   N   |   N   |    N     | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/sar)  |


### Reminder

Note that ncnn, pplnn, and OpenVINO only support the configs of DBNet18 for DBNet.

### FAQs

None
[Docs]: Add sphinx document (#109) * Add document structure * better zh_cn document * add build example, update requirement * add readme * add usage * fix end of file * fix codebase names, add TODO 2021-10-09 14:10:42 +08:00			`## MMOCR Support`
[Docs] add ppl install doc, how to test a model doc and mmocr doc (#169) * add ppl install doc and how to test a model doc * remove mmdet model list in ppl.md * resolve comments * fix typo * add mmocr doc * mv configs as the final column * fix typo and align tables * fix lint 2021-11-09 11:43:38 +08:00
			`MMOCR is an open-source toolbox based on PyTorch and mmdetection for text detection, text recognition, and the corresponding downstream tasks including key information extraction. It is a part of the [OpenMMLab](https://openmmlab.com/) project.`

			`### MMOCR installation tutorial`

【Docs】Fix docs about codebase (#317) * fix codebase docs * fix edit * fix mmcls docs * fix docs 2021-12-23 17:35:59 +08:00			`Please refer to [install.md](https://mmocr.readthedocs.io/en/latest/install.html) for installation.`
[Docs] add ppl install doc, how to test a model doc and mmocr doc (#169) * add ppl install doc and how to test a model doc * remove mmdet model list in ppl.md * resolve comments * fix typo * add mmocr doc * mv configs as the final column * fix typo and align tables * fix lint 2021-11-09 11:43:38 +08:00
			`### List of MMOCR models supported by MMDeploy`

docs(docs/zh_cn): update doc and link checker (#418) * docs(docs/zh_cn): add doc and link checker * docs(REAME): update * docs(docs/zh_cn): update * docs(benchmark): update table * docs(zh_cn/benchmark): update link * CI(docs): update link check * ci(doc): update checker * docs(zh_cn): update * style(ci): remove useless para * style(ci): update * docs(zh_cn): update * docs(benchmark.md): fix mobilnet link error * docs(docs/zh_cn): add doc and link checker * docs(REAME): update * docs(docs/zh_cn): update * docs(benchmark): update table * docs(zh_cn/benchmark): update link * CI(docs): update link check * ci(doc): update checker * docs(zh_cn): update * style(ci): remove useless para * style(ci): update * docs(zh_cn): update * docs(benchmark.md): fix mobilnet link error * docs(zh_cn/do_regression_test.md): rebase * docs(docs/zh_cn): add doc and link checker * Update README_zh-CN.md * Update README_zh-CN.md * Update index.rst * Update check-doc-link.yml * [Fix] Fix ci (#426) * fix ci * add nvidia key * remote torch * recover pytorch * ci(codecov): ignore ci * docs(zh_cn): add get_started.md * docs(zh_cn): fix review advice * docs(readthedocs): update * docs(zh_CN): update * docs(zh_CN): revert * fix(docs): review advices * fix(docs): review advices * fix(docs): review Co-authored-by: q.yao <streetyao@live.com> 2022-05-09 10:18:10 +08:00			`\| Model \| Task \| OnnxRuntime \| TensorRT \| ncnn \| PPLNN \| OpenVINO \| Model config \|`
【Docs】fix docs (#32) * fix docs * fix cn docs log link * fix * fix log link 2021-12-31 14:36:55 +08:00			`\| :---- \| :--------------- \| :---------: \| :------: \| :---: \| :---: \| :------: \| :----------------------------------------------------------------------------: \|`
			`\| DBNet \| text-detection \| Y \| Y \| Y \| Y \| Y \| [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textdet/dbnet) \|`
			`\| CRNN \| text-recognition \| Y \| Y \| Y \| Y \| N \| [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/crnn) \|`
			`\| SAR \| text-recognition \| Y \| N \| N \| N \| N \| [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/sar) \|`
[Doc] add mmocr performance benchmark (#240) * add mmocr performance benchmark * add notes * fix typo * add openvino for mmocr and use T4 results for dbnet18 2021-12-08 10:31:57 +08:00
[Docs] add ppl install doc, how to test a model doc and mmocr doc (#169) * add ppl install doc and how to test a model doc * remove mmdet model list in ppl.md * resolve comments * fix typo * add mmocr doc * mv configs as the final column * fix typo and align tables * fix lint 2021-11-09 11:43:38 +08:00
			`### Reminder`

[Doc] add mmocr performance benchmark (#240) * add mmocr performance benchmark * add notes * fix typo * add openvino for mmocr and use T4 results for dbnet18 2021-12-08 10:31:57 +08:00			`Note that ncnn, pplnn, and OpenVINO only support the configs of DBNet18 for DBNet.`
[Docs] add ppl install doc, how to test a model doc and mmocr doc (#169) * add ppl install doc and how to test a model doc * remove mmdet model list in ppl.md * resolve comments * fix typo * add mmocr doc * mv configs as the final column * fix typo and align tables * fix lint 2021-11-09 11:43:38 +08:00
			`### FAQs`

			`None`