LiteKitCore接入文档(for Java API).md

LiteKitCore接入文档 (for Java API)

一、编译

1. 构建环境

LiteKitCore Java API产物依赖及版本：

环境依赖	版本
ndk	android-ndk-r16b
c++	ANDROID_STL=c++_shared

2. 构建选项

cmake构建选项	选项
-DANDROID_TOOLCHAIN_NAME	llvm
-DANDROID_TOOLCHAIN	clang
-DANDROID_ARM_NEON	ON
-DANDROID_STL	c++_shared

3. 构建步骤

• 构建LiteKitCore C++, 编译生成liblitekit_framework.so
• 将liblitekit_framework.so放在
  • ./LiteKitCore/LiteKitCore/Android/litekitcore/src/main/cpp/libs/arm64-v8a/liblitekit_framework.so
  • ./LiteKitCore/LiteKitCore/Android/litekitcore/src/main/cpp/libs/armeabi-v7a/liblitekit_framework.so
• 打开工程目录./LiteKitCore/LiteKitCore/Android，执行AndroidStudio Gradle的按钮Android/litekitcore/Tasks/build/assemble编译
• 输出产物
  • ./LiteKitCore/LiteKitCore/Android/litekitcore/build/outputs/aar/litekitcore-debug.aar
  • ./LiteKitCore/LiteKitCore/Android/litekitcore/build/outputs/aar/litekitcore-release.aar

二、集成

1. 导入SDK

将LiteKit Java的可执行文件liblitekit_framework.so和litekitcore.aar放在工程目录app/libs/下

2. 添加第三方依赖

无

3. 添加系统framework

无

4. 配置环境

无

5. 资源文件

无

三、使用

LiteKit Java API执行推理的时候。
首先，需要确定模型、所使用的backend、模型和backend是否匹配、以及其他config参数，并创建config。
然后，通过config 对Service进行load，由Service创建的machine直接管理预测backend，用户仅需要持有/释放machine，不需要对backend的实例进行直接管理。
machine的预测接口input和output数据都是LiteKitData类型，LiteKitData是LiteKit Java API对数据格式的封装，提供设置input数据和读取output数据的能力。
machine使用完成后，需要手动执行释放操作，以释放machine持有的相关资源。

1) 引入头文件

// import LiteKit Java header
import com.baidu.litekitcore.LiteKitBaseMachine;
import com.baidu.litekitcore.LiteKitData;
import com.baidu.litekitcore.LiteKitMachineConfig;
import com.baidu.litekitcore.LiteKitMachineService;
import com.baidu.litekitcore.LiteKitPaddleConfig;
import com.baidu.litekitcore.LiteKitPaddleLiteConfig;

2) 创建Config （含模型转换）

// 创建LiteKitMachine
LiteKitMachineConfig machineConfig = new LiteKitMachineConfig();
LiteKitPaddleConfig paddleConfig = new LiteKitPaddleConfig();
paddleConfig.liteConfig = new LiteKitPaddleLiteConfig();
machineConfig.modelPath = modelPath();
machineConfig.machineType = LiteKitMachineConfig.MachineType.LiteKitPaddleLite;
machineConfig.engineConifg = paddleConfig;

3) 创建Machine

//创建machine
LiteKitBaseMachine machine = LiteKitMachineService.loadMachineWithConfig(machineConfig);

4) 前处理

// 进行需要的前处理
float *inputData;// example input数据

5) 创建Input

// create input data
ArrayList<LiteKitData> input = new ArrayList<>();
LiteKitData data = new LiteKitData(inputData, modelInputBatchSize, modelInputChannel, modelInputHeight, modelInputWidth, 0); // inputData为demo input data
input.add(data);

6) Machine执行predict

// 执行预测
ArrayList<LiteKitData> output = machine.predictWithInputData(input);

7) 读取output

// get output
float *result = output.get(0).output.fetchFloatData()// example output data
        

8) 后处理

//读取output数据后，进行需要的后处理
float *result 为读取到的output数据

9) 释放Machine

// 释放machine相关资源
machine.releaseMachine();

常见错误说明

-