PaddleX 提供了丰富的模型产线,模型产线由一个或多个模型组合实现,每个模型产线都能够解决特定的场景任务问题。PaddleX 所提供的模型产线均支持快速体验,如果效果不及预期,也同样支持使用私有数据微调模型,并且 PaddleX 提供了 Python API,方便将产线集成到个人项目中。在使用之前,您首先需要安装 PaddleX, 安装方式请参考 PaddleX 安装。此处以一个手写中文识别的任务为例子,介绍模型产线工具的使用流程。
首先,需要根据您的任务场景,选择对应的 PaddleX 产线,此处为手写中文识别,需要了解到这个任务属于文本识别任务,对应 PaddleX 的通用OCR产线。如果无法确定任务和产线的对应关系,您可以在 PaddleX 支持的模型产线列表中了解相关产线的能力介绍。
PaddleX 提供了两种体验的方式,一种是可以直接通过 PaddleX wheel 包在本地体验,另外一种是可以在 AI Studio 星河社区上体验。
本地体验方式:
paddlex --pipeline OCR \
--input https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/practical_tutorial/OCR_rec/case.png
--use_doc_orientation_classify False \
--use_doc_unwarping False \
--use_textline_orientation False \
--device gpu:0 \
--save_path ./output/
星河社区体验方式:前往AI Studio 星河社区,点击【创建产线】,创建【通用OCR】产线进行快速体验;
快速体验产出推理结果示例:
当体验完该产线之后,需要确定产线是否符合预期(包含精度、速度等),产线包含的模型是否需要继续微调,如果模型的速度或者精度不符合预期,则需要根据模型选择选择可替换的模型继续测试,确定效果是否满意。如果最终效果均不满意,则需要微调模型。
PaddleX 提供了 4 个端到端的OCR模型,具体可参考 模型列表,其中部分模型的 benchmark 如下:
| 模型列表 | 检测Hmean(%) | 识别 Avg Accuracy(%) | GPU 推理耗时(ms) | CPU 推理耗时(ms) | 模型存储大小(M) |
|---|---|---|---|---|---|
| PP-OCRv4_server | 82.69 | 79.20 | 22.20346 | 2662.158 | 198 |
| PP-OCRv4_mobile | 77.79 | 78.20 | 2.719474 | 79.1097 | 15 |
PP-OCRv4_server 模型为例,完成一次模型全流程开发。你可以依据自己的实际使用场景,判断并选择一个合适的模型做训练,训练完成后可在产线内评估合适的模型权重,并最终用于实际使用场景中。
本教程采用 手写体中文识别数据集 作为示例数据集,可通过以下命令获取示例数据集。如果您使用自备的已标注数据集,需要按照 PaddleX 的格式要求对自备数据集进行调整,以满足 PaddleX 的数据格式要求。关于数据格式介绍,您可以参考 PaddleX 文本检测/文本识别任务模块数据标注教程。
数据集获取命令:
cd /path/to/paddlex
wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/handwrite_chinese_text_rec.tar -P ./dataset
tar -xf ./dataset/handwrite_chinese_text_rec.tar -C ./dataset/
在对数据集校验时,只需一行命令:
python main.py -c paddlex/configs/modules/text_recognition/PP-OCRv4_server_rec.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/handwrite_chinese_text_rec
执行上述命令后,PaddleX 会对数据集进行校验,并统计数据集的基本信息。命令运行成功后会在 log 中打印出 Check dataset passed ! 信息,同时相关产出会保存在当前目录的 ./output/check_dataset 目录下,产出目录中包括可视化的示例样本图片和样本分布直方图。校验结果文件保存在 ./output/check_dataset_result.json,校验结果文件具体内容为
{
"done_flag": true,
"check_pass": true,
"attributes": {
"train_samples": 23965,
"train_sample_paths": [
"..\/..\/handwrite_chinese_text_rec\/train_data\/64957.png",
"..\/..\/handwrite_chinese_text_rec\/train_data\/138926.png",
"..\/..\/handwrite_chinese_text_rec\/train_data\/86760.png",
"..\/..\/handwrite_chinese_text_rec\/train_data\/83191.png",
"..\/..\/handwrite_chinese_text_rec\/train_data\/79882.png",
"..\/..\/handwrite_chinese_text_rec\/train_data\/58639.png",
"..\/..\/handwrite_chinese_text_rec\/train_data\/1187-P16_1.jpg",
"..\/..\/handwrite_chinese_text_rec\/train_data\/8199.png",
"..\/..\/handwrite_chinese_text_rec\/train_data\/1225-P19_9.jpg",
"..\/..\/handwrite_chinese_text_rec\/train_data\/183335.png"
],
"val_samples": 17259,
"val_sample_paths": [
"..\/..\/handwrite_chinese_text_rec\/test_data\/11.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/12.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/13.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/14.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/15.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/16.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/17.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/18.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/19.png",
"..\/..\/handwrite_chinese_text_rec\/test_data\/20.png"
]
},
"analysis": {
"histogram": "check_dataset\/histogram.png"
},
"dataset_path": "handwrite_chinese_text_rec",
"show_type": "image",
"dataset_type": "MSTextRecDataset"
}
上述校验结果中,check_pass 为 True 表示数据集格式符合要求,其他部分指标的说明如下:
另外,数据集校验还对数据集中所有类别的样本数量分布情况进行了分析,并绘制了分布直方图(histogram.png):
注:只有通过数据校验的数据才可以训练和评估。
如需对数据集格式进行转换或是重新划分数据集,可通过修改配置文件或是追加超参数的方式进行设置。
数据集校验相关的参数可以通过修改配置文件中 CheckDataset 下的字段进行设置,配置文件中部分参数的示例说明如下:
CheckDataset:
split:
enable: 是否进行重新划分数据集,为 True 时进行数据集格式转换,默认为 False;train_percent: 如果重新划分数据集,则需要设置训练集的百分比,类型为 0-100 之间的任意整数,需要保证和 val_percent 值加和为 100;val_percent: 如果重新划分数据集,则需要设置验证集的百分比,类型为 0-100 之间的任意整数,需要保证和 train_percent 值加和为 100;数据划分时,原有标注文件会被在原路径下重命名为 xxx.bak,以上参数同样支持通过追加命令行参数的方式进行设置,例如重新划分数据集并设置训练集与验证集比例:-o CheckDataset.split.enable=True -o CheckDataset.split.train_percent=80 -o CheckDataset.split.val_percent=20。
在训练之前,请确保您已经对数据集进行了校验。完成 PaddleX 模型的训练,只需如下一条命令:
python main.py -c paddlex/configs/modules/text_recognition/PP-OCRv4_server_rec.yaml \
-o Global.mode=train \
-o Global.dataset_dir=./dataset/handwrite_chinese_text_rec
在 PaddleX 中模型训练支持:修改训练超参数、单机单卡/多卡训练等功能,只需修改配置文件或追加命令行参数。
PaddleX 中每个模型都提供了模型开发的配置文件,用于设置相关参数。模型训练相关的参数可以通过修改配置文件中 Train 下的字段进行设置,配置文件中部分参数的示例说明如下:
Global:
mode:模式,支持数据校验(check_dataset)、模型训练(train)、模型评估(evaluate);device:训练设备,可选cpu、gpu、xpu、npu、mlu,除 cpu 外,多卡训练可指定卡号,如:gpu:0,1,2,3;Train:训练超参数设置;
epochs_iters:训练轮次数设置;learning_rate:训练学习率设置;更多超参数介绍,请参考 PaddleX 通用模型配置文件参数说明。
注:
-o Global.mode=train;指定前 2 卡 gpu 训练:-o Global.device=gpu:0,1;设置训练轮次数为 10:-o Train.epochs_iters=10。output,如需指定保存路径,可通过配置文件中 -o Global.output 字段训练产出解释:
在完成模型训练后,所有产出保存在指定的输出目录(默认为./output/)下,通常有以下产出:
在完成模型训练后,可以对指定的模型权重文件在验证集上进行评估,验证模型精度。使用 PaddleX 进行模型评估,只需一行命令:
python main.py -c paddlex/configs/modules/text_recognition/PP-OCRv4_server_rec.yaml \
-o Global.mode=evaluate \
-o Global.dataset_dir=./dataset/handwrite_chinese_text_rec
与模型训练类似,模型评估支持修改配置文件或追加命令行参数的方式设置。
注: 在模型评估时,需要指定模型权重文件路径,每个配置文件中都内置了默认的权重保存路径,如需要改变,只需要通过追加命令行参数的形式进行设置即可,如-o Evaluate.weight_path=./output/best_accuracy/best_accuracy.pdparams。
在学习了模型训练和评估后,我们可以通过调整超参数来提升模型的精度。通过合理调整训练轮数,您可以控制模型的训练深度,避免过拟合或欠拟合;而学习率的设置则关乎模型收敛的速度和稳定性。因此,在优化模型性能时,务必审慎考虑这两个参数的取值,并根据实际情况进行灵活调整,以获得最佳的训练效果。
推荐在调试参数时遵循控制变量法:
学习率探寻实验结果:
| 实验ID | 学习率 | 识别 Acc (%) |
|---|---|---|
| 1 | 0.001 | 43.28 |
| 2 | 0.005 | 32.63 |
| 3 | 0.0002 | 49.64 |
| 4 | 0.0001 | 46.32 |
接下来,我们可以在学习率设置为 0.0002 的基础上,增加训练轮次,对比下面实验 [4, 5, 6, 7] 可知,训练轮次增大,模型精度有了进一步的提升。
| 实验ID | 训练轮次 | 识别 Acc (%) |
|---|---|---|
| 4 | 20 | 49.64 |
| 5 | 30 | 52.03 |
| 6 | 50 | 54.15 |
| 7 | 80 | 54.35 |
注:本教程为 4 卡教程,如果您只有 1 张 GPU,可通过调整训练卡数完成本次实验,但最终指标未必和上述指标对齐,属正常情况。
将产线中的模型替换为微调后的模型进行测试,如:
python main.py -c paddlex/configs/modules/text_recognition/PP-OCRv4_server_rec.yaml \
-o Global.mode=predict \
-o Predict.model_dir="output/best_model/inference" \
-o Predict.input=https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/practical_tutorial/OCR_rec/case.png
通过上述可在./output下生成预测结果,其中case.jpg的预测结果如下:

如果通用 OCR 产线可以达到您对产线推理速度和精度的要求,您可以直接进行开发集成/部署。
若您需要使用微调后的模型权重,可以获取 OCR 产线配置文件,并加载配置文件进行预测。可执行如下命令将结果保存在 my_path 中:
paddlex --get_pipeline_config OCR --save_path ./my_path
将微调后模型权重的本地路径填写至产线配置文件中的 model_dir 即可, 若您需要将通用 OCR 产线直接应用在您的 Python 项目中,可以参考 如下示例:
pipeline_name: OCR
text_type: general
use_doc_preprocessor: True
use_textline_orientation: True
SubPipelines:
DocPreprocessor:
...
SubModules:
TextDetection:
...
TextLineOrientation:
...
TextRecognition:
module_name: text_recognition
model_name: PP-OCRv4_mobile_rec
model_dir: null # 此处替换为您训练后得到的模型权重本地路径
batch_size: 1
score_thresh: 0.0
随后,在您的 Python 代码中,您可以这样使用产线:
from paddlex import create_pipeline
pipeline = create_pipeline(pipeline="my_path/OCR.yaml")
output = pipeline.predict("https://paddle-model-ecology.bj.bcebos.com/paddlex/PaddleX3.0/doc_images/practical_tutorial/OCR_rec/case.png")
for res in output:
res.print() # 打印预测的结构化输出
res.save_to_img("./output/") # 保存结果可视化图像
res.save_to_json("./output/") # 保存预测的结构化输出
更多参数请参考 OCR 产线使用教程。
您可以根据需要选择合适的方式部署模型产线,进而进行后续的 AI 应用集成。