PaddleX/docs/deploy/paddlelite/android.md

Android平台

PaddleX的安卓端部署由PaddleLite实现，部署的流程如下，首先将训练好的模型导出为inference model，然后对模型进行优化，最后使用PaddleLite的预测库进行部署，PaddleLite的详细介绍和使用可参考：PaddleLite文档

PaddleX --> Inference Model --> PaddleLite Opt --> PaddleLite Inference

文章简介：

• step1: 介绍如何将PaddleX导出为inference model
• step2: 使用PaddleLite的OPT模块对模型进行优化
• step3: 介绍了基于MobileNetv2的安卓demo，以及PaddleX Android SDK

step 1. 将PaddleX模型导出为inference模型

参考导出inference模型将模型导出为inference格式模型。

step 2. 将inference模型优化为PaddleLite模型

目前提供了两种方法将Paddle模型优化为PaddleLite模型:

• 1.python脚本优化模型，简单上手，目前支持最新的PaddleLite 2.6.1版本
• 2.bin文件优化模型(linux)，支持develop版本(Commit Id:11cbd50e)，适用于部署DeepLab模型的用户。

2.1 使用python脚本优化模型

pip install paddlelite
python export_lite.py --model_dir /path/to/inference_model --save_file /path/to/lite_model_name --place place/to/run

其中export_lite.py脚本请至github下载：https://github.com/PaddlePaddle/PaddleX/blob/develop/deploy/lite/export_lite.py

参数	说明
--model_dir	预测模型所在路径，包含"__model__", "__params__", "model.yml"文件
--save_file	模型输出的名称，假设为/path/to/lite_model_name, 则输出为路径为/path/to/lite_model_name.nb
--place	运行的平台，可选：arm|opencl|x86|npu|xpu|rknpu|apu，安卓部署请选择arm

2.3 使用bin文件优化模型(linux)

首先下载并解压: 模型优化工具opt

./opt --model_file=<model_path> \
      --param_file=<param_path> \
      --valid_targets=arm \
      --optimize_out_type=naive_buffer \
      --optimize_out=model_output_name

详细的使用方法和参数含义请参考: 使用opt转化模型

step 3. 移动端（Android）预测

3.1 要求

• Android Studio 3.4
• Android手机或开发板

3.2 分类Demo

3.2.1 导入工程

• 打开Android Studio，在"Welcome to Android Studio"窗口点击"Open an existing Android Studio project"，在弹出的路径选择窗口中进入/PaddleX/deploy/lite/android/demo目录，然后点击右下角的"Open"按钮，导入工程；
• 通过USB连接Android手机或开发板；
• 载入工程后，点击菜单栏的Run->Run 'App'按钮，在弹出的"Select Deployment Target"窗口选择已经连接的Android设备，然后点击"OK"按钮；

3.2.2 自定义模型

首先根据step1~step2描述，准备好Lite模型(.nb文件)和yml配置文件(注意：导出Lite模型时需指定--place=arm)，然后在Android Studio的project视图中：

• 将paddlex.nb文件拷贝到/src/main/assets/model/目录下。
• 将model.yml文件拷贝到/src/main/assets/config/目录下。
• 根据需要，修改文件/src/main/res/values/strings.xml中的MODEL_PATH_DEFAULT和YAML_PATH_DEFAULT指定的路径。

3.3 PaddleX Android SDK介绍

PaddleX Android SDK是PaddleX基于Paddle-Lite开发的安卓端AI推理工具，以PaddleX导出的Yaml配置文件为接口，针对不同的模型实现图片的预处理，后处理，并进行可视化，开发者可集成到业务中。 该SDK自底向上主要包括：Paddle-Lite推理引擎层，Paddle-Lite接口层以及PaddleX业务层。

• Paddle-Lite推理引擎层，是在Android上编译好的二进制包，只涉及到Kernel 的执行，且可以单独部署，以支持极致的轻量级部署。
• Paddle-Lite接口层，以Java接口封装了底层c++推理库。
• PaddleX业务层，封装了PaddleX导出模型的预处理，推理和后处理，以及可视化，支持PaddleX导出的检测、分割、分类模型。

3.3.1 SDK安装

首先下载并解压PaddleX Android SDK，得到paddlex.aar文件，将拷贝到android工程目录app/libs/下面，然后为app的build.gradle添加依赖：

dependencies {
    implementation fileTree(include: ['*.jar','*aar'], dir: 'libs')
}

3.3.2 SDK使用用例

import com.baidu.paddlex.Predictor;
import com.baidu.paddlex.config.ConfigParser;
import com.baidu.paddlex.postprocess.DetResult;
import com.baidu.paddlex.postprocess.SegResult;
import com.baidu.paddlex.postprocess.ClsResult;
import com.baidu.paddlex.visual.Visualize;

// Predictor
Predictor predictor = new Predictor();
// model config
ConfigParser configParser = new ConfigParser();
// Visualize
Visualize visualize = new Visualize();
// image to predict
Mat predictMat;

// initialize
configParser.init(context, model_path, yaml_path, cpu_thread_num, cpu_power_mode);
visualize.init(configParser.getNumClasses());
predictor.init(context, configParser)

// run model
if (predictImage != null && predictor.isLoaded()) {
    predictor.setInputMat(predictMat);
    runModel();
}

// get result & visualize
if (configParser.getModelType().equalsIgnoreCase("segmenter")) {
    SegResult segResult = predictor.getSegResult();
    Mat visualizeMat  = visualize.draw(segResult, predictMat, predictor.getImageBlob());
} else if (configParser.getModelType().equalsIgnoreCase("detector")) {
    DetResult detResult = predictor.getDetResult();
    Mat visualizeMat = visualize.draw(detResult, predictMat);
} else if (configParser.getModelType().equalsIgnoreCase("classifier")) {
    ClsResult clsResult = predictor.getClsResult();
}

3.3.3 Result成员变量

注意：Result所有的成员变量以java bean的方式获取。

com.baidu.paddlex.postprocess.ClsResult

Fields

• type (String|static): 值为"cls"。
• categoryId (int): 类别ID。
• category (String): 类别名称。
• score (float): 预测置信度。

com.baidu.paddlex.postprocess.DetResult

Nested classes

• DetResult.Box 模型预测的box结果。

Fields

• type (String|static): 值为"det"。
• boxes (List): 模型预测的box结果。

com.baidu.paddlex.postprocess.DetResult.Box

Fields

• categoryId (int): 类别ID。
• category (String): 类别名称。
• score (float): 预测置信度。
• coordinate (float[4]): 预测框值:{xmin, ymin, xmax, ymax}。

com.baidu.paddlex.postprocess.SegResult

Nested classes

• SegResult.Mask: 模型预测的mask结果。

Fields

• type (String|static): 值为"Seg"。
• mask (SegResult.Mask): 模型预测的mask结果。

com.baidu.paddlex.postprocess.SegResult.Mask

Fields

• scoreData (float[]): 模型预测在各个类别的置信度，长度为numClass$\times\$H$\times\$W
• scoreShape (long[4]): scoreData的shape信息，[1,numClass,H,W]
• labelData (long[]): 模型预测置信度最高的label，长度为`H$\times\$W$\times\$1
• labelShape (long[4]): labelData的shape信息，[1,H,W,1]

3.3.4 SDK二次开发

• 打开Android Studio新建项目(或加载已有项目)。点击菜单File->New->Import Module，导入工程/PaddleX/deploy/lite/android/sdk, Project视图会新增名为sdk的module

• 在app的build.grade里面添加依赖:

  dependencies {
    implementation project(':sdk')
  }
  

• 源代码位于sdk/main/java/下，修改源码进行二次开发后，点击菜单栏的Build->Run 'sdk'按钮可编译生成aar，文件位于sdk/build/outputs/aar/路径下。