readme_ch.md 16 KB
端侧部署
本教程将介绍基于Paddle Lite 在移动端部署PaddleOCR超轻量中文检测、识别模型的详细步骤。
Paddle Lite是飞桨轻量化推理引擎，为手机、IOT端提供高效推理能力，并广泛整合跨平台硬件，为端侧部署及应用落地问题提供轻量化的部署方案。
1. 准备环境
运行准备
- 电脑（编译Paddle Lite）
- 安卓手机（armv7或armv8）
1.1 准备交叉编译环境
交叉编译环境用于编译 Paddle Lite 和 PaddleOCR 的C++ demo。 支持多种开发环境，不同开发环境的编译流程请参考对应文档。
1.2 准备预测库
预测库有两种获取方式：
- [推荐]直接下载，预测库下载链接如下：
| 平台 | 预测库下载链接 | |---|---| |Android|arm7 / arm8| |IOS|arm7 / arm8|
注：1. 上述预测库为PaddleLite 2.10分支编译得到，有关PaddleLite 2.10 详细信息可参考 链接 。
注：建议使用paddlelite>=2.10版本的预测库，其他预测库版本下载链接
编译Paddle-Lite得到预测库，Paddle-Lite的编译方式如下：
git clone https://github.com/PaddlePaddle/Paddle-Lite.git cd Paddle-Lite # 切换到Paddle-Lite release/v2.10 稳定分支 git checkout release/v2.10 ./lite/tools/build_android.sh --arch=armv8 --with_cv=ON --with_extra=ON
注意：编译Paddle-Lite获得预测库时，需要打开--with_cv=ON --with_extra=ON两个选项，--arch表示arm版本，这里指定为armv8，
更多编译命令
介绍请参考 链接 。
直接下载预测库并解压后，可以得到inference_lite_lib.android.armv8/文件夹，通过编译Paddle-Lite得到的预测库位于
Paddle-Lite/build.lite.android.armv8.gcc/inference_lite_lib.android.armv8/文件夹下。
预测库的文件目录如下：
inference_lite_lib.android.armv8/
|-- cxx C++ 预测库和头文件
| |-- include C++ 头文件
| | |-- paddle_api.h
| | |-- paddle_image_preprocess.h
| | |-- paddle_lite_factory_helper.h
| | |-- paddle_place.h
| | |-- paddle_use_kernels.h
| | |-- paddle_use_ops.h
| | `-- paddle_use_passes.h
| `-- lib C++预测库
| |-- libpaddle_api_light_bundled.a C++静态库
| `-- libpaddle_light_api_shared.so C++动态库
|-- java Java预测库
| |-- jar
| | `-- PaddlePredictor.jar
| |-- so
| | `-- libpaddle_lite_jni.so
| `-- src
|-- demo C++和Java示例代码
| |-- cxx C++ 预测库demo
| `-- java Java 预测库demo
2 开始运行
2.1 模型优化
Paddle-Lite 提供了多种策略来自动优化原始的模型，其中包括量化、子图融合、混合调度、Kernel优选等方法，使用Paddle-lite的opt工具可以自动 对inference模型进行优化，优化后的模型更轻量，模型运行速度更快。
如果已经准备好了 .nb 结尾的模型文件，可以跳过此步骤。
下述表格中也提供了一系列中文移动端模型：
| 模型版本 | 模型简介 | 模型大小 | 检测模型 | 文本方向分类模型 | 识别模型 | Paddle-Lite版本 |
|---|---|---|---|---|---|---|
| PP-OCRv3 | 蒸馏版超轻量中文OCR移动端模型 | 16.2M | 下载地址 | 下载地址 | 下载地址 | v2.10 |
| PP-OCRv3(slim) | 蒸馏版超轻量中文OCR移动端模型 | 5.9M | 下载地址 | 下载地址 | 下载地址 | v2.10 |
| PP-OCRv2 | 蒸馏版超轻量中文OCR移动端模型 | 11M | 下载地址 | 下载地址 | 下载地址 | v2.10 |
| PP-OCRv2(slim) | 蒸馏版超轻量中文OCR移动端模型 | 4.6M | 下载地址 | 下载地址 | 下载地址 | v2.10 |
如果直接使用上述表格中的模型进行部署，可略过下述步骤，直接阅读 2.2节。
如果要部署的模型不在上述表格中，则需要按照如下步骤获得优化后的模型。
步骤1：参考文档安装paddlelite，用于转换paddle inference model为paddlelite运行所需的nb模型
pip install paddlelite==2.10 # paddlelite版本要与预测库版本一致安装完后，如下指令可以查看帮助信息
paddle_lite_opt
paddle_lite_opt 参数介绍： |选项|说明| |---|---| |--model_dir|待优化的PaddlePaddle模型（非combined形式）的路径| |--model_file|待优化的PaddlePaddle模型（combined形式）的网络结构文件路径| |--param_file|待优化的PaddlePaddle模型（combined形式）的权重文件路径| |--optimize_out_type|输出模型类型，目前支持两种类型：protobuf和naive_buffer，其中naive_buffer是一种更轻量级的序列化/反序列化实现。若您需要在mobile端执行模型预测，请将此选项设置为naive_buffer。默认为protobuf| |--optimize_out|优化模型的输出路径| |--valid_targets|指定模型可执行的backend，默认为arm。目前可支持x86、arm、opencl、npu、xpu，可以同时指定多个backend(以空格分隔)，Model Optimize Tool将会自动选择最佳方式。如果需要支持华为NPU（Kirin 810/990 Soc搭载的达芬奇架构NPU），应当设置为npu, arm| |--record_tailoring_info|当使用 根据模型裁剪库文件 功能时，则设置该选项为true，以记录优化后模型含有的kernel和OP信息，默认为false|
--model_dir适用于待优化的模型是非combined方式，PaddleOCR的inference模型是combined方式，即模型结构和模型参数使用单独一个文件存储。
- 步骤2：使用paddle_lite_opt将inference模型转换成移动端模型格式。
下面以PaddleOCR的超轻量中文模型为例，介绍使用编译好的opt文件完成inference模型到Paddle-Lite优化模型的转换。
# 【推荐】 下载 PP-OCRv3版本的中英文 inference模型
wget https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_det_slim_infer.tar && tar xf ch_PP-OCRv3_det_slim_infer.tar
wget https://paddleocr.bj.bcebos.com/PP-OCRv3/chinese/ch_PP-OCRv3_rec_slim_infer.tar && tar xf ch_PP-OCRv2_rec_slim_quant_infer.tar
wget https://paddleocr.bj.bcebos.com/dygraph_v2.0/slim/ch_ppocr_mobile_v2.0_cls_slim_infer.tar && tar xf ch_ppocr_mobile_v2.0_cls_slim_infer.tar
# 转换检测模型
paddle_lite_opt --model_file=./ch_PP-OCRv3_det_slim_infer/inference.pdmodel --param_file=./ch_PP-OCRv3_det_slim_infer/inference.pdiparams --optimize_out=./ch_PP-OCRv3_det_slim_opt --valid_targets=arm --optimize_out_type=naive_buffer
# 转换识别模型
paddle_lite_opt --model_file=./ch_PP-OCRv3_rec_slim_infer/inference.pdmodel --param_file=./ch_PP-OCRv3_rec_slim_infer/inference.pdiparams --optimize_out=./ch_PP-OCRv3_rec_slim_opt --valid_targets=arm --optimize_out_type=naive_buffer
# 转换方向分类器模型
paddle_lite_opt --model_file=./ch_ppocr_mobile_v2.0_cls_slim_infer/inference.pdmodel --param_file=./ch_ppocr_mobile_v2.0_cls_slim_infer/inference.pdiparams --optimize_out=./ch_ppocr_mobile_v2.0_cls_slim_opt --valid_targets=arm --optimize_out_type=naive_buffer
转换成功后，inference模型目录下会多出.nb结尾的文件，即是转换成功的模型文件。
注意：使用paddle-lite部署时，需要使用opt工具优化后的模型。 opt工具的输入模型是paddle保存的inference模型
2.2 与手机联调
首先需要进行一些准备工作。
- 准备一台arm8的安卓手机，如果编译的预测库和opt文件是armv7，则需要arm7的手机，并修改Makefile中
ARM_ABI = arm7。 - 打开手机的USB调试选项，选择文件传输模式，连接电脑。
电脑上安装adb工具，用于调试。 adb安装方式如下：
3.1. MAC电脑安装ADB:
brew cask install android-platform-tools3.2. Linux安装ADB
sudo apt update sudo apt install -y wget adb3.3. Window安装ADB
win上安装需要去谷歌的安卓平台下载adb软件包进行安装：链接
打开终端，手机连接电脑，在终端中输入
adb devices如果有device输出，则表示安装成功。
List of devices attached 744be294 device准备优化后的模型、预测库文件、测试图像和使用的字典文件。
git clone https://github.com/PaddlePaddle/PaddleOCR.git cd PaddleOCR/deploy/lite/ # 运行prepare.sh，准备预测库文件、测试图像和使用的字典文件，并放置在预测库中的demo/cxx/ocr文件夹下 sh prepare.sh /{lite prediction library path}/inference_lite_lib.android.armv8 # 进入OCR demo的工作目录 cd /{lite prediction library path}/inference_lite_lib.android.armv8/ cd demo/cxx/ocr/ # 将C++预测动态库so文件复制到debug文件夹中 cp ../../../cxx/lib/libpaddle_light_api_shared.so ./debug/
准备测试图像，以PaddleOCR/doc/imgs/11.jpg为例，将测试的图像复制到demo/cxx/ocr/debug/文件夹下。
准备lite opt工具优化后的模型文件，比如使用ch_PP-OCRv3_det_slim_opt.ch_PP-OCRv3_rec_slim_rec.nb, ch_ppocr_mobile_v2.0_cls_slim_opt.nb，模型文件放置在demo/cxx/ocr/debug/文件夹下。
执行完成后，ocr文件夹下将有如下文件格式：
demo/cxx/ocr/
|-- debug/
| |--ch_PP-OCRv3_det_slim_opt.nb 优化后的检测模型文件
| |--ch_PP-OCRv3_rec_slim_opt.nb 优化后的识别模型文件
| |--ch_ppocr_mobile_v2.0_cls_slim_opt.nb 优化后的文字方向分类器模型文件
| |--11.jpg 待测试图像
| |--ppocr_keys_v1.txt 中文字典文件
| |--libpaddle_light_api_shared.so C++预测库文件
| |--config.txt 超参数配置
|-- config.txt 超参数配置
|-- cls_process.cc 方向分类器的预处理和后处理文件
|-- cls_process.h
|-- crnn_process.cc 识别模型CRNN的预处理和后处理文件
|-- crnn_process.h
|-- db_post_process.cc 检测模型DB的后处理文件
|-- db_post_process.h
|-- Makefile 编译文件
|-- ocr_db_crnn.cc C++预测源文件
注意：
ppocr_keys_v1.txt是中文字典文件，如果使用的 nb 模型是英文数字或其他语言的模型，需要更换为对应语言的字典。 PaddleOCR 在ppocr/utils/下存放了多种字典，包括：
dict/french_dict.txt # 法语字典 dict/german_dict.txt # 德语字典 ic15_dict.txt # 英文字典 dict/japan_dict.txt # 日语字典 dict/korean_dict.txt # 韩语字典 ppocr_keys_v1.txt # 中文字典 ...config.txt包含了检测器、分类器、识别器的超参数，如下：max_side_len 960 # 输入图像长宽大于960时，等比例缩放图像，使得图像最长边为960 det_db_thresh 0.3 # 用于过滤DB预测的二值化图像，设置为0.-0.3对结果影响不明显 det_db_box_thresh 0.5 # 检测器后处理过滤box的阈值，如果检测存在漏框情况，可酌情减小 det_db_unclip_ratio 1.6 # 表示文本框的紧致程度，越小则文本框更靠近文本 use_direction_classify 0 # 是否使用方向分类器，0表示不使用，1表示使用 rec_image_height 48 # 识别模型输入图像的高度，PP-OCRv3模型设置为48，PP-OCRv2模型需要设置为32- 启动调试
上述步骤完成后就可以使用adb将文件push到手机上运行，步骤如下：
# 执行编译，得到可执行文件ocr_db_crnn, 第一次执行此命令会下载opencv等依赖库，下载完成后，需要再执行一次
make -j
# 将编译的可执行文件移动到debug文件夹中
mv ocr_db_crnn ./debug/
# 将debug文件夹push到手机上
adb push debug /data/local/tmp/
adb shell
cd /data/local/tmp/debug
export LD_LIBRARY_PATH=${PWD}:$LD_LIBRARY_PATH
# 开始使用，ocr_db_crnn可执行文件的使用方式为:
# ./ocr_db_crnn 预测模式 检测模型文件 方向分类器模型文件 识别模型文件 运行硬件 运行精度 线程数 batchsize 测试图像路径 参数配置路径 字典文件路径 是否使用benchmark参数
./ocr_db_crnn system ch_PP-OCRv3_det_slim_opt.nb ch_PP-OCRv3_rec_slim_opt.nb ch_ppocr_mobile_v2.0_cls_slim_opt.nb arm8 INT8 10 1 ./11.jpg config.txt ppocr_keys_v1.txt True
# 仅使用文本检测模型，使用方式如下：
./ocr_db_crnn det ch_PP-OCRv3_det_slim_opt.nb arm8 INT8 10 1 ./11.jpg config.txt
# 仅使用文本识别模型，使用方式如下：
./ocr_db_crnn rec ch_PP-OCRv3_rec_slim_opt.nb arm8 INT8 10 1 word_1.jpg ppocr_keys_v1.txt config.txt
如果对代码做了修改，则需要重新编译并push到手机上。
运行效果如下：
FAQ
Q1：如果想更换模型怎么办，需要重新按照流程走一遍吗？
A1：如果已经走通了上述步骤，更换模型只需要替换 .nb 模型文件即可，同时要注意更新字典
Q2：换一个图测试怎么做？
A2：替换debug下的.jpg测试图像为你想要测试的图像，adb push 到手机上即可
Q3：如何封装到手机APP中？
A3：此demo旨在提供能在手机上运行OCR的核心算法部分，PaddleOCR/deploy/android_demo是将这个demo封装到手机app的示例，供参考
Q4：运行demo时遇到报错Error: This model is not supported, because kernel for 'io_copy' is not supported by Paddle-Lite.
A4：问题是安装的paddlelite版本和下载的预测库版本不匹配，确保paddleliteopt工具和你的预测库版本匹配，重新转nb模型试试。