本文档介绍了如何自行构建 TensorFlow Lite Android 库。通常,您无需在本地构建 TensorFlow Lite Android 库。
使用夜间快照
如需使用夜间快照,请将以下代码库添加到根 Gradle build 配置中。
allprojects {
repositories { // should be already there
mavenCentral() // should be already there
maven { // add this repo to use snapshots
name 'ossrh-snapshot'
url 'https://oss.sonatype.org/content/repositories/snapshots'
}
}
}
将夜间快照添加到 build.gradle 的依赖项中(或根据需要进行修改)
...
dependencies {
...
implementation 'org.tensorflow:tensorflow-lite:0.0.0-nightly-SNAPSHOT'
implementation 'org.tensorflow:tensorflow-lite-gpu:0.0.0-nightly-SNAPSHOT'
implementation 'org.tensorflow:tensorflow-lite-support:0.0.0-nightly-SNAPSHOT'
...
}
...
在本地构建 TensorFlow Lite
在某些情况下,您可能希望使用 TensorFlow Lite 的本地 build。例如,您可能要构建一个包含从 TensorFlow 中选择的操作的自定义二进制文件,或者可能想要对 TensorFlow Lite 进行本地更改。
使用 Docker 设置构建环境
- 下载 Docker 文件。下载 Docker 文件,即表示您同意以下服务条款约束您对该文件的使用:
点击接受,即表示您特此同意,对 Android Studio 和 Android 原生开发套件的所有使用行为均受 Android 软件开发套件许可协议(载列于 https://developer.android.com/studio/terms)的约束(Google 可能会不时更新或更改此网址)。
您必须确认服务条款才能下载文件。- 您可以选择更改 Android SDK 或 NDK 版本。将下载的 Docker 文件放在空文件夹中,并通过运行以下命令构建 Docker 映像:
docker build . -t tflite-builder -f tflite-android.Dockerfile
- 通过将当前文件夹装载到容器内的 /host_dir 中,以交互方式启动 Docker 容器(请注意,/tensorflow_src 是容器内的 TensorFlow 代码库):
docker run -it -v $PWD:/host_dir tflite-builder bash
如果您在 Windows 上使用 PowerShell,请将“$PWD”替换为“pwd”。
如果您想在主机上使用 TensorFlow 代码库,请改为装载该主机目录 (-v hostDir:/host_dir)。
- 进入容器后,您可以运行以下命令来下载其他 Android 工具和库(请注意,您可能需要接受许可):
sdkmanager \
"build-tools;${ANDROID_BUILD_TOOLS_VERSION}" \
"platform-tools" \
"platforms;android-${ANDROID_API_LEVEL}"
现在,您应前往配置工作区和 .bazelrc 部分,以配置构建设置。
构建完库后,您可以将其复制到容器内的 /host_dir,以便在主机上访问它们。
在不使用 Docker 的情况下设置构建环境
安装 Bazel 和 Android 前提条件
Bazel 是 TensorFlow 的主要构建系统。如需使用该库进行构建,您必须具备 Android NDK,并在系统中安装 Android NDK 和 SDK。
- 安装最新版本的 Bazel 构建系统。
- 构建原生 (C/C++) TensorFlow Lite 代码需要使用 Android NDK。当前推荐的版本是 25b,可以在此处找到。
- Android SDK 和构建工具可从此处获取,或作为 Android Studio 的一部分获取。Build Tools API >= 23 是推荐用于构建 TensorFlow Lite 的版本。
配置 WORKSPACE 和 .bazelrc
这是构建 TF Lite 库所需的一次性配置步骤。在 TensorFlow 根检出目录中运行 ./configure
脚本,并在该脚本要求以交互方式为 Android build 配置 ./WORKSPACE
时回答“Yes”。该脚本将尝试使用以下环境变量配置设置:
ANDROID_SDK_HOME
ANDROID_SDK_API_LEVEL
ANDROID_NDK_HOME
ANDROID_NDK_API_LEVEL
如果未设置这些变量,则必须在脚本提示中以交互方式提供它们。成功的配置后,应该会在根文件夹的 .tf_configure.bazelrc
文件中生成类似于以下内容的条目:
build --action_env ANDROID_NDK_HOME="/usr/local/android/android-ndk-r25b"
build --action_env ANDROID_NDK_API_LEVEL="21"
build --action_env ANDROID_BUILD_TOOLS_VERSION="30.0.3"
build --action_env ANDROID_SDK_API_LEVEL="30"
build --action_env ANDROID_SDK_HOME="/usr/local/android/android-sdk-linux"
构建并安装
正确配置 Bazel 后,您就可以从根目录结账目录构建 TensorFlow Lite AAR,如下所示:
bazel build -c opt --cxxopt=--std=c++17 --config=android_arm64 \
--fat_apk_cpu=x86,x86_64,arm64-v8a,armeabi-v7a \
--define=android_dexmerger_tool=d8_dexmerger \
--define=android_incremental_dexing_tool=d8_dexbuilder \
//tensorflow/lite/java:tensorflow-lite
这将在 bazel-bin/tensorflow/lite/java/
中生成一个 AAR 文件。请注意,这会构建具有几种不同架构的“胖”AAR;如果您不需要所有架构,请使用适合您部署环境的子集。
您可以仅针对一组模型构建较小的 AAR 文件,如下所示:
bash tensorflow/lite/tools/build_aar.sh \
--input_models=model1,model2 \
--target_archs=x86,x86_64,arm64-v8a,armeabi-v7a
上面的脚本将生成 tensorflow-lite.aar
文件,如果其中一个模型正在使用 TensorFlow 操作,则还可以生成 tensorflow-lite-select-tf-ops.aar
文件。如需了解详情,请参阅缩减 TensorFlow Lite 二进制文件大小部分。
将 AAR 直接添加到项目中
将 tensorflow-lite.aar
文件移动到项目中名为 libs
的目录中。修改应用的 build.gradle
文件以引用新目录,并将现有的 TensorFlow Lite 依赖项替换为新的本地库,例如:
allprojects {
repositories {
mavenCentral()
maven { // Only for snapshot artifacts
name 'ossrh-snapshot'
url 'https://oss.sonatype.org/content/repositories/snapshots'
}
flatDir {
dirs 'libs'
}
}
}
dependencies {
compile(name:'tensorflow-lite', ext:'aar')
}
将 AAR 安装到本地 Maven 制品库
从根结账目录执行以下命令:
mvn install:install-file \
-Dfile=bazel-bin/tensorflow/lite/java/tensorflow-lite.aar \
-DgroupId=org.tensorflow \
-DartifactId=tensorflow-lite -Dversion=0.1.100 -Dpackaging=aar
在应用的 build.gradle
中,确保您具有 mavenLocal()
依赖项,并将标准 TensorFlow Lite 依赖项替换为支持部分 TensorFlow 操作的依赖项:
allprojects {
repositories {
mavenCentral()
maven { // Only for snapshot artifacts
name 'ossrh-snapshot'
url 'https://oss.sonatype.org/content/repositories/snapshots'
}
mavenLocal()
}
}
dependencies {
implementation 'org.tensorflow:tensorflow-lite:0.1.100'
}
请注意,此处的 0.1.100
版本仅用于测试/开发目的。安装本地 AAR 后,您可以在应用代码中使用标准 TensorFlow Lite Java 推理 API。