Merge pull request #558 from MissPenguin/develop

fix bug in predict_det for sast & update docs

Merge pull request #558 from MissPenguin/develop
fix bug in predict_det for sast & update docs
07381ff1 · MissPenguin · GitHub · 5ed1e242 · 0c3b5d8e · 07381ff1
7 changed file
--- a/README.md
+++ b/README.md
@@ -108,6 +108,8 @@ On Total-Text dataset, the text detection result is as follows:
 |-|-|-|-|-|-|
 |SAST|ResNet50_vd|88.74%|79.80%|84.03%|[Download link](https://paddleocr.bj.bcebos.com/SAST/sast_r50_vd_total_text.tar)|
+**Note：** Additional data, like icdar2013, icdar2017, COCO-Text, ArT, was added to the model training of SAST. Download English public dataset in organized format used by PaddleOCR from [Baidu Drive](https://pan.baidu.com/s/12cPnZcVuV1zn5DOd4mqjVw) (download code: 2bpi).
 For use of [LSVT](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_en/datasets_en.md#1-icdar2019-lsvt) street view dataset with a total of 3w training data，the related configuration and pre-trained models for text detection task are as follows:  
 |Model|Backbone|Configuration file|Pre-trained model|
 |-|-|-|-|
@@ -142,7 +144,7 @@ Refer to [DTRB](https://arxiv.org/abs/1904.01906), the training and evaluation r
 |RARE|MobileNetV3|83.32%|rec_mv3_tps_bilstm_attn|[Download link](https://paddleocr.bj.bcebos.com/rec_mv3_tps_bilstm_attn.tar)|
 |SRN|Resnet50_vd_fpn|88.33%|rec_r50fpn_vd_none_srn|[Download link](https://paddleocr.bj.bcebos.com/SRN/rec_r50fpn_vd_none_srn.tar)|
-**Note：** SRN model uses data expansion method to expand the two training sets mentioned above, and the expanded data can be downloaded from [Baidu Drive](https://pan.baidu.com/s/1-HSZ-ZVdqBF2HaBZ5pRAKA), Extract the code：y3ry.
+**Note：** SRN model uses data expansion method to expand the two training sets mentioned above, and the expanded data can be downloaded from [Baidu Drive](https://pan.baidu.com/s/1-HSZ-ZVdqBF2HaBZ5pRAKA) (download code: y3ry).
 The average accuracy of the two-stage training in the original paper is 89.74%, and that of one stage training in paddleocr is 88.33%. Both pre-trained weights can be downloaded [here](https://paddleocr.bj.bcebos.com/SRN/rec_r50fpn_vd_none_srn.tar).

--- a/doc/doc_ch/inference.md
+++ b/doc/doc_ch/inference.md
@@ -2,13 +2,39 @@
 # 基于Python预测引擎推理
 inference 模型（fluid.io.save_inference_model保存的模型）
-一般是模型训练完成后保存的固化模型，多用于预测部署。
+一般是模型训练完成后保存的固化模型，多用于预测部署。训练过程中保存的模型是checkpoints模型，保存的是模型的参数，多用于恢复训练等。
-训练过程中保存的模型是checkpoints模型，保存的是模型的参数，多用于恢复训练等。
 与checkpoints模型相比，inference 模型会额外保存模型的结构信息，在预测部署、加速推理上性能优越，灵活方便，适合与实际系统集成。更详细的介绍请参考文档[分类预测框架](https://paddleclas.readthedocs.io/zh_CN/latest/extension/paddle_inference.html).
 接下来首先介绍如何将训练的模型转换成inference模型，然后将依次介绍文本检测、文本识别以及两者串联基于预测引擎推理。
+- [一、训练模型转inference模型](#训练模型转inference模型)
+    - [检测模型转inference模型](#检测模型转inference模型)
+    - [识别模型转inference模型](#识别模型转inference模型)
+- [二、文本检测模型推理](#文本检测模型推理)
+    - [1. 超轻量中文检测模型推理](#超轻量中文检测模型推理)
+    - [2. DB文本检测模型推理](#DB文本检测模型推理)
+    - [3. EAST文本检测模型推理](#EAST文本检测模型推理)
+    - [4. SAST文本检测模型推理](#SAST文本检测模型推理)
+- [三、文本识别模型推理](#文本识别模型推理)
+    - [1. 超轻量中文识别模型推理](#超轻量中文识别模型推理)
+    - [2. 基于CTC损失的识别模型推理](#基于CTC损失的识别模型推理)
+    - [3. 基于Attention损失的识别模型推理](#基于Attention损失的识别模型推理)
+    - [4. 自定义文本识别字典的推理](#自定义文本识别字典的推理)
+- [四、文本检测、识别串联推理](#文本检测、识别串联推理)
+    - [1. 超轻量中文OCR模型推理](#超轻量中文OCR模型推理)
+    - [2. 其他模型推理](#其他模型推理)
+<a name="训练模型转inference模型"></a>
 ## 一、训练模型转inference模型
+<a name="检测模型转inference模型"></a>
 ### 检测模型转inference模型
 下载超轻量级中文检测模型：
@@ -24,15 +50,16 @@ wget -P ./ch_lite/ https://paddleocr.bj.bcebos.com/ch_models/ch_det_mv3_db.tar &
 python3 tools/export_model.py -c configs/det/det_mv3_db.yml -o Global.checkpoints=./ch_lite/det_mv3_db/best_accuracy Global.save_inference_dir=./inference/det_db/
 ```
-转inference模型时，使用的配置文件和训练时使用的配置文件相同。另外，还需要设置配置文件中的Global.checkpoints、Global.save_inference_dir参数。
+转inference模型时，使用的配置文件和训练时使用的配置文件相同。另外，还需要设置配置文件中的`Global.checkpoints`、`Global.save_inference_dir`参数。
-其中Global.checkpoints指向训练中保存的模型参数文件，Global.save_inference_dir是生成的inference模型要保存的目录。
+其中`Global.checkpoints`指向训练中保存的模型参数文件，`Global.save_inference_dir`是生成的inference模型要保存的目录。
-转换成功后，在save_inference_dir 目录下有两个文件：
+转换成功后，在`save_inference_dir`目录下有两个文件：
 ```
 inference/det_db/
  └─  model     检测inference模型的program文件
  └─  params    检测inference模型的参数文件
 ```
+<a name="识别模型转inference模型"></a>
 ### 识别模型转inference模型
 下载超轻量中文识别模型：
@@ -51,7 +78,7 @@ python3 tools/export_model.py -c configs/rec/rec_chinese_lite_train.yml -o Globa
        Global.save_inference_dir=./inference/rec_crnn/
 ```
-如果您是在自己的数据集上训练的模型，并且调整了中文字符的字典文件，请注意修改配置文件中的character_dict_path是否是所需要的字典文件。
+**注意：**如果您是在自己的数据集上训练的模型，并且调整了中文字符的字典文件，请注意修改配置文件中的`character_dict_path`是否是所需要的字典文件。
 转换成功后，在目录下有两个文件：
 ```
@@ -60,11 +87,13 @@ python3 tools/export_model.py -c configs/rec/rec_chinese_lite_train.yml -o Globa
  └─  params    识别inference模型的参数文件
 ```
+<a name="文本检测模型推理"></a>
 ## 二、文本检测模型推理
-下面将介绍超轻量中文检测模型推理、DB文本检测模型推理和EAST文本检测模型推理。默认配置是根据DB文本检测模型推理设置的。由于EAST和DB算法差别很大，在推理时，需要通过传入相应的参数适配EAST文本检测算法。
+文本检测模型推理，默认使用DB模型的配置参数。当不使用DB模型时，在推理时，需要通过传入相应的参数进行算法适配，细节参考下文。
-### 1.超轻量中文检测模型推理
+<a name="超轻量中文检测模型推理"></a>
+### 1. 超轻量中文检测模型推理
 超轻量中文检测模型推理，可以执行如下命令：
@@ -72,11 +101,11 @@ python3 tools/export_model.py -c configs/rec/rec_chinese_lite_train.yml -o Globa
 python3 tools/infer/predict_det.py --image_dir="./doc/imgs/2.jpg" --det_model_dir="./inference/det_db/"
 ```
-可视化文本检测结果默认保存到 ./inference_results 文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
+可视化文本检测结果默认保存到`./inference_results`文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
 ![](../imgs_results/det_res_2.jpg)
-通过设置参数det_max_side_len的大小，改变检测算法中图片规范化的最大值。当图片的长宽都小于det_max_side_len，则使用原图预测，否则将图片等比例缩放到最大值，进行预测。该参数默认设置为det_max_side_len=960. 如果输入图片的分辨率比较大，而且想使用更大的分辨率预测，可以执行如下命令：
+通过设置参数`det_max_side_len`的大小，改变检测算法中图片规范化的最大值。当图片的长宽都小于`det_max_side_len`，则使用原图预测，否则将图片等比例缩放到最大值，进行预测。该参数默认设置为`det_max_side_len=960`。 如果输入图片的分辨率比较大，而且想使用更大的分辨率预测，可以执行如下命令：
 ```
 python3 tools/infer/predict_det.py --image_dir="./doc/imgs/2.jpg" --det_model_dir="./inference/det_db/" --det_max_side_len=1200
@@ -87,7 +116,8 @@ python3 tools/infer/predict_det.py --image_dir="./doc/imgs/2.jpg" --det_model_di
 python3 tools/infer/predict_det.py --image_dir="./doc/imgs/2.jpg" --det_model_dir="./inference/det_db/" --use_gpu=False
 ```
-### 2.DB文本检测模型推理
+<a name="DB文本检测模型推理"></a>
+### 2. DB文本检测模型推理
 首先将DB文本检测训练过程中保存的模型，转换成inference model。以基于Resnet50_vd骨干网络，在ICDAR2015英文数据集训练的模型为例（[模型下载地址](https://paddleocr.bj.bcebos.com/det_r50_vd_db.tar))，可以使用如下命令进行转换：
@@ -105,13 +135,14 @@ DB文本检测模型推理，可以执行如下命令：
 python3 tools/infer/predict_det.py --image_dir="./doc/imgs_en/img_10.jpg" --det_model_dir="./inference/det_db/"
 ```
-可视化文本检测结果默认保存到 ./inference_results 文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
+可视化文本检测结果默认保存到`./inference_results`文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
 ![](../imgs_results/det_res_img_10_db.jpg)
-**注意**：由于ICDAR2015数据集只有1000张训练图像，主要针对英文场景，所以上述模型对中文文本图像检测效果非常差。
+**注意**：由于ICDAR2015数据集只有1000张训练图像，且主要针对英文场景，所以上述模型对中文文本图像检测效果会比较差。
-### 3.EAST文本检测模型推理
+<a name="EAST文本检测模型推理"></a>
+### 3. EAST文本检测模型推理
 首先将EAST文本检测训练过程中保存的模型，转换成inference model。以基于Resnet50_vd骨干网络，在ICDAR2015英文数据集训练的模型为例（[模型下载地址](https://paddleocr.bj.bcebos.com/det_r50_vd_east.tar))，可以使用如下命令进行转换：
@@ -123,24 +154,59 @@ python3 tools/infer/predict_det.py --image_dir="./doc/imgs_en/img_10.jpg" --det_
 python3 tools/export_model.py -c configs/det/det_r50_vd_east.yml -o Global.checkpoints="./models/det_r50_vd_east/best_accuracy" Global.save_inference_dir="./inference/det_east"
 ```
-EAST文本检测模型推理，需要设置参数det_algorithm，指定检测算法类型为EAST，可以执行如下命令：
+**EAST文本检测模型推理，需要设置参数`det_algorithm`，指定检测算法类型为EAST**，可以执行如下命令：
 ```
 python3 tools/infer/predict_det.py --det_algorithm="EAST" --image_dir="./doc/imgs_en/img_10.jpg" --det_model_dir="./inference/det_east/"
 ```
-可视化文本检测结果默认保存到 ./inference_results 文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
+可视化文本检测结果默认保存到`./inference_results`文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
 ![](../imgs_results/det_res_img_10_east.jpg)
-**注意**：本代码库中EAST后处理中NMS采用的Python版本，所以预测速度比较耗时。如果采用C++版本，会有明显加速。
+**注意**：本代码库中，EAST后处理Locality-Aware NMS有python和c++两种版本，c++版速度明显快于python版。由于c++版本nms编译版本问题，只有python3.5环境下会调用c++版nms，其他情况将调用python版nms。
+<a name="SAST文本检测模型推理"></a>
+### 4. SAST文本检测模型推理
+#### (1). 四边形文本检测模型（ICDAR2015）  
+首先将SAST文本检测训练过程中保存的模型，转换成inference model。以基于Resnet50_vd骨干网络，在ICDAR2015英文数据集训练的模型为例([模型下载地址](https://paddleocr.bj.bcebos.com/SAST/sast_r50_vd_icdar2015.tar))，可以使用如下命令进行转换：
+```
+python3 tools/export_model.py -c configs/det/det_r50_vd_sast_icdar15.yml -o Global.checkpoints="./models/sast_r50_vd_icdar2015/best_accuracy" Global.save_inference_dir="./inference/det_sast_ic15"
+```
+**SAST文本检测模型推理，需要设置参数`det_algorithm`，指定检测算法类型为SAST**，可以执行如下命令：
+```
+python3 tools/infer/predict_det.py --det_algorithm="SAST" --image_dir="./doc/imgs_en/img_10.jpg" --det_model_dir="./inference/det_sast_ic15/"
+```
+可视化文本检测结果默认保存到`./inference_results`文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
+![](../imgs_results/det_res_img_10_sast.jpg)
+#### (2). 弯曲文本检测模型（Total-Text）  
+首先将SAST文本检测训练过程中保存的模型，转换成inference model。以基于Resnet50_vd骨干网络，在Total-Text英文数据集训练的模型为例（[模型下载地址](https://paddleocr.bj.bcebos.com/SAST/sast_r50_vd_total_text.tar))，可以使用如下命令进行转换：
+```
+python3 tools/export_model.py -c configs/det/det_r50_vd_sast_totaltext.yml -o Global.checkpoints="./models/sast_r50_vd_total_text/best_accuracy" Global.save_inference_dir="./inference/det_sast_tt"
+```
+**SAST文本检测模型推理，需要设置参数`det_algorithm`，指定检测算法类型为SAST**，可以执行如下命令：
+```
+python3 tools/infer/predict_det.py --det_algorithm="SAST" --image_dir="./doc/imgs_en/img623.jpg" --det_model_dir="./inference/det_sast_tt/" --det_sast_polygon=True
+```
+可视化文本检测结果默认保存到`./inference_results`文件夹里面，结果文件的名称前缀为'det_res'。结果示例如下：
+![](../imgs_results/det_res_img623_sast.jpg)
+**注意**：本代码库中，SAST后处理Locality-Aware NMS有python和c++两种版本，c++版速度明显快于python版。由于c++版本nms编译版本问题，只有python3.5环境下会调用c++版nms，其他情况将调用python版nms。
+<a name="文本识别模型推理"></a>
 ## 三、文本识别模型推理
 下面将介绍超轻量中文识别模型推理、基于CTC损失的识别模型推理和基于Attention损失的识别模型推理。对于中文文本识别，建议优先选择基于CTC损失的识别模型，实践中也发现基于Attention损失的效果不如基于CTC损失的识别模型。此外，如果训练时修改了文本的字典，请参考下面的自定义文本识别字典的推理。
-### 1.超轻量中文识别模型推理
+<a name="超轻量中文识别模型推理"></a>
+### 1. 超轻量中文识别模型推理
 超轻量中文识别模型推理，可以执行如下命令：
@@ -155,7 +221,8 @@ python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words/ch/word_4.jpg"
 Predicts of ./doc/imgs_words/ch/word_4.jpg:['实力活力', 0.89552695]
-### 2.基于CTC损失的识别模型推理
+<a name="基于CTC损失的识别模型推理"></a>
+### 2. 基于CTC损失的识别模型推理
 我们以STAR-Net为例，介绍基于CTC损失的识别模型推理。 CRNN和Rosetta使用方式类似，不用设置识别算法参数rec_algorithm。
@@ -176,7 +243,8 @@ STAR-Net文本识别模型推理，可以执行如下命令：
 python3 tools/infer/predict_rec.py --image_dir="./doc/imgs_words_en/word_336.png" --rec_model_dir="./inference/starnet/" --rec_image_shape="3, 32, 100" --rec_char_type="en"
 ```
-### 3.基于Attention损失的识别模型推理
+<a name="基于Attention损失的识别模型推理"></a>
+### 3. 基于Attention损失的识别模型推理
 基于Attention损失的识别模型与ctc不同，需要额外设置识别算法参数 --rec_algorithm="RARE"
@@ -202,16 +270,18 @@ self.character_str = "0123456789abcdefghijklmnopqrstuvwxyz"
 dict_character = list(self.character_str)
 ```
-### 4.自定义文本识别字典的推理
+<a name="自定义文本识别字典的推理"></a>
+### 4. 自定义文本识别字典的推理
 如果训练时修改了文本的字典，在使用inference模型预测时，需要通过`--rec_char_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="en" --rec_char_dict_path="your text dict path"
 ```
+<a name="文本检测、识别串联推理"></a>
 ## 四、文本检测、识别串联推理
+<a name="超轻量中文OCR模型推理"></a>
-### 1.超轻量中文OCR模型推理
+### 1. 超轻量中文OCR模型推理
 在执行预测时，需要通过参数image_dir指定单张图像或者图像集合的路径、参数det_model_dir指定检测inference模型的路径和参数rec_model_dir指定识别inference模型的路径。可视化识别结果默认保存到 ./inference_results 文件夹里面。
@@ -223,9 +293,14 @@ python3 tools/infer/predict_system.py --image_dir="./doc/imgs/2.jpg" --det_model
 ![](../imgs_results/2.jpg)
-### 2.其他模型推理
+<a name="其他模型推理"></a>
+### 2. 其他模型推理
+如果想尝试使用其他检测算法或者识别算法，请参考上述文本检测模型推理和文本识别模型推理，更新相应配置和模型。
+**注意：由于检测框矫正逻辑的局限性，SAST弯曲文本检测模型（即，使用参数`--det_sast_polygon=True`时）暂时无法用来模型串联。**
-如果想尝试使用其他检测算法或者识别算法，请参考上述文本检测模型推理和文本识别模型推理，更新相应配置和模型，下面给出基于EAST文本检测和STAR-Net文本识别执行命令：
+下面给出基于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_type="en"

--- a/doc/imgs_en/img623.jpg
+++ b/doc/imgs_en/img623.jpg
--- a/doc/imgs_results/det_res_img623_sast.jpg
+++ b/doc/imgs_results/det_res_img623_sast.jpg
--- a/doc/imgs_results/det_res_img_10_sast.jpg
+++ b/doc/imgs_results/det_res_img_10_sast.jpg
--- a/tools/infer/predict_det.py
+++ b/tools/infer/predict_det.py
@@ -58,9 +58,15 @@ class TextDetector(object):
            self.preprocess_op = SASTProcessTest(preprocess_params)
            postprocess_params["score_thresh"] = args.det_sast_score_thresh
            postprocess_params["nms_thresh"] = args.det_sast_nms_thresh
-            postprocess_params["sample_pts_num"] = args.det_sast_sample_pts_num
+            self.det_sast_polygon = args.det_sast_polygon
-            postprocess_params["expand_scale"] = args.det_sast_expand_scale
+            if self.det_sast_polygon:
-            postprocess_params["shrink_ratio_of_width"] = args.det_sast_shrink_ratio_of_width
+                postprocess_params["sample_pts_num"] = 6
+                postprocess_params["expand_scale"] = 1.2
+                postprocess_params["shrink_ratio_of_width"] = 0.2
+            else:
+                postprocess_params["sample_pts_num"] = 2
+                postprocess_params["expand_scale"] = 1.0
+                postprocess_params["shrink_ratio_of_width"] = 0.3
            self.postprocess_op = SASTPostProcess(postprocess_params)
        else:
            logger.info("unknown det_algorithm:{}".format(self.det_algorithm))
@@ -94,7 +100,7 @@ class TextDetector(object):
        return rect
    def clip_det_res(self, points, img_height, img_width):
-        for pno in range(4):
+        for pno in range(points.shape[0]):
            points[pno, 0] = int(min(max(points[pno, 0], 0), img_width - 1))
            points[pno, 1] = int(min(max(points[pno, 1], 0), img_height - 1))
        return points
@@ -113,6 +119,15 @@ class TextDetector(object):
        dt_boxes = np.array(dt_boxes_new)
        return dt_boxes
+    def filter_tag_det_res_only_clip(self, dt_boxes, image_shape):
+        img_height, img_width = image_shape[0:2]
+        dt_boxes_new = []
+        for box in dt_boxes:
+            box = self.clip_det_res(box, img_height, img_width)
+            dt_boxes_new.append(box)
+        dt_boxes = np.array(dt_boxes_new)
+        return dt_boxes
    def __call__(self, img):
        ori_im = img.copy()
        im, ratio_list = self.preprocess_op(img)
@@ -140,6 +155,9 @@ class TextDetector(object):
        dt_boxes_list = self.postprocess_op(outs_dict, [ratio_list])
        dt_boxes = dt_boxes_list[0]
+        if self.det_algorithm == "SAST" and self.det_sast_polygon:
+            dt_boxes = self.filter_tag_det_res_only_clip(dt_boxes, ori_im.shape)
+        else:
            dt_boxes = self.filter_tag_det_res(dt_boxes, ori_im.shape)
        elapse = time.time() - starttime
        return dt_boxes, elapse

--- a/tools/infer/utility.py
+++ b/tools/infer/utility.py
@@ -56,9 +56,7 @@ def parse_args():
    #SAST parmas
    parser.add_argument("--det_sast_score_thresh", type=float, default=0.5)
    parser.add_argument("--det_sast_nms_thresh", type=float, default=0.2)
-    parser.add_argument("--det_sast_sample_pts_num", type=float, default=2)
+    parser.add_argument("--det_sast_polygon", type=bool, default=False)
-    parser.add_argument("--det_sast_expand_scale", type=float, default=1.0)
-    parser.add_argument("--det_sast_shrink_ratio_of_width", type=float, default=0.3)
    #params for text recognizer
    parser.add_argument("--rec_algorithm", type=str, default='CRNN')