Upgrade document structure

PaddlePaddle · Sep 3, 2021 · fd62f27 · fd62f27
1 parent 960f7fc
commit fd62f27
Show file tree

Hide file tree

Showing 12 changed files with 735 additions and 177 deletions.
diff --git a/README.md b/README.md
@@ -78,25 +78,29 @@ For more model downloads (including multiple languages), please refer to [PP-OCR
 For a new language request, please refer to [Guideline for new language_requests](#language_requests).
 
 ## Tutorials
-- [Installation](./doc/doc_en/installation_en.md)
 - [Quick Start](./doc/doc_en/quickstart_en.md)
-- [Code Structure](./doc/doc_en/tree_en.md)
-- Algorithm Introduction
- - [Text Detection Algorithm](./doc/doc_en/algorithm_overview_en.md)
- - [Text Recognition Algorithm](./doc/doc_en/algorithm_overview_en.md)
- - [PP-OCR Pipeline](#PP-OCR-Pipeline)
-- Model Training/Evaluation
- - [Text Detection](./doc/doc_en/detection_en.md)
- - [Text Recognition](./doc/doc_en/recognition_en.md)
- - [Direction Classification](./doc/doc_en/angle_class_en.md)
- - [Yml Configuration](./doc/doc_en/config_en.md)
-- Inference and Deployment
- - [Quick Inference Based on PIP](./doc/doc_en/whl_en.md)
- - [Python Inference](./doc/doc_en/inference_en.md)
- - [C++ Inference](./deploy/cpp_infer/readme_en.md)
- - [Serving](./deploy/pdserving/README.md)
- - [Mobile](./deploy/lite/readme_en.md)
- - [Benchmark](./doc/doc_en/benchmark_en.md) 
+- [PaddleOCR Overview and Installation](./doc/doc_en/paddleOCR_overview.md)
+- PP-OCR Industry Landing: from Training to Deployment
+ - [PP-OCR Model and Configuration](./doc/doc_en/models_and_config_en.md)
+ - [PP-OCR Model Download](./doc/doc_en/models_list_en.md)
+ - [Yml Configuration](./doc/doc_en/config_en.md)
+ - [Python Inference](./doc/doc_en/inference_en.md)
+ - [PP-OCR Training](./doc/doc_en/training.md)
+ - [Text Detection](./doc/doc_en/detection_en.md)
+ - [Text Recognition](./doc/doc_en/recognition_en.md)
+ - [Direction Classification](./doc/doc_en/angle_class_en.md)
+ - Inference and Deployment
+ - [Python Inference](./doc/doc_en/inference_en.md)
+ - [C++ Inference](./deploy/cpp_infer/readme_en.md)
+ - [Serving](./deploy/pdserving/README.md)
+ - [Mobile](./deploy/lite/readme_en.md)
+ - [Benchmark](./doc/doc_en/benchmark_en.md) 
+- [PP-Structure: Information Extraction](./ppstructure/README.md)
+ - [Layout Parser](./ppstructure/layout/README.md)
+ - [Table Recognition](./ppstructure/table/README.md)
+- Academic Circles
+ - [Two-stage Algorithm](./doc/doc_en/algorithm_overview_en.md)
+ - [PGNet Algorithm](./doc/doc_en/algorithm_overview_en.md)
 - Data Annotation and Synthesis
  - [Semi-automatic Annotation Tool: PPOCRLabel](./PPOCRLabel/README.md)
  - [Data Synthesis Tool: Style-Text](./StyleText/README.md)

diff --git a/README_ch.md b/README_ch.md
@@ -72,36 +72,39 @@ PaddleOCR同时支持动态图与静态图两种编程范式
 更多模型下载（包括多语言），可以参考[PP-OCR v2.0 系列模型下载](./doc/doc_ch/models_list.md)
 
 ## 文档教程
-- [快速安装](./doc/doc_ch/installation.md)
-- [中文OCR模型快速使用](./doc/doc_ch/quickstart.md)
-- [多语言OCR模型快速使用](./doc/doc_ch/multi_languages.md)
-- [代码组织结构](./doc/doc_ch/tree.md)
-- 算法介绍
- - [文本检测](./doc/doc_ch/algorithm_overview.md)
- - [文本识别](./doc/doc_ch/algorithm_overview.md)
- - [PP-OCR Pipeline](#PP-OCR)
- - [端到端PGNet算法](./doc/doc_ch/pgnet.md)
-- 模型训练/评估
- - [文本检测](./doc/doc_ch/detection.md)
- - [文本识别](./doc/doc_ch/recognition.md)
- - [方向分类器](./doc/doc_ch/angle_class.md)
- - [yml参数配置文件介绍](./doc/doc_ch/config.md)
-- 预测部署
- - [基于pip安装whl包快速推理](./doc/doc_ch/whl.md)
- - [基于Python脚本预测引擎推理](./doc/doc_ch/inference.md)
- - [基于C++预测引擎推理](./deploy/cpp_infer/readme.md)
- - [服务化部署](./deploy/pdserving/README_CN.md)
- - [端侧部署](./deploy/lite/readme.md)
- - [Benchmark](./doc/doc_ch/benchmark.md)
-- 数据集
- - [通用中英文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/quickstart.md)
+- [PaddleOCR全景图与安装](./doc/doc_ch/paddleOCR_overview.md)
+- PP-OCR产业落地：从训练到部署
+ - [PP-OCR模型与配置文件](./doc/doc_ch/models_and_config.md)
+ - [PP-OCR模型下载](./doc/doc_ch/models_list.md)
+ - [配置文件内容与生成](./doc/doc_ch/config.md)
+ - [模型库快速使用](./doc/doc_ch/inference.md)
+ - [PP-OCR模型训练](./doc/doc_ch/training.md)
+ - [文本检测](./doc/doc_ch/detection.md)
+ - [文本识别](./doc/doc_ch/recognition.md)
+ - [方向分类器](./doc/doc_ch/angle_class.md)
+ - PP-OCR模型推理部署
+ - [基于Python脚本预测引擎推理](./doc/doc_ch/inference.md)
+ - [基于C++预测引擎推理](./deploy/cpp_infer/readme.md)
+ - [服务化部署](./deploy/pdserving/README_CN.md)
+ - [端侧部署](./deploy/lite/readme.md)
+ - [Benchmark](./doc/doc_ch/benchmark.md)
+- [PP-Structure信息提取](./ppstructure/README_ch.md)
+ - [版面分析](./ppstructure/layout/README_ch.md)
+ - [表格识别](./ppstructure/table/README_ch.md)
 - 数据标注与合成
  - [半自动标注工具PPOCRLabel](./PPOCRLabel/README_ch.md)
  - [数据合成工具Style-Text](./StyleText/README_ch.md)
  - [其它数据标注工具](./doc/doc_ch/data_annotation.md)
  - [其它数据合成工具](./doc/doc_ch/data_synthesis.md)
+- OCR学术圈
+ - [两阶段模型介绍与下载](./doc/doc_ch/algorithm_overview.md)
+ - [端到端PGNet算法](./doc/doc_ch/pgnet.md)
+ - 模型训练
+- 数据集
+ - [通用中英文OCR数据集](./doc/doc_ch/datasets.md)
+ - [手写中文OCR数据集](./doc/doc_ch/handwritten_datasets.md)
+ - [垂类多语言OCR数据集](./doc/doc_ch/vertical_and_multilingual_datasets.md)
 - [效果展示](#效果展示)
 - FAQ
  - [【精选】OCR精选10个问题](./doc/doc_ch/FAQ.md)
@@ -111,6 +114,7 @@ PaddleOCR同时支持动态图与静态图两种编程范式
 - [参考文献](./doc/doc_ch/reference.md)
 - [许可证书](#许可证书)
 - [贡献代码](#贡献代码)
+- [代码组织结构](./doc/doc_ch/tree.md)
 
 
 <a name="PP-OCR"></a>

diff --git a/doc/doc_ch/config.md b/doc/doc_ch/config.md
@@ -1,4 +1,8 @@
-## 可选参数列表
+# 配置文件内容与生成
+
+[toc]
+
+## 1. 可选参数列表
 
 以下列表可以通过`--help`查看
 
@@ -8,10 +12,10 @@
 | -o | ALL | 设置配置文件里的参数内容 | None | 使用-o配置相较于-c选择的配置文件具有更高的优先级。例如：`-o Global.use_gpu=false` | 
 
 
-## 配置文件参数介绍
+## 2. 配置文件参数介绍
 
 以 `rec_chinese_lite_train_v2.0.yml ` 为例
-### Global
+### 2.1 Global
 
 | 字段 | 用途 | 默认值 | 备注 |
 | :----------------------: | :---------------------: | :--------------: | :--------------------: |
@@ -121,3 +125,7 @@
 | batch_size_per_card | 训练时单卡batch size | 256 | \ |
 | drop_last | 是否丢弃因数据集样本数不能被 batch_size 整除而产生的最后一个不完整的mini-batch | True | \ |
 | num_workers | 用于加载数据的子进程个数，若为0即为不开启子进程，在主进程中进行数据加载 | 8 | \ |
+
+## 3. 多语言配置文件生成
+
+【参考识别模型训练补充内容】