[paddleocr]文档图像方向分类模块使用教程

文档图像方向分类模块使用教程

一、概述

文档图像方向分类模块主要是将文档图像的方向区分出来,并使用后处理将其矫正。在诸如文档扫描、证照拍摄等过程中,有时为了拍摄更清晰,会将拍摄设备进行旋转,导致得到的图片也是不同方向的。此时,标准的OCR流程无法很好地应对这些数据。利用图像分类技术,可以预先判断含文字区域的文档或证件的方向,并将其进行方向调整,从而提高OCR处理的准确性。

二、支持模型列表

| 模型 | 模型下载链接 | Top-1 Acc(%) | GPU推理耗时(ms)
[常规模式 / 高性能模式] | CPU推理耗时(ms)
[常规模式 / 高性能模式] | 模型存储大小(M) | 介绍 |
|:—😐:—😐:—😐:—😐:—😐:—😐:—😐
| PP-LCNet_x1_0_doc_ori | 推理模型 / 训练模型 | 99.06 | 2.31 / 0.43 | 3.37 / 1.27 | 7 | 基于PP-LCNet_x1_0的文档图像分类模型,含有四个类别,即0度,90度,180度,270度 |

测试环境说明:

  • 性能测试环境

    • 测试数据集: 自建多场景数据集(1000张图片,含证件/文档等场景)

    • 硬件配置:

      • GPU:NVIDIA Tesla T4

      • CPU:Intel Xeon Gold 6271C @ 2.60GHz

      • 其他环境:Ubuntu 20.04 / cuDNN 8.6 / TensorRT 8.5.2.2

  • 推理模式说明

模式GPU配置CPU配置加速技术组合
常规模式FP32精度 / 无TRT加速FP32精度 / 8线程PaddleInference
高性能模式选择先验精度类型和加速策略的最优组合FP32精度 / 8线程选择先验最优后端(Paddle/OpenVINO/TRT等)

三、快速开始

❗ 在快速开始前,请先安装 PaddleOCR 的 wheel 包,详细请参考 安装教程

使用一行命令即可快速体验:

paddleocr doc_img_orientation_classification -i https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/img_rot180_demo.jpg

您也可以将文档图像方向分类模块中的模型推理集成到您的项目中。运行以下代码前,请您下载 示例图片 到本地。

from paddleocr import DocImgOrientationClassification
 
model = DocImgOrientationClassification(model_name="PP-LCNet_x1_0_doc_ori")
output = model.predict("img_rot180_demo.jpg",  batch_size=1)
for res in output:
    res.print(json_format=False)
    res.save_to_img("./output/demo.png")
    res.save_to_json("./output/res.json")

运行后,得到的结果为:

{'res': {'input_path': 'img_rot180_demo.jpg', 'page_index': None, 'class_ids': array([2], dtype=int32), 'scores': array([0.88164], dtype=float32), 'label_names': ['180']}}

运行结果参数含义如下: - input_path :表示输入图片的路径。 - class_ids :表示预测结果的类别id,含有四个类别,即0度,90度,180度和270度。 - scores :表示预测结果的置信度。 - label_names :表示预测结果的类别名。

可视化图片如下:

相关方法、参数等说明如下:

  • DocImgOrientationClassification 实例化文档图像方向分类模型(此处以 PP-LCNet_x1_0_doc_ori 为例),具体说明如下:
参数参数说明参数类型可选项默认值
model_name模型名称str
model_dir模型存储路径str
device模型推理设备str支持指定GPU具体卡号,如“gpu:0”,其他硬件具体卡号,如“npu:0”,CPU如“cpu”。gpu:0
use_hpip是否启用高性能推理插件boolFalse
hpi_config高性能推理配置dictNone
  • 其中, model_name 必须指定,指定 model_name 后,默认使用内置的模型参数,在此基础上,指定 model_dir 时,使用用户自定义的模型。

  • 调用文档图像方向分类模型的 predict() 方法进行推理预测,该方法会返回一个结果列表。另外,本模块还提供了 predict_iter() 方法。两者在参数接受和结果返回方面是完全一致的,区别在于 predict_iter() 返回的是一个 generator ,能够逐步处理和获取预测结果,适合处理大型数据集或希望节省内存的场景。可以根据实际需求选择使用这两种方法中的任意一种。 predict() 方法参数有 inputbatch_size ,具体说明如下:

参数参数说明参数类型可选项默认值
input待预测数据,支持多种输入类型Python Var / str / list
- Python变量 ,如 numpy.ndarray 表示的图像数据
- 文件路径 ,如图像文件的本地路径: /root/data/img.jpg
- URL链接 ,如图像文件的网络URL: 示例
- 本地目录 ,该目录下需包含待预测数据文件,如本地路径: /root/data/
- 列表 ,列表元素需为上述类型数据,如 [numpy.ndarray, numpy.ndarray]["/root/data/img1.jpg", "/root/data/img2.jpg"]["/root/data1", "/root/data2"]
batch_size批大小int任意整数1
  • 对预测结果进行处理,每个样本的预测结果均为对应的Result对象,且支持打印、保存为图片、保存为 json 文件的操作:
方法方法说明参数参数类型参数说明默认值
print()打印结果到终端format_jsonbool是否对输出内容进行使用 JSON 缩进格式化True
indentint指定缩进级别,以美化输出的 JSON 数据,使其更具可读性,仅当 format_jsonTrue 时有效4
ensure_asciibool控制是否将非 ASCII 字符转义为 Unicode 。设置为 True 时,所有非 ASCII 字符将被转义; False 则保留原始字符,仅当 format_jsonTrue 时有效False
save_to_json()将结果保存为json格式的文件save_pathstr保存的文件路径,当为目录时,保存文件命名与输入文件类型命名一致
indentint指定缩进级别,以美化输出的 JSON 数据,使其更具可读性,仅当 format_jsonTrue 时有效4
ensure_asciibool控制是否将非 ASCII 字符转义为 Unicode 。设置为 True 时,所有非 ASCII 字符将被转义; False 则保留原始字符,仅当 format_jsonTrue 时有效False
save_to_img()将结果保存为图像格式的文件save_pathstr保存的文件路径,当为目录时,保存文件命名与输入文件类型命名一致
  • 此外,也支持通过属性获取带结果的可视化图像和预测结果,具体如下:
属性属性说明
json获取预测的 json 格式的结果
img获取格式为 dict 的可视化图像

四、二次开发

由于PaddleOCR并不直接提供文档图像方向分类的训练,因此,如果需要训练文档图像方向分类模型,可以参考 PaddleX 文档图像方向分类二次开发 部分进行训练。训练后的模型可以无缝集成到 PaddleOCR 的 API 中进行推理。

我的博客即将同步至腾讯云开发者社区,邀请大家一同入驻:https://cloud.tencent.com/developer/support-plan?invite_code=7j59u8ngzcw

更多推荐