建構適用於 Android 的 TensorFlow Lite

本文件說明如何自行建構 TensorFlow Lite Android 程式庫。一般來說，您不需要在本機建構 TensorFlow Lite Android 程式庫，

使用夜間快照

如要使用夜間快照，請將下列存放區新增至 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'
        }
    }
}

在 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。舉例來說，您可能建構的自訂二進位檔包含從 TensorFlow 選取的作業，或者希望在本機變更 TensorFlow Lite。

使用 Docker 設定建構環境

  • 下載 Docker 檔案。下載 Docker 檔案，即代表您同意以下服務條款規範您在這個版本中使用：

選擇接受即表示你同意所有使用 Android Studio 和 Android Native Development Kit 的行為均受《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}"

現在，您應前往「Configure WORKSPACE 和 .bazelrc」部分，調整建構設定。

程式庫建構完成後，您可以將其複製到容器中的 /host_dir，以便在主機上存取。

在不使用 Docker 的情況下設定建構環境

安裝 Bazel 和 Android 必備條件

Bazel 是 TensorFlow 的主要建構系統。如要使用此程式庫進行建構，您必須先安裝這項工具，並在系統上安裝 Android NDK 和 SDK。

  1. 安裝最新版本的 Bazel 建構系統。
  2. 需要 Android NDK 才能建構原生 (C/C++) TensorFlow Lite 程式碼。目前的建議版本為 25b，您可以前往這裡查看。
  3. Android SDK 和建構工具可在這裡取得，或透過 Android Studio 取得。建構工具 API >= 23 才建議使用建構 TensorFlow Lite 的版本。

設定 WORKSPACE 和 .bazelrc

只需完成這個一次性的設定步驟，即可建構 TF Lite 程式庫。在 TensorFlow 根檢查目錄中執行 ./configure 指令碼，然後在指令碼要求為 Android 建構作業設定 ./WORKSPACE 時回答「是」。這個指令碼會嘗試使用下列環境變數進行設定：

  • 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-lite-select-tf-ops.aar 檔案 (如有其中一個模型使用 TensorFlow 運算)。詳情請參閱「縮減 TensorFlow Lite 二進位檔大小」一節。

直接將「自動套用最佳化建議」功能新增至專案

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

在本機 Maven 存放區中安裝 AAR

從根結帳目錄執行下列指令：

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。