Skip to content

Commit

Permalink
revise homepage readme for r0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
panshaowu committed Dec 14, 2023
1 parent 6604ed9 commit f3d5c9e
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,13 @@ Please refer to [MindOCR Models Inference - Quick Start](docs/en/inference/infer

</details>

<details open markdown>
<summary>Key Information Extraction</summary>

- [x] [LayoutXLM SER](configs/kie/vi_layoutxlm/README_CN.md) (arXiv'2016)

</details>

For the detailed performance of the trained models, please refer to [configs](./configs).

For details of MindSpore Lite and ACL inference models support, please refer to [MindOCR Models Support List](docs/en/inference/inference_quickstart.md) and [Third-party Models Support List](docs/en/inference/inference_thirdparty_quickstart.md) (PaddleOCR, MMOCR, etc.).
Expand Down Expand Up @@ -219,14 +226,40 @@ MindOCR provides a [dataset conversion tool](tools/dataset_converters) to OCR da

</details>

<details close markdown>
<summary>Layout Analysis Datasets</summary>

- [PublayNet](https://github.com/ibm-aur-nlp/PubLayNet) [[paper](https://arxiv.org/abs/1908.07836)] [[download](https://dax-cdn.cdn.appdomain.cloud/dax-publaynet/1.0.0/publaynet.tar.gz)]

</details>

<details close markdown>
<summary>Key Information Extraction Datasets</summary>

- [XFUND](https://github.com/doc-analysis/XFUND) [[paper](https://aclanthology.org/2022.findings-acl.253/)] [[download](https://github.com/doc-analysis/XFUND)]

</details>

We will include more datasets for training and evaluation. This list will be continuously updated.

## Notes

### What is New
- 2023/12/14
1. Add new trained models
- [LayoutXLM SER](configs/kie/vi_layoutxlm) for key information extraction
- [VI-LayoutXLM SER](configs/kie/layoutlm_series) for key information extraction
- [PP-OCRv3 DBNet](configs/det/dbnet/db_mobilenetv3_ppocrv3.yaml) for text detection and [PP-OCRv3 SVTR](configs/rec/svtr/svtr_ppocrv3_ch.yaml) for recognition, supporting online inferece and finetuning
2. Add more benchmark datasets and their results
- [XFUND](configs/kie/vi_layoutxlm/README_CN.md)
- 2023/11/28
1. Add offline inference support for PP-OCRv4
2. Fix bugs of third-party models offline inference
- 2023/11/17
1. Add new trained models
- [YOLOv8](configs/layout/yolov8) for layout analysis
2. Add more benchmark datasets and their results
- [PublayNet](configs/layout/yolov8/README_CN.md)
- 2023/07/06
1. Add new trained models
- [RobustScanner](configs/rec/robustscanner) for text recognition
Expand Down
33 changes: 33 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,13 @@ python tools/eval.py \
- [x] [YOLOv8](configs/layout/yolov8/README_CN.md) ([Ultralytics Inc.](https://github.com/ultralytics/ultralytics))
</details>

<details open markdown>
<summary>关键信息抽取</summary>

- [x] [LayoutXLM SER](configs/kie/vi_layoutxlm/README_CN.md) (arXiv'2016)

</details>

关于以上模型的具体训练方法和结果,请参见[configs](./configs)下各模型子目录的readme文档。

关于[MindSpore Lite](https://www.mindspore.cn/lite)[ACL](https://www.hiascend.com/document/detail/zh/canncommercial/63RC1/inferapplicationdev/aclcppdevg/aclcppdevg_000004.html)模型推理的支持列表,
Expand Down Expand Up @@ -213,14 +220,40 @@ MindOCR提供了[数据格式转换工具](tools/dataset_converters) ,以支

</details>

<details close markdown>
<summary>版面分析数据集</summary>

- [PublayNet](https://github.com/ibm-aur-nlp/PubLayNet) [[paper](https://arxiv.org/abs/1908.07836)] [[download](https://dax-cdn.cdn.appdomain.cloud/dax-publaynet/1.0.0/publaynet.tar.gz)]

</details>

<details close markdown>
<summary>关键信息抽取数据集</summary>

- [XFUND](https://github.com/doc-analysis/XFUND) [[paper](https://aclanthology.org/2022.findings-acl.253/)] [[download](https://github.com/doc-analysis/XFUND)]

</details>

我们会在更多的数据集上进行模型训练和验证。该列表将持续更新。

## 重要信息

### 更新日志
- 2023/12/14
1. 增加新模型
- 关键信息抽取[LayoutXLM SER](configs/kie/vi_layoutxlm)
- 关键信息抽取[VI-LayoutXLM SER](configs/kie/layoutlm_series)
- 文本检测[PP-OCRv3 DBNet](configs/det/dbnet/db_mobilenetv3_ppocrv3.yaml)和文本识别[PP-OCRv3 SVTR](configs/rec/svtr/svtr_ppocrv3_ch.yaml),支持在线推理和微调训练
2. 添加更多基准数据集及其结果
- [XFUND](configs/kie/vi_layoutxlm/README_CN.md)
- 2023/11/28
1. 增加支持PP-OCRv4模型离线推理
2. 修复第三方模型离线推理bug
- 2023/11/17
1. 增加新模型
- 版面分析[YOLOv8](configs/layout/yolov8)
2. 添加更多基准数据集及其结果
- [PublayNet](configs/layout/yolov8/README_CN.md)
- 2023/07/06
1. 增加新模型
- 文本识别[RobustScanner](configs/rec/robustscanner)
Expand Down

0 comments on commit f3d5c9e

Please sign in to comment.