From dc9b45da986131bccd39a44aced578389effa634 Mon Sep 17 00:00:00 2001 From: MissPenguin Date: Wed, 6 Apr 2022 13:24:46 +0000 Subject: [PATCH] update docs --- README_ch.md | 74 ++++++++++++------- doc/doc_ch/algorithm_deploy.md | 0 .../{inference.md => algorithm_inference.md} | 0 doc/doc_ch/algorithm_overview.md | 19 +++-- doc/doc_ch/algorithm_overview_structure.md | 6 ++ doc/doc_ch/docvqa_datasets.md | 0 doc/doc_ch/layout_datasets.md | 0 doc/doc_ch/ppocr_introduction.md | 6 ++ doc/doc_ch/table_datasets.md | 0 9 files changed, 72 insertions(+), 33 deletions(-) create mode 100644 doc/doc_ch/algorithm_deploy.md rename doc/doc_ch/{inference.md => algorithm_inference.md} (100%) create mode 100644 doc/doc_ch/algorithm_overview_structure.md create mode 100644 doc/doc_ch/docvqa_datasets.md create mode 100644 doc/doc_ch/layout_datasets.md create mode 100644 doc/doc_ch/ppocr_introduction.md create mode 100644 doc/doc_ch/table_datasets.md diff --git a/README_ch.md b/README_ch.md index 1e6242e9..30d81812 100755 --- a/README_ch.md +++ b/README_ch.md @@ -21,7 +21,6 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 - 2021.12.21《动手学OCR · 十讲》课程开讲，12月21日起每晚八点半线上授课！[免费报名地址](https://aistudio.baidu.com/aistudio/course/introduce/25207)。 - 2021.12.21 发布PaddleOCR v2.4。OCR算法新增1种文本检测算法（PSENet），3种文本识别算法（NRTR、SEED、SAR）；文档结构化算法新增1种关键信息提取算法（SDMGR，[文档](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.4/ppstructure/docs/kie.md)），3种DocVQA算法（LayoutLM、LayoutLMv2，LayoutXLM，[文档](https://github.com/PaddlePaddle/PaddleOCR/tree/release/2.4/ppstructure/vqa)）。 -- PaddleOCR研发团队对最新发版内容技术深入解读，9月8日晚上20:15，[课程回放](https://aistudio.baidu.com/aistudio/education/group/info/6758)。 - 2021.9.7 发布PaddleOCR v2.3与[PP-OCRv2](#PP-OCRv2)，CPU推理速度相比于PP-OCR server提升220%；效果相比于PP-OCR mobile 提升7%。 - 2021.8.3 发布PaddleOCR v2.2，新增文档结构分析[PP-Structure](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.2/ppstructure/README_ch.md)工具包，支持版面分析与表格识别（含Excel导出）。 @@ -66,39 +65,42 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 ## 文档教程 -
-文档教程 - - [运行环境准备](./doc/doc_ch/environment.md) -- [快速开始（中英文/多语言/版面分析）](./doc/doc_ch/quickstart.md) -- PP-OCR文本检测识别 - - [PP-OCR模型库](./doc/doc_ch/models.md) - - [PP-OCR模型下载](./doc/doc_ch/models_list.md) - - [Python引擎的PP-OCR模型库推理](./doc/doc_ch/inference_ppocr.md) - - [PP-OCR模型训练](./doc/doc_ch/training.md) +- [快速开始（中英文/多语言/文档分析）](./doc/doc_ch/quickstart.md) +- [PP-OCR文本检测识别](./doc/doc_ch/ppocr_introduction.md) + - [模型库](./doc/doc_ch/models_list.md) + - [模型训练](./doc/doc_ch/training.md) - [文本检测](./doc/doc_ch/detection.md) - [文本识别](./doc/doc_ch/recognition.md) - [文本方向分类器](./doc/doc_ch/angle_class.md) - - [配置文件内容与生成](./doc/doc_ch/config.md) - - PP-OCR模型压缩 - - [知识蒸馏](./doc/doc_ch/knowledge_distillation.md) + - 模型压缩 - [模型量化](./deploy/slim/quantization/README.md) - [模型裁剪](./deploy/slim/prune/README.md) - - PP-OCR模型推理部署 + - [知识蒸馏](./doc/doc_ch/knowledge_distillation.md) + - [推理部署](./deploy/readme_ch.md) + - [Python引擎的PP-OCR模型库推理](./doc/doc_ch/inference_ppocr.md) - [基于C++预测引擎推理](./deploy/cpp_infer/readme.md) - [服务化部署](./deploy/pdserving/README_CN.md) - [端侧部署](./deploy/lite/readme.md) - [Paddle2ONNX模型转化与预测](./deploy/paddle2onnx/readme.md) - [Benchmark](./doc/doc_ch/benchmark.md) -- [PP-Structure信息提取](./ppstructure/README_ch.md) - - [版面分析](./ppstructure/layout/README_ch.md) - - [表格识别](./ppstructure/table/README_ch.md) - - [DocVQA](./ppstructure/vqa/README.md) - - [关键信息提取](./ppstructure/docs/kie.md) -- OCR学术圈 - - [两阶段模型介绍与下载](./doc/doc_ch/algorithm_overview.md) - - [端到端PGNet算法](./doc/doc_ch/pgnet.md) - - [基于Python脚本预测引擎推理](./doc/doc_ch/inference.md) +- [PP-Structure文档分析](./ppstructure/README_ch.md) + - [模型库]() + - [模型训练](./doc/doc_ch/training.md) + - [版面分析](./ppstructure/layout/README_ch.md) + - [表格识别](./ppstructure/table/README_ch.md) + - [关键信息提取](./ppstructure/docs/kie.md) + - [DocVQA](./ppstructure/docs/kie.md) + - [推理部署](./deploy/readme_ch.md) + - [Python引擎的PP-OCR模型库推理]() + - [基于C++预测引擎推理]() + - [服务化部署](./deploy/pdserving/README_CN.md) + - [Paddle2ONNX模型转化与预测]() +- 前沿算法与模型 + - [OCR算法与模型](./doc/doc_ch/algorithm_overview.md) + - [文档分析算法与模型](./doc/doc_ch/algorithm_overview_structure.md) + - [基于Python预测引擎推理](./doc/doc_ch/algorithm_inference.md) + - [更多推理部署](./doc/doc_ch/algorithm_deploy.md) - [使用PaddleOCR架构添加新算法](./doc/doc_ch/add_new_algorithm.md) - 数据标注与合成 - [半自动标注工具PPOCRLabel](./PPOCRLabel/README_ch.md) @@ -109,6 +111,9 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 - [通用中英文OCR数据集](./doc/doc_ch/datasets.md) - [手写中文OCR数据集](./doc/doc_ch/handwritten_datasets.md) - [垂类多语言OCR数据集](./doc/doc_ch/vertical_and_multilingual_datasets.md) + - [版面分析数据集](./doc/doc_ch/layout_datasets.md) + - [表格识别数据集](./doc/doc_ch/table_datasets.md) + - [DocVQA数据集](./doc/doc_ch/docvqa_datasets.md) - [效果展示](#效果展示) - FAQ - [通用问题](./doc/doc_ch/FAQ.md) @@ -117,7 +122,6 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 - [许可证书](#许可证书) - [代码组织结构](./doc/doc_ch/tree.md) -
@@ -134,7 +138,9 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 ## 效果展示 [more](./doc/doc_ch/visualization.md) -- 中文模型 + +
+中文模型
@@ -144,17 +150,31 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力
+ +
+ -- 英文模型 +
+英文模型 +
-- 其他语言模型 +
+ + +
+其他语言模型 +
+ +
+ + ## 许可证书 diff --git a/doc/doc_ch/algorithm_deploy.md b/doc/doc_ch/algorithm_deploy.md new file mode 100644 index 00000000..e69de29b diff --git a/doc/doc_ch/inference.md b/doc/doc_ch/algorithm_inference.md similarity index 100% rename from doc/doc_ch/inference.md rename to doc/doc_ch/algorithm_inference.md diff --git a/doc/doc_ch/algorithm_overview.md b/doc/doc_ch/algorithm_overview.md index a784067a..0aa1dd82 100755 --- a/doc/doc_ch/algorithm_overview.md +++ b/doc/doc_ch/algorithm_overview.md @@ -1,11 +1,11 @@ -# 两阶段算法 +# OCR算法 -- [两阶段算法](#两阶段算法) - - [1. 算法介绍](#1-算法介绍) +- [1. 算法介绍](#1-算法介绍) - [1.1 文本检测算法](#11-文本检测算法) - [1.2 文本识别算法](#12-文本识别算法) - - [2. 模型训练](#2-模型训练) - - [3. 模型推理](#3-模型推理) + - [1.2 端到端算法](#13-端到端算法) +- [2. 模型训练](#2-模型训练) +- [3. 模型推理](#3-模型推理) @@ -54,7 +54,7 @@ PaddleOCR开源的文本检测算法列表： ### 1.2 文本识别算法 -PaddleOCR基于动态图开源的文本识别算法列表： +PaddleOCR开源的文本识别算法列表： - [x] CRNN([paper](https://arxiv.org/abs/1507.05717))[7]（ppocr推荐） - [x] Rosetta([paper](https://arxiv.org/abs/1910.05085))[10] - [x] STAR-Net([paper](http://www.bmva.org/bmvc/2016/papers/paper043/index.html))[11] @@ -81,6 +81,13 @@ PaddleOCR基于动态图开源的文本识别算法列表： |SAR|Resnet31| 87.20% | rec_r31_sar | [训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.1/rec/rec_r31_sar_train.tar) | |SEED|Aster_Resnet| 85.35% | rec_resnet_stn_bilstm_att | [训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.1/rec/rec_resnet_stn_bilstm_att.tar) | + + +### 1.3 端到端算法 + +PaddleOCR开源的端到端OCR算法列表： +- [x] PGNet([paper](https://www.aaai.org/AAAI21Papers/AAAI-2885.WangP.pdf)) + ## 2. 模型训练 diff --git a/doc/doc_ch/algorithm_overview_structure.md b/doc/doc_ch/algorithm_overview_structure.md new file mode 100644 index 00000000..4bf05220 --- /dev/null +++ b/doc/doc_ch/algorithm_overview_structure.md @@ -0,0 +1,6 @@ +# 文档分析算法 + +- [1. 版面分析算法]() +- [2. 表格识别算法]() +- [3. 关键信息提取算法]() +- [4. DocVQA算法]() \ No newline at end of file diff --git a/doc/doc_ch/docvqa_datasets.md b/doc/doc_ch/docvqa_datasets.md new file mode 100644 index 00000000..e69de29b diff --git a/doc/doc_ch/layout_datasets.md b/doc/doc_ch/layout_datasets.md new file mode 100644 index 00000000..e69de29b diff --git a/doc/doc_ch/ppocr_introduction.md b/doc/doc_ch/ppocr_introduction.md new file mode 100644 index 00000000..214a26f2 --- /dev/null +++ b/doc/doc_ch/ppocr_introduction.md @@ -0,0 +1,6 @@ +# PP-OCR系列模型 + + +- [PP-OCRv2 pipeline]() +- [Benchmark]() +- [Modle zoo]() \ No newline at end of file diff --git a/doc/doc_ch/table_datasets.md b/doc/doc_ch/table_datasets.md new file mode 100644 index 00000000..e69de29b -- GitLab