Paddle-Mobile¶

编译¶

Java 接口需要在 cmake 选项中同时打开 DWITH_LITE, DLITE_WITH_JAVA, DLITE_WITH_ARM。 例如：

# ARM_TARGET_OS in "android" , "armlinux"
# ARM_TARGET_ARCH_ABI in "armv8", "armv7" ,"armv7hf"
# ARM_TARGET_LANG in "gcc" "clang"
mkdir -p build.lite.android.arm8.gcc
cd build.lite.android.arm8.gcc

cmake .. \
  -DWITH_GPU=OFF \
  -DWITH_MKL=OFF \
  -DWITH_LITE=ON \
  -DLITE_WITH_JAVA=ON \
  -DLITE_WITH_CUDA=OFF \
  -DLITE_WITH_X86=OFF \
  -DLITE_WITH_ARM=ON \
  -DLITE_WITH_LIGHT_WEIGHT_FRAMEWORK=ON \
  -DWITH_TESTING=ON \
  -DARM_TARGET_OS=android -DARM_TARGET_ARCH_ABI=armv8 -DARM_TARGET_LANG=gcc

make -j4

make 成功后，Linux下会生成动态库文件 paddle/fluid/lite/api/android/jni/libpaddle_lite_jni.so（ Mac 下为 libpaddle_lite_jni.jnilib, Windows 下为libpaddle_lite_jni.dll ）该动态库即 Java JNI ( Java Native Interface ) 所需要的 C++ 接口动态链接库，下面例子中我们将使用 Linux 下 libpaddle_lite_jni.so 为例。同时，也会在同一个文件夹下生成 PaddlePredictor.jar

Android 程序构建¶

在我们的库中，Java 代码库被放在 paddle/fluid/lite/api/android/jni/src 中，具体有两个classes:

com.baidu.paddle.lite.PaddlePredictor com.baidu.paddle.lite.Place

你可以将其打包成 .jar 或者直接使用 Java 源代码接口。如果要使用 .jar，我们上节编译中生成的 .jar 也可以直接使用。

请将 JNI 动态链接库放在 Android Studio 代码 jniLibs 文件夹对应的体系结构文件夹下。例如要在 arm8 架构的手机，就 在 src/main/jniLibs/arm8 文件夹下放置 libpaddle_lite_jni.so，文件路径如果不存在请创建。

接下来，我们将具体介绍PaddlePredictor.java 和 Place.java

代码接口 Place¶

Paddle 预测中，为了便于管理不同的硬件及kernel 的其他实现细节，定义如下四个信息：

• Target: 具体的硬件空间，比如 ARM 表示 ARM CPU，OPEN_CL 表示 OpenCL
• DataLayout: Tensor 中的数据排布，目前有 NCHW
• Precison: kernel 的计算精度，或者 Tensor 的存储类型，目前有 FLOAT, INT8 等
• Device: 硬件的 device id，可以是 0 开始的整数

前三个为Java enum，最后一个为整型。相关定义如下

public enum TargetType {
  UNKNOWN(0), HOST(1), X86(2), CUDA(3), ARM(4), OPEN_CL(5), ANY(6);
}
public enum PrecisionType {
  UNKNOWN(0), FLOAT(1), INT8(2), INT32(3), ANY(4);
}
public enum DataLayoutType {
  UNKNOWN(0), NCHW(1), ANY(2);
}

而 Place 就是这四个信息的整合，其数据结构为

public class Place {
  public TargetType target;
  public PrecisionType precision;
  public DataLayoutType layout;
  public int device;
};

Place 用于标记Kernel 的主要计算模式，比如place.precision=INT8 的 kernel 表示为 Int8量化的 kernel。Place 暴露给用户，用户帮助指定模型硬件及量化等模式。

代码接口 PaddlePredictor¶

PaddlePredictor 提供的 methods 都是 native static methods。整体上运行的思路为 载入模型 -> 设置输入 -> 运行模型 -> 获取输出/存储运行后优化的模型 -> 清理掉载入的模型

我们将介绍各个步骤的主要功能，具体接口的参数和返回值请见Javadoc：

1. 载入模型：

   // 载入没有优化过的原始模型，用户可以设置期望的 Place 和可选的 Place 
   public static native boolean loadCxxModel(String modelPath, Place preferredPlace, Place[] validPlaces); 
   
   // 载入没有优化过的原始模型，用户可以设置期望的 Place 和可选的 Place 
   public static native boolean loadMobileModel(String modelPath);
   

2. 设置输入

   // 设置第 offest （从0开始）输入的维度和float数据
   public static native boolean setInput(int offset, int[] dims, float[] buf);
   
   // 设置第 offest （从0开始）输入的维度和byte数据 （在c++端为int8）
   public static native boolean setInput(int offset, int[] dims, byte[] buf);
   

3. 运行模型

   // 运行模型
   public static native boolean run();
   

4. 获取输出

   // 获取第 offset （从0开始）的 float 输出
   public static native float[] getFloatOutput(int offset);
   // 获取第 offset （从0开始）的 byte 输出
   public static native byte[] getByteOutput(int offset);
   // 指定名字获取 Var 的 float 输出
   public static native float[] fetchFloat(String name);
   // 指定名字获取 Var 的 byte 输出
   public static native byte[] fetchByte(String name);
   

5. 存储运行后优化的模型

   public static native boolean saveOptimizedModel(String modelPath);
   

6. 清理掉载入的模型

   public static native boolean clear();
   

使用示例如下：

String modelPath = "lite_naive_model"; // 用户定义的模型路径

// 用户自定义的输入，例子里是 100 * 100 的 float
float[] inputBuffer = new float[10000];
for (int i = 0; i < 10000; ++i) {
inputBuffer[i] = i;
}
int[] dims = {100, 100};

// Cxx Model 设定 Place
Place preferredPlace = new Place(Place.TargetType.X86, Place.PrecisionType.FLOAT);
Place[] validPlaces = new Place[2];
validPlaces[0] = preferredPlace;
validPlaces[1] = new Place(Place.TargetType.ARM, Place.PrecisionType.FLOAT);

// 载入模型
PaddlePredictor.loadCxxModel(modelPath, preferredPlace, validPlaces);
// 设置输入
PaddlePredictor.setInput(0, dims, inputBuffer);
// 运行Predictor
PaddlePredictor.run();
// 获取输出
float[] cxxOutput = PaddlePredictor.getFloatOutput(0);
// 保持优化后的模型在新路径
String optimizedModelPath = modelPath + ".opt";
PaddlePredictor.saveOptimizedModel(optimizedModelPath);
// 清除已载入的模型
PaddlePredictor.clear();

// Mobile Model 载入优化后的模型
PaddlePredictor.loadMobileModel(optimizedModelPath);
// 设置输入
PaddlePredictor.setInput(0, dims, inputBuffer);
// 运行
PaddlePredictor.run();
// 获取输出
float[] mobileOutput = PaddlePredictor.getFloatOutput(0);

Place¶

Place 在 C++ 中概念与 Java 相同，为了便于管理不同的硬件及kernel 的其他实现细节，定义如下四个信息：

• Target: 具体的硬件空间，比如 kARM 表示 ARM CPU，kOpenCL 表示 OpenCL
• DataLayout: Tensor 中的数据排布，目前有 kNCHW
• Precison: kernel 的计算精度，或者 Tensor 的存储类型，目前有 kFloat, kInt8 等
• Device: 硬件的 device id，可以是0开始的整数

前三个为结构体，最后一个为整型。相关定义如下

enum class TargetType : int {
  kUnk = 0,
  kHost,
  kX86,
  kCUDA,
  kARM,
  kOpenCL,
  kAny,  // any target
  NUM,   // number of fields.
};
enum class PrecisionType : int {
  kUnk = 0,
  kFloat,
  kInt8,
  kInt32,
  kAny,  // any precision
  NUM,   // number of fields.
};
enum class DataLayoutType : int {
  kUnk = 0,
  kNCHW,
  kAny,  // any data layout
  NUM,   // number of fields.
};

而 Place 就是这四个信息的整合，其数据结构为

struct Place {
  TargetType target{TARGET(kUnk)};
  PrecisionType precision{PRECISION(kUnk)};
  DataLayoutType layout{DATALAYOUT(kUnk)};
  int16_t device{0};  // device ID
};

Place 用于标记Kernel 的主要计算模式，比如place.precision=kInt8 的 kernel 表示为 Int8量化的 kernel。Place 暴露给用户层，用户帮助指定模型执行的硬件及量化等执行模式。

Config¶

预测接口使用的第一步是执行 CreatePaddlePredictor(config) 接口创建一个 predictor，具体的 config 目前有多个选择，对应着也会模板特化出不同的 predictor以适应不同的场景。

模板接口如下

template <typename ConfigT>
std::shared_ptr<PaddlePredictor> CreatePaddlePredictor(const ConfigT&);

接下来会详细介绍两种 Config: CxxConfig 和 MobileConfig.

编译¶

• 编译环境: 使用paddle/fluid/lite/tools/Dockerfile.mobile生成docker镜像。

• cmake编译选型介绍

  • ARM_TARGET_OS 代表目标操作系统， 目前仅支持 "android", 亦为默认值。
  • ARM_TARGET_ARCH_ABI 代表ARCH，支持输入"armv8"和"armv7"。其中，"armv8", 等效于 "arm64-v8a"，亦为默认值；"armv7", 等效于 "armeabi-v7a"。
  • ARM_TARGET_LANG 代表目标编译的语言， 默认为gcc，支持 gcc和clang两种。

• 参考示例

  # ARM_TARGET_OS in "android"
  # ARM_TARGET_ARCH_ABI in "armv8", "armv7" ,"armv7hf"
  # ARM_TARGET_LANG in "gcc" "clang"
  # 假设我们处于源码根目录下
  mkdir build_opencl && cd build_opencl
  cmake .. \
      -DLITE_WITH_OPENCL=ON \
      -DWITH_GPU=OFF \
      -DWITH_MKL=OFF \
      -DWITH_LITE=ON \
      -DLITE_WITH_CUDA=OFF \
      -DLITE_WITH_X86=OFF \
      -DLITE_WITH_ARM=ON \
      -DLITE_WITH_LIGHT_WEIGHT_FRAMEWORK=ON \
      -DWITH_TESTING=ON \
      -DARM_TARGET_OS="android" -DARM_TARGET_ARCH_ABI="armv8" -DARM_TARGET_LANG="gcc"
  # 完整编译
  make -j4
  # 或者我们也可以make某一target文件
  make test_mobilenetv1_lite -j4
  make test_cl_runtime -j4
  make test_elementwise_add_opencl -j4
  make test_pool_opencl -j4
  

运行¶

• 运行文件准备

使用如下命令将运行OpenCL程序时需要加载的文件push到手机端(假设我们处于源码根目录下)：

# 我们将文件统一push到/data/local/tmp/opencl目录下
adb shell mkdir -p /data/local/tmp/opencl
# 将OpenCL的kernels文件push到/data/local/tmp/opencl目录下
adb push paddle/fluid/lite/opencl/cl_kernel /data/local/tmp/opencl
# 将mobilenet_v1的模型文件push到/data/local/tmp/opencl目录下
adb push build_opencl/third_party/install/mobilenet_v1 /data/local/tmp/opencl
# 将OpenCL测试程序(如test_mobilenetv1_lite) push到/data/local/tmp/opencl目录下
adb push paddle/fluid/lite/api/test_mobilenetv1_lite /data/local/tmp/opencl

• 运行OpenCL程序

使用如下命令运行OpenCL程序。其中，--cl_path指定了OpenCL的kernels文件即cl_kernel所在目录， --modle_dir指定了模型文件所在目录。

adb shell
cd /data/local/tmp/opencl && ./test_mobilenetv1_lite --cl_path=. --model_dir=mobilenet_v1