Skip to content

Latest commit

 

History

History
320 lines (247 loc) · 14.1 KB

README.md

File metadata and controls

320 lines (247 loc) · 14.1 KB

PP-ShiTu在Paddle-Lite端侧部署

本教程将介绍基于Paddle Lite 在移动端部署PaddleClas PP-ShiTu模型的详细步骤。

Paddle Lite是飞桨轻量化推理引擎,为手机、IoT端提供高效推理能力,并广泛整合跨平台硬件,为端侧部署及应用落地问题提供轻量化的部署方案。

1. 准备环境

运行准备

  • 电脑(编译Paddle Lite)
  • 安卓手机(armv7或armv8)

1.1 准备交叉编译环境

交叉编译环境用于编译 Paddle Lite 和 PaddleClas 的PP-ShiTu Lite demo。 支持多种开发环境,不同开发环境的编译流程请参考对应文档,请确保安装完成Java jdk、Android NDK(R17以上)。

  1. Docker
  2. Linux
  3. MAC OS
# 配置完成交叉编译环境后,更新环境变量
# for docker、Linux
source ~/.bashrc
# for Mac OS
source ~/.bash_profile

1.2 准备预测库

预测库有两种获取方式:

  1. [建议]直接下载,预测库下载链接如下:
    平台 架构 预测库下载链接
    Android arm7 inference_lite_lib
    Android arm8 inference_lite_lib
    Android arm8(FP16) inference_lite_lib

注意:1. 如果是从 Paddle-Lite 官方文档下载的预测库,注意选择with_extra=ON,with_cv=ON的下载链接。2. 目前只提供Android端demo,IOS端demo可以参考Paddle-Lite IOS demo

  1. 编译Paddle-Lite得到预测库,Paddle-Lite的编译方式如下:
git clone https://github.com/PaddlePaddle/Paddle-Lite.git
cd Paddle-Lite
# 如果使用编译方式,建议使用develop分支编译预测库
git checkout develop
# FP32
./lite/tools/build_android.sh --arch=armv8 --toolchain=clang --with_cv=ON --with_extra=ON
# FP16
./lite/tools/build_android.sh --arch=armv8 --toolchain=clang --with_cv=ON --with_extra=ON --with_arm82_fp16=ON

注意:编译Paddle-Lite获得预测库时,需要打开--with_cv=ON --with_extra=ON两个选项,--arch表示arm版本,这里指定为armv8,更多编译命令介绍请参考链接

直接下载预测库并解压后,可以得到inference_lite_lib.android.armv8.clang.c++_static.with_extra.with_cv/文件夹,通过编译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 模型准备

PaddleClas 提供了转换并优化后的推理模型,可以直接参考下方 2.1.1 小节进行下载。如果需要使用其他模型,请参考后续 2.1.2 小节自行转换并优化模型。

2.1.1 使用PaddleClas提供的推理模型

# 进入lite_ppshitu目录
cd $PaddleClas/deploy/lite_shitu
wget https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/lite/ppshitu_lite_models_v1.1.tar
tar -xf ppshitu_lite_models_v1.1.tar
rm -f ppshitu_lite_models_v1.1.tar

2.1.2 使用其他模型

Paddle-Lite 提供了多种策略来自动优化原始的模型,其中包括量化、子图融合、混合调度、Kernel优选等方法,使用Paddle-Lite的opt工具可以自动对inference模型进行优化,目前支持两种优化方式,优化后的模型更轻量,模型运行速度更快。

注意:如果已经准备好了 .nb 结尾的模型文件,可以跳过此步骤。

2.1.2.1 安装paddle_lite_opt工具

安装paddle_lite_opt工具有如下两种方法:

  1. [建议]pip安装paddlelite并进行转换

    pip install paddlelite==2.10rc
  2. 源码编译Paddle-Lite生成paddle_lite_opt工具

    模型优化需要Paddle-Lite的opt可执行文件,可以通过编译Paddle-Lite源码获得,编译步骤如下:

    # 如果准备环境时已经clone了Paddle-Lite,则不用重新clone Paddle-Lite
    git clone https://github.com/PaddlePaddle/Paddle-Lite.git
    cd Paddle-Lite
    git checkout develop
    # 启动编译
    ./lite/tools/build.sh build_optimize_tool

    编译完成后,opt文件位于build.opt/lite/api/下,可通过如下方式查看opt的运行选项和使用方式;

    cd build.opt/lite/api/
    ./opt

    opt的使用方式与参数与上面的paddle_lite_opt完全一致。

之后使用paddle_lite_opt工具可以进行inference模型的转换。paddle_lite_opt的部分参数如下:

选项 说明
--model_file 待优化的PaddlePaddle模型(combined形式)的网络结构文件路径
--param_file 待优化的PaddlePaddle模型(combined形式)的权重文件路径
--optimize_out_type 输出模型类型,目前支持两种类型:protobuf和naive_buffer,其中naive_buffer是一种更轻量级的序列化/反序列化实现,默认为naive_buffer
--optimize_out 优化模型的输出路径
--valid_targets 指定模型可执行的backend,默认为arm。目前可支持x86、arm、opencl、npu、xpu,可以同时指定多个backend(以空格分隔),Model Optimize Tool将会自动选择最佳方式。如果需要支持华为NPU(Kirin 810/990 Soc搭载的达芬奇架构NPU),应当设置为npu, arm

更详细的paddle_lite_opt工具使用说明请参考使用opt转化模型文档

--model_file表示inference模型的model文件地址,--param_file表示inference模型的param文件地址;optimize_out用于指定输出文件的名称(不需要添加.nb的后缀)。直接在命令行中运行paddle_lite_opt,也可以查看所有参数及其说明。

2.1.2.2 转换示例

下面介绍使用paddle_lite_opt完成主体检测模型和识别模型的预训练模型,转成inference模型,最终转换成Paddle-Lite的优化模型的过程。

  1. 转换主体检测模型
# 当前目录为 $PaddleClas/deploy/lite_shitu
# $code_path需替换成相应的运行目录,可以根据需要,将$code_path设置成需要的目录
export $code_path=~
cd $code_path
git clone https://github.com/PaddlePaddle/PaddleDetection.git
# 进入PaddleDetection根目录
cd PaddleDetection
# 将预训练模型导出为inference模型
python tools/export_model.py -c configs/picodet/application/mainbody_detection/picodet_lcnet_x2_5_640_mainbody.yml -o weights=https://paddledet.bj.bcebos.com/models/picodet_lcnet_x2_5_640_mainbody.pdparams  --output_dir=inference
# 将inference模型转化为Paddle-Lite优化模型
paddle_lite_opt --model_file=inference/picodet_lcnet_x2_5_640_mainbody/model.pdmodel --param_file=inference/picodet_lcnet_x2_5_640_mainbody/model.pdiparams --optimize_out=inference/picodet_lcnet_x2_5_640_mainbody/mainbody_det
# 将转好的模型复制到lite_shitu目录下
cd $PaddleClas/deploy/lite_shitu
mkdir models
cp $code_path/PaddleDetection/inference/picodet_lcnet_x2_5_640_mainbody/mainbody_det.nb $PaddleClas/deploy/lite_shitu/models
  1. 转换识别模型
# 转换为Paddle-Lite模型
paddle_lite_opt --model_file=inference/inference.pdmodel --param_file=inference/inference.pdiparams --optimize_out=inference/rec
# 将模型文件拷贝到lite_shitu下
cp inference/rec.nb deploy/lite_shitu/models/
cd deploy/lite_shitu

注意--optimize_out 参数为优化后模型的保存路径,无需加后缀.nb--model_file 参数为模型结构信息文件的路径,--param_file 参数为模型权重信息文件的路径,请注意文件名。

2.2 将yaml文件转换成json文件

# 如果测试单张图像
python generate_json_config.py --det_model_path ppshitu_lite_models_v1.1/mainbody_PPLCNet_x2_5_640_quant_v1.1_lite.nb  --rec_model_path ppshitu_lite_models_v1.1/general_PPLCNet_x2_5_lite_v1.1_infer.nb --img_path images/demo.jpg
# or
# 如果测试多张图像
python generate_json_config.py --det_model_path ppshitu_lite_models_v1.1/mainbody_PPLCNet_x2_5_640_quant_v1.1_lite.nb  --rec_model_path ppshitu_lite_models_v1.1/general_PPLCNet_x2_5_lite_v1.1_infer.nb --img_dir images
# 执行完成后,会在lit_shitu下生成shitu_config.json配置文件

2.3 index字典转换

由于python的检索库字典,使用pickle进行的序列化存储,导致C++不方便读取,因此需要进行转换

# 下载瓶装饮料数据集
wget https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/rec/data/drink_dataset_v1.0.tar && tar -xf drink_dataset_v1.0.tar
rm -rf drink_dataset_v1.0.tar

# 转化id_map.pkl为id_map.txt
python transform_id_map.py -c ../configs/inference_drink.yaml

转换成功后,会在IndexProcess.index_dir目录下生成id_map.txt

2.4 与手机联调

首先需要进行一些准备工作。

  1. 准备一台arm8的安卓手机,如果编译的预测库是armv7,则需要arm7的手机,并修改Makefile中ARM_ABI=arm7

  2. 电脑上安装ADB工具,用于调试。 ADB安装方式如下:

    2.1. MAC电脑安装ADB:

    brew cask install android-platform-tools

    2.2. Linux安装ADB

    sudo apt update
    sudo apt install -y wget adb

    2.3. Window安装ADB

    win上安装需要去谷歌的安卓平台下载ADB软件包进行安装:链接

  3. 手机连接电脑后,开启手机USB调试选项,选择文件传输模式,在电脑终端中输入:

adb devices

如果有device输出,则表示安装成功,如下所示:

List of devices attached
744be294    device
  1. 编译lite部署代码生成移动端可执行文件
cd $PaddleClas/deploy/lite_shitu
# ${lite prediction library path}下载的Paddle-Lite库路径
inference_lite_path=${lite prediction library path}/inference_lite_lib.android.armv8.gcc.c++_static.with_extra.with_cv/
mkdir $inference_lite_path/demo/cxx/ppshitu_lite

cp -r * $inference_lite_path/demo/cxx/ppshitu_lite
cd $inference_lite_path/demo/cxx/ppshitu_lite

# 执行编译,等待完成后得到可执行文件main
make ARM_ABI=arm8
#如果是arm7,则执行 make ARM_ABI = arm7 (或者在Makefile中修改该项)
  1. 准备优化后的模型、预测库文件、测试图像。
mkdir deploy
mv ppshitu_lite_models_v1.1 deploy/
mv drink_dataset_v1.0 deploy/
mv images deploy/
mv shitu_config.json deploy/
cp pp_shitu deploy/

# 将C++预测动态库so文件复制到deploy文件夹中
cp ../../../cxx/lib/libpaddle_light_api_shared.so deploy/

执行完成后,deploy文件夹下将有如下文件格式:

deploy/
|-- ppshitu_lite_models_v1.1/
|   |--mainbody_PPLCNet_x2_5_640_quant_v1.1_lite.nb    优化后的主体检测模型文件
|   |--general_PPLCNet_x2_5_lite_v1.1_infer.nb         优化后的识别模型文件
|-- images/
|   |--demo.jpg                                      图片文件
|-- drink_dataset_v1.0/                              瓶装饮料demo数据
|   |--index                                         检索index目录
|-- pp_shitu                                         生成的移动端执行文件
|-- shitu_config.json                                执行时参数配置文件
|-- libpaddle_light_api_shared.so                    Paddle-Lite库文件

注意:

  • shitu_config.json 包含了目标检测的超参数,请按需进行修改
  1. 启动调试,上述步骤完成后就可以使用ADB将文件夹 deploy/ push到手机上运行,步骤如下:
# 将上述deploy文件夹push到手机上
adb push deploy /data/local/tmp/

adb shell
cd /data/local/tmp/deploy
export LD_LIBRARY_PATH=/data/local/tmp/deploy:$LD_LIBRARY_PATH

# 修改权限为可执行
chmod 777 pp_shitu
# 执行程序
./pp_shitu shitu_config.json

如果对代码做了修改,则需要重新编译并push到手机上。

运行效果如下:

images/demo.jpg:
        result0: bbox[253, 275, 1146, 872], score: 0.974196, label: 伊藤园_果蔬汁

FAQ

Q1:如果想更换模型怎么办,需要重新按照流程走一遍吗? A1:如果已经走通了上述步骤,更换模型只需要替换 .nb 模型文件即可,同时要注意修改下配置文件中的 .nb 文件路径以及类别映射文件(如有必要)。

Q2:换一个图测试怎么做? A2:替换 deploy 下的测试图像为你想要测试的图像,并重新生成json配置文件(或者直接修改图像路径),使用 ADB 再次 push 到手机上即可。