Synchronize documents between the release-2.3 branch and dygraph branch

Synchronize documents between the release-2.3 branch and dygraph branch

README.md

@@ -102,7 +102,6 @@ For a new language request, please refer to [Guideline for new language_requests
 - 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 for PP-OCR Model Library](./doc/doc_en/inference_ppocr_en.md)
  - [PP-OCR Training](./doc/doc_en/training_en.md)
  - [Text Detection](./doc/doc_en/detection_en.md)

README_ch.md

@@ -94,13 +94,16 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力
 - PP-OCR产业落地：从训练到部署
  - [PP-OCR模型与配置文件](./doc/doc_ch/models_and_config.md)
  - [PP-OCR模型下载](./doc/doc_ch/models_list.md)
- - [配置文件内容与生成](./doc/doc_ch/config.md)
  - [PP-OCR模型库快速推理](./doc/doc_ch/inference_ppocr.md)
  - [PP-OCR模型训练](./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模型推理部署
  - [基于C++预测引擎推理](./deploy/cpp_infer/readme.md)
  - [服务化部署](./deploy/pdserving/README_CN.md)

doc/doc_ch/config.md

@@ -37,9 +37,10 @@
 | checkpoints | 加载模型参数路径 | None | 用于中断后加载参数继续训练 |
 | use_visualdl | 设置是否启用visualdl进行可视化log展示 | False | [教程地址](https://www.paddlepaddle.org.cn/paddle/visualdl) |
 | infer_img | 设置预测图像路径或文件夹路径 | ./infer_img | \|
-| character_dict_path | 设置字典路径 | ./ppocr/utils/ppocr_keys_v1.txt | 如果为空，则默认使用小写字母+数字作为字典 |
+| character_dict_path | 设置字典路径 | ./ppocr/utils/ppocr_keys_v1.txt | \ |
 | max_text_length | 设置文本最大长度 | 25 | \ |
-| use_space_char | 设置是否识别空格 | True | |
+| character_type | 设置字符类型 | ch | en/ch, en时将使用默认dict，ch时使用自定义dict|
+| use_space_char | 设置是否识别空格 | True | 仅在 character_type=ch 时支持空格 |
 | label_list | 设置方向分类器支持的角度 | ['0','180'] | 仅在方向分类器中生效 |
 | save_res_path | 设置检测模型的结果保存地址 | ./output/det_db/predicts_db.txt | 仅在检测模型中生效 |
 
@@ -176,7 +177,7 @@ PaddleOCR目前已支持80种（除中文外）语种识别，`configs/rec/multi
  --dict {path/of/dict} \  # 字典文件路径
  -o Global.use_gpu=False # 是否使用gpu
  ...
-
+ 
  ```
 
 意大利文由拉丁字母组成，因此执行完命令后会得到名为 rec_latin_lite_train.yml 的配置文件。
@@ -190,37 +191,38 @@ PaddleOCR目前已支持80种（除中文外）语种识别，`configs/rec/multi
  use_gpu: True
  epoch_num: 500
  ...
+ character_type: it # 需要识别的语种
  character_dict_path: {path/of/dict} # 字典文件所在路径
-
+ 
  Train:
  dataset:
  name: SimpleDataSet
  data_dir: train_data/ # 数据存放根目录
  label_file_list: ["./train_data/train_list.txt"] # 训练集label路径
  ...
-
+ 
  Eval:
  dataset:
  name: SimpleDataSet
  data_dir: train_data/ # 数据存放根目录
  label_file_list: ["./train_data/val_list.txt"] # 验证集label路径
  ...
-
+ 
  ```
 
 目前PaddleOCR支持的多语言算法有：
 
-| 配置文件 | 算法名称 | backbone | trans | seq | pred | language |
-| :--------: | :-------: | :-------: | :-------: | :-----: | :-----: | :-----: |
-| rec_chinese_cht_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 中文繁体 |
-| rec_en_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 英语（区分大小写） |
-| rec_french_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 法语 | 
-| rec_ger_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 德语 |
-| rec_japan_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 日语 |
-| rec_korean_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 韩语 |
-| rec_latin_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 拉丁字母 |
-| rec_arabic_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 阿拉伯字母 | 
-| rec_cyrillic_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 斯拉夫字母 |
-| rec_devanagari_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 梵文字母 |
+| 配置文件 | 算法名称 | backbone | trans | seq | pred | language | character_type |
+| :--------: | :-------: | :-------: | :-------: | :-----: | :-----: | :-----: | :-----: |
+| rec_chinese_cht_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 中文繁体 | chinese_cht|
+| rec_en_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 英语（区分大小写） | EN |
+| rec_french_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 法语 | french |
+| rec_ger_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 德语 | german |
+| rec_japan_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 日语 | japan |
+| rec_korean_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 韩语 | korean |
+| rec_latin_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 拉丁字母 | latin |
+| rec_arabic_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 阿拉伯字母 | ar |
+| rec_cyrillic_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 斯拉夫字母 | cyrillic |
+| rec_devanagari_lite_train.yml | CRNN | Mobilenet_v3 small 0.5 | None | BiLSTM | ctc | 梵文字母 | devanagari |
 
 更多支持语种请参考: [多语言模型](https://github.com/PaddlePaddle/PaddleOCR/blob/release/2.1/doc/doc_ch/multi_languages.md#%E8%AF%AD%E7%A7%8D%E7%BC%A9%E5%86%99)

doc/doc_ch/detection.md

@@ -1,22 +1,24 @@
 
-# 目录
-- [1. 文字检测](#1-----)
- * [1.1 数据准备](#11-----)
- * [1.2 下载预训练模型](#12--------)
- * [1.3 启动训练](#13-----)
- * [1.4 断点训练](#14-----)
- * [1.5 更换Backbone 训练](#15---backbone---)
- * [1.6 指标评估](#16-----)
- * [1.7 测试检测效果](#17-------)
- * [1.8 转inference模型测试](#18--inference----)
-- [2. FAQ](#2-faq)
-
-
-<a name="1-----"></a>
-# 1. 文字检测
+# 文字检测
 
 本节以icdar2015数据集为例，介绍PaddleOCR中检测模型训练、评估、测试的使用方式。
 
+- [1. 准备数据和模型](#1--------)
+ * [1.1 数据准备](#11-----)
+ * [1.2 下载预训练模型](#12--------)
+- [2. 开始训练](#2-----)
+ * [2.1 启动训练](#21-----)
+ * [2.2 断点训练](#22-----)
+ * [2.3 更换Backbone 训练](#23---backbone---)
+- [3. 模型评估与预测](#3--------)
+ * [3.1 指标评估](#31-----)
+ * [3.2 测试检测效果](#32-------)
+- [4. 模型导出与预测](#4--------)
+- [5. FAQ](#5-faq)
+
+<a name="1--------"></a>
+# 1. 准备数据和模型
+
 <a name="11-----"></a>
 ## 1.1 数据准备
 
@@ -83,8 +85,11 @@ wget -P ./pretrain_models/ https://paddle-imagenet-models-name.bj.bcebos.com/dyg
 wget -P ./pretrain_models/ https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/ResNet50_vd_ssld_pretrained.pdparams
 ```
 
-<a name="13-----"></a>
-## 1.3 启动训练
+<a name="2-----"></a>
+# 2. 开始训练
+
+<a name="21-----"></a>
+## 2.1 启动训练
 
 *如果您安装的是cpu版本，请将配置文件中的 `use_gpu` 字段修改为false*
 
@@ -106,8 +111,8 @@ python3 -m paddle.distributed.launch --gpus '0,1,2,3' tools/train.py -c configs/
 python3 tools/train.py -c configs/det/det_mv3_db.yml -o Optimizer.base_lr=0.0001
 ```
 
-<a name="14-----"></a>
-## 1.4 断点训练
+<a name="22-----"></a>
+## 2.2 断点训练
 
 如果训练程序中断，如果希望加载训练中断的模型从而恢复训练，可以通过指定Global.checkpoints指定要加载的模型路径：
 ```shell
@@ -116,8 +121,8 @@ python3 tools/train.py -c configs/det/det_mv3_db.yml -o Global.checkpoints=./you
 
 **注意**：`Global.checkpoints`的优先级高于`Global.pretrained_model`的优先级，即同时指定两个参数时，优先加载`Global.checkpoints`指定的模型，如果`Global.checkpoints`指定的模型路径有误，会加载`Global.pretrained_model`指定的模型。
 
-<a name="15---backbone---"></a>
-## 1.5 更换Backbone 训练
+<a name="23---backbone---"></a>
+## 2.3 更换Backbone 训练
 
 PaddleOCR将网络划分为四部分，分别在[ppocr/modeling](../../ppocr/modeling)下。 进入网络的数据将按照顺序(transforms->backbones->
 necks->heads)依次通过这四个部分。
@@ -164,8 +169,11 @@ args1: args1
 
 **注意**：如果要更换网络的其他模块，可以参考[文档](./add_new_algorithm.md)。
 
-<a name="16-----"></a>
-## 1.6 指标评估
+<a name="3--------"></a>
+# 3. 模型评估与预测
+
+<a name="31-----"></a>
+## 3.1 指标评估
 
 PaddleOCR计算三个OCR检测相关的指标，分别是：Precision、Recall、Hmean（F-Score）。
 
@@ -177,8 +185,8 @@ python3 tools/eval.py -c configs/det/det_mv3_db.yml -o Global.checkpoints="{pat
 
 * 注：`box_thresh`、`unclip_ratio`是DB后处理所需要的参数，在评估EAST模型时不需要设置
 
-<a name="17-------"></a>
-## 1.7 测试检测效果
+<a name="32-------"></a>
+## 3.2 测试检测效果
 
 测试单张图像的检测效果
 ```shell
@@ -195,8 +203,8 @@ python3 tools/infer_det.py -c configs/det/det_mv3_db.yml -o Global.infer_img="./
 python3 tools/infer_det.py -c configs/det/det_mv3_db.yml -o Global.infer_img="./doc/imgs_en/" Global.pretrained_model="./output/det_db/best_accuracy"
 ```
 
-<a name="18--inference----"></a>
-## 1.8 转inference模型测试
+<a name="4--------"></a>
+# 4. 模型导出与预测
 
 inference 模型（`paddle.jit.save`保存的模型）
 一般是模型训练，把模型结构和模型参数保存在文件中的固化模型，多用于预测部署场景。
@@ -218,10 +226,11 @@ python3 tools/infer/predict_det.py --det_algorithm="DB" --det_model_dir="./outpu
 python3 tools/infer/predict_det.py --det_algorithm="EAST" --det_model_dir="./output/det_db_inference/" --image_dir="./doc/imgs/" --use_gpu=True
 ```
 
-<a name="2"></a>
-# 2. FAQ
+<a name="5-faq"></a>
+# 5. FAQ
 
 Q1: 训练模型转inference 模型之后预测效果不一致？
+
 **A**：此类问题出现较多，问题多是trained model预测时候的预处理、后处理参数和inference model预测的时候的预处理、后处理参数不一致导致的。以det_mv3_db.yml配置文件训练的模型为例，训练模型、inference模型预测结果不一致问题解决方式如下：
 - 检查[trained model预处理](https://github.com/PaddlePaddle/PaddleOCR/blob/c1ed243fb68d5d466258243092e56cbae32e2c14/configs/det/det_mv3_db.yml#L116)，和[inference model的预测预处理](https://github.com/PaddlePaddle/PaddleOCR/blob/c1ed243fb68d5d466258243092e56cbae32e2c14/tools/infer/predict_det.py#L42)函数是否一致。算法在评估的时候，输入图像大小会影响精度，为了和论文保持一致，训练icdar15配置文件中将图像resize到[736, 1280]，但是在inference model预测的时候只有一套默认参数，会考虑到预测速度问题，默认限制图像最长边为960做resize的。训练模型预处理和inference模型的预处理函数位于[ppocr/data/imaug/operators.py](https://github.com/PaddlePaddle/PaddleOCR/blob/c1ed243fb68d5d466258243092e56cbae32e2c14/ppocr/data/imaug/operators.py#L147)
 - 检查[trained model后处理](https://github.com/PaddlePaddle/PaddleOCR/blob/c1ed243fb68d5d466258243092e56cbae32e2c14/configs/det/det_mv3_db.yml#L51)，和[inference 后处理参数](https://github.com/PaddlePaddle/PaddleOCR/blob/c1ed243fb68d5d466258243092e56cbae32e2c14/tools/infer/utility.py#L50)是否一致。

doc/doc_ch/inference.md

@@ -273,7 +273,7 @@ python3 tools/export_model.py -c configs/rec/rec_r34_vd_none_bilstm_ctc.yml -o G
 CRNN 文本识别模型推理，可以执行如下命令：
 
 ```
-python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png" --rec_model_dir="./inference/rec_crnn/" --rec_image_shape="3, 32, 100" --rec_char_dict_path="./ppocr/utils/ic15_dict.txt"
+python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png" --rec_model_dir="./inference/rec_crnn/" --rec_image_shape="3, 32, 100" --rec_char_type="en"
 ```
 
 ![](../imgs_words_en/word_336.png)
@@ -288,7 +288,7 @@ Predicts of ./doc/imgs_words_en/word_336.png:('super', 0.9999073)
 
 - 训练时采用的图像分辨率不同，训练上述模型采用的图像分辨率是[3，32，100]，而中文模型训练时，为了保证长文本的识别效果，训练时采用的图像分辨率是[3, 32, 320]。预测推理程序默认的的形状参数是训练中文采用的图像分辨率，即[3, 32, 320]。因此，这里推理上述英文模型时，需要通过参数rec_image_shape设置识别图像的形状。
 
-- 字符列表，DTRB论文中实验只是针对26个小写英文本母和10个数字进行实验，总共36个字符。所有大小字符都转成了小写字符，不在上面列表的字符都忽略，认为是空格。因此这里没有输入字符字典，而是通过如下命令生成字典.因此在推理时需要设置参数rec_char_dict_path，指定为英文字典"./ppocr/utils/ic15_dict.txt"。
+- 字符列表，DTRB论文中实验只是针对26个小写英文本母和10个数字进行实验，总共36个字符。所有大小字符都转成了小写字符，不在上面列表的字符都忽略，认为是空格。因此这里没有输入字符字典，而是通过如下命令生成字典.因此在推理时需要设置参数rec_char_type，指定为英文"en"。
 
 ```
 self.character_str = "0123456789abcdefghijklmnopqrstuvwxyz"
@@ -303,15 +303,15 @@ dict_character = list(self.character_str)
 python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png" \
  --rec_model_dir="./inference/srn/" \
  --rec_image_shape="1, 64, 256" \
- --rec_char_dict_path="./ppocr/utils/ic15_dict.txt" \
+ --rec_char_type="en" \
  --rec_algorithm="SRN"
 ```
 
 ### 4. 自定义文本识别字典的推理
-如果训练时修改了文本的字典，在使用inference模型预测时，需要通过`--rec_char_dict_path`指定使用的字典路径
+如果训练时修改了文本的字典，在使用inference模型预测时，需要通过`--rec_char_dict_path`指定使用的字典路径，并且设置 `rec_char_type=ch`
 
 ```
-python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png" --rec_model_dir="./your inference model" --rec_image_shape="3, 32, 100" --rec_char_dict_path="your text dict path"
+python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png" --rec_model_dir="./your inference model" --rec_image_shape="3, 32, 100" --rec_char_type="ch" --rec_char_dict_path="your text dict path"
 ```
 
 <a name="多语言模型的推理"></a>
@@ -320,7 +320,7 @@ python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png
 需要通过 `--vis_font_path` 指定可视化的字体路径，`doc/fonts/` 路径下有默认提供的小语种字体，例如韩文识别：
 
 ```
-python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words/korean/1.jpg" --rec_model_dir="./your inference model" --rec_char_dict_path="ppocr/utils/dict/korean_dict.txt" --vis_font_path="doc/fonts/korean.ttf"
+python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words/korean/1.jpg" --rec_model_dir="./your inference model" --rec_char_type="korean" --rec_char_dict_path="ppocr/utils/dict/korean_dict.txt" --vis_font_path="doc/fonts/korean.ttf"
 ```
 ![](../imgs_words/korean/1.jpg)
 
@@ -388,7 +388,7 @@ python3 tools/infer/predict_system.py --image_dir="./doc/imgs/00018069.jpg" --de
 下面给出基于EAST文本检测和STAR-Net文本识别执行命令：
 
 ```
-python3 tools/infer/predict_system.py --image_dir="./doc/imgs_en/img_10.jpg" --det_model_dir="./inference/det_east/" --det_algorithm="EAST" --rec_model_dir="./inference/starnet/" --rec_image_shape="3, 32, 100" --rec_char_dict_path="./ppocr/utils/ic15_dict.txt"
+python3 tools/infer/predict_system.py --image_dir="./doc/imgs_en/img_10.jpg" --det_model_dir="./inference/det_east/" --det_algorithm="EAST" --rec_model_dir="./inference/starnet/" --rec_image_shape="3, 32, 100" --rec_char_type="en"
 ```
 
 执行命令后，识别结果图像如下：