lite_build.md

为 Android 构建 TensorFlow Lite 库

本文介绍如何自行构建 TensorFlow Lite Android 库。通常，您不需要在本地构建 TensorFlow Lite Android 库。如果您只是希望使用此库，请参阅 Android 快速入门，了解有关如何在 Android 项目中使用的更多详细信息。

使用 Nightly 快照

要使用 Nightly 快照，请将以下仓库添加到您的根 Gradle 构建配置中。

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'
        }
    }
}

在本地构建 TensorFlow Lite 库

在某些情况下，您可能希望使用本地构建的 TensorFlow Lite。例如，您可能在构建包含 Select TensorFlow 算子的自定义二进制文件，或者您可能希望在本地对 TensorFlow Lite 进行更改。

使用 Docker 设置构建环境

• 下载 Docker 文件。下载 Docker 文件，即表示您同意以下监管您的使用行为的服务条款：

点击以接受，即表示您同意对 Android Studio 和 Android Native Development Kit 的所有使用行为将受到 Android Software Development Kit 许可协议的约束。该许可协议位于以下网址：https://developer.android.com/studio/terms（Google 可能随时更新或更改此网址）。

{% dynamic if 'tflite-android-tos' in user.acknowledged_walls and request.tld != 'cn' %} 您可以在此处下载 Docker 文件 {% dynamic else %} 您必须确认服务条款才能下载此文件。确认 {% dynamic endif %}

• 您可以选择更改 Android SDK 或 NDK 版本。将下载的 Docker 文件放在一个空文件夹中，然后运行以下代码即可构建 Docker 镜像：

docker build . -t tflite-builder -f tflite-android.Dockerfile

• 通过将当前文件夹挂载到容器内的 /tmp，以交互方式启动 Docker 容器（请注意，/tensorflow_src 是容器内部的 TensorFlow 仓库）：

docker run -it -v $PWD:/host_dir tflite-builder bash

如果是在 Windows 上使用 PowerShell，请将“$PWD”替换为“pwd”。

如果您希望在主机上使用 TensorFlow 仓库，请挂载该主机目录 (-v hostDir:/tmp)。

• 进入容器后，您可以运行以下代码，下载其他 Android 工具和库（请注意，您可能需要接受许可协议）：

sdkmanager \
  "build-tools;${ANDROID_BUILD_TOOLS_VERSION}" \
  "platform-tools" \
  "platforms;android-${ANDROID_API_LEVEL}"

现在，您应该进入配置 WORKSPACE 和 .bazelrc 部分来配置构建设置。

构建完库之后，可以将它们复制到容器内的 /host_dir，以便可以在主机上访问它们。

不使用 Docker 设置构建环境

安装 Bazel 和 Android 前提条件

Bazel 是适用于 TensorFlow 的主要构建系统。要使用 Bazel 构建，您必须在系统上安装此工具以及 Android NDK 与 SDK。

1. 安装最新版本的 Bazel 构建系统。

2. 需要 Android NDK 才能构建原生 (C/C++) TensorFlow Lite 代码。最新的推荐版本是 21e，在此处可以找到该版本。

3. 在此处可以获取 Android SDK 和构建工具，或者，您也可以通过 Android Studio 获取。对于 TensorFlow Lite 模型构建，推荐的构建工具 API 版本是 23 或更高版本。

配置工作区和 .bazelrc

这是构建 TF Lite 库所需的一次性配置步骤。在 TensorFlow 根签出目录中运行 ./configure 脚本，当脚本询问是否以交互方式为 Android 构建配置 ./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-r21e"
build --action_env ANDROID_NDK_API_LEVEL="26"
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 --fat_apk_cpu=x86,x86_64,arm64-v8a,armeabi-v7a \
  --host_crosstool_top=@bazel_tools//tools/cpp:toolchain \
  --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 依赖项替换为支持 Select 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。