LiteRT di API Java (dan Kotlin) layanan Google Play

LiteRT di layanan Google Play juga dapat diakses menggunakan Java API, yang dapat digunakan dari kode Java atau Kotlin, selain Native API. Secara khusus, LiteRT di layanan Google Play tersedia melalui LiteRT Interpreter API.

Menggunakan Interpreter API

LiteRT Interpreter API, yang disediakan oleh runtime TensorFlow, menyediakan antarmuka tujuan umum untuk mem-build dan menjalankan model ML. Gunakan langkah-langkah berikut untuk menjalankan inferensi dengan Interpreter API menggunakan TensorFlow Lite di runtime layanan Google Play.

1. Menambahkan dependensi project

Tambahkan dependensi berikut ke kode project aplikasi Anda untuk mengakses Play Services API untuk LiteRT:

dependencies {
...
    // LiteRT dependencies for Google Play services
    implementation 'com.google.android.gms:play-services-tflite-java:16.1.0'
    // Optional: include LiteRT Support Library
    implementation 'com.google.android.gms:play-services-tflite-support:16.1.0'
...
}

2. Menambahkan inisialisasi LiteRT

Lakukan inisialisasi komponen LiteRT API layanan Google Play sebelum menggunakan LiteRT API:

val initializeTask: Task<Void> by lazy { TfLite.initialize(this) }

Task<Void> initializeTask = TfLite.initialize(context);

3. Membuat Penafsir dan menetapkan opsi runtime

Buat penafsir menggunakan InterpreterApi.create() dan konfigurasikan untuk menggunakan runtime layanan Google Play, dengan memanggil InterpreterApi.Options.setRuntime(), seperti yang ditunjukkan dalam contoh kode berikut:

import org.tensorflow.lite.InterpreterApi
import org.tensorflow.lite.InterpreterApi.Options.TfLiteRuntime
...
private lateinit var interpreter: InterpreterApi
...
initializeTask.addOnSuccessListener {
  val interpreterOption =
    InterpreterApi.Options().setRuntime(TfLiteRuntime.FROM_SYSTEM_ONLY)
  interpreter = InterpreterApi.create(
    modelBuffer,
    interpreterOption
  )}
  .addOnFailureListener { e ->
    Log.e("Interpreter", "Cannot initialize interpreter", e)
  }

import org.tensorflow.lite.InterpreterApi
import org.tensorflow.lite.InterpreterApi.Options.TfLiteRuntime
...
private InterpreterApi interpreter;
...
initializeTask.addOnSuccessListener(a -> {
    interpreter = InterpreterApi.create(modelBuffer,
      new InterpreterApi.Options().setRuntime(TfLiteRuntime.FROM_SYSTEM_ONLY));
  })
  .addOnFailureListener(e -> {
    Log.e("Interpreter", String.format("Cannot initialize interpreter: %s",
          e.getMessage()));
  });

Anda harus menggunakan implementasi di atas karena menghindari pemblokiran thread antarmuka pengguna Android. Jika perlu mengelola eksekusi thread secara lebih cermat, Anda dapat menambahkan panggilan Tasks.await() untuk pembuatan penafsir:

import androidx.lifecycle.lifecycleScope
...
lifecycleScope.launchWhenStarted { // uses coroutine
  initializeTask.await()
}

@BackgroundThread
InterpreterApi initializeInterpreter() {
    Tasks.await(initializeTask);
    return InterpreterApi.create(...);
}

4. Menjalankan inferensi

Dengan menggunakan objek interpreter yang Anda buat, panggil metode run() untuk menghasilkan inferensi.

interpreter.run(inputBuffer, outputBuffer)

interpreter.run(inputBuffer, outputBuffer);

Akselerasi hardware

LiteRT memungkinkan Anda mempercepat performa model menggunakan prosesor hardware khusus, seperti unit pemrosesan grafis (GPU). Anda dapat memanfaatkan prosesor khusus ini menggunakan driver hardware yang disebut delegasi.

Delegasi GPU disediakan melalui layanan Google Play dan dimuat secara dinamis, seperti versi layanan Play dari Interpreter API.

Memeriksa kompatibilitas perangkat

Tidak semua perangkat mendukung akselerasi hardware GPU dengan TFLite. Untuk memitigasi error dan potensi error, gunakan metode TfLiteGpu.isGpuDelegateAvailable untuk memeriksa apakah perangkat kompatibel dengan delegasi GPU.

Gunakan metode ini untuk mengonfirmasi apakah perangkat kompatibel dengan GPU, dan gunakan CPU sebagai pengganti saat GPU tidak didukung.

useGpuTask = TfLiteGpu.isGpuDelegateAvailable(context)

Setelah memiliki variabel seperti useGpuTask, Anda dapat menggunakannya untuk menentukan apakah perangkat menggunakan delegasi GPU.

val interpreterTask = useGpuTask.continueWith { task ->
  val interpreterOptions = InterpreterApi.Options()
      .setRuntime(TfLiteRuntime.FROM_SYSTEM_ONLY)
  if (task.result) {
      interpreterOptions.addDelegateFactory(GpuDelegateFactory())
  }
  InterpreterApi.create(FileUtil.loadMappedFile(context, MODEL_PATH), interpreterOptions)
}
    

Task<InterpreterApi.Options> interpreterOptionsTask = useGpuTask.continueWith({ task ->
  InterpreterApi.Options options =
      new InterpreterApi.Options().setRuntime(TfLiteRuntime.FROM_SYSTEM_ONLY);
  if (task.getResult()) {
     options.addDelegateFactory(new GpuDelegateFactory());
  }
  return options;
});
    

GPU dengan Interpreter API

Untuk menggunakan delegasi GPU dengan Interpreter API:

1. Perbarui dependensi project untuk menggunakan delegasi GPU dari layanan Play:

   implementation 'com.google.android.gms:play-services-tflite-gpu:16.2.0'
   

2. Aktifkan opsi delegasi GPU dalam inisialisasi TFlite:

   Kotlin

   TfLite.initialize(context,
     TfLiteInitializationOptions.builder()
       .setEnableGpuDelegateSupport(true)
       .build())

   Java

   TfLite.initialize(context,
     TfLiteInitializationOptions.builder()
       .setEnableGpuDelegateSupport(true)
       .build());

3. Aktifkan delegasi GPU dalam opsi penafsir: tetapkan factory delegasi ke GpuDelegateFactory dengan memanggil addDelegateFactory() withinInterpreterApi.Options()`:

   Kotlin

   val interpreterOption = InterpreterApi.Options()
     .setRuntime(TfLiteRuntime.FROM_SYSTEM_ONLY)
     .addDelegateFactory(GpuDelegateFactory())

   Java

   Options interpreterOption = InterpreterApi.Options()
     .setRuntime(TfLiteRuntime.FROM_SYSTEM_ONLY)
     .addDelegateFactory(new GpuDelegateFactory());

Bermigrasi dari LiteRT mandiri

Jika Anda berencana memigrasikan aplikasi dari LiteRT mandiri ke API layanan Play, tinjau panduan tambahan berikut untuk memperbarui kode project aplikasi:

1. Tinjau bagian Batasan di halaman ini untuk memastikan kasus penggunaan Anda didukung.
2. Sebelum memperbarui kode, sebaiknya lakukan pemeriksaan performa dan akurasi untuk model Anda, terutama jika Anda menggunakan versi LiteRT (TF Lite) lebih lama dari versi 2.1, sehingga Anda memiliki dasar pengukuran untuk dibandingkan dengan penerapan baru.
3. Jika telah memigrasikan semua kode untuk menggunakan API layanan Play untuk LiteRT, Anda harus menghapus dependensi library runtime LiteRT yang ada (entri dengan org.tensorflow:tensorflow-lite:*) dari file build.gradle sehingga Anda dapat mengurangi ukuran aplikasi.
4. Identifikasi semua kemunculan pembuatan objek new Interpreter dalam kode Anda, dan ubah setiap kemunculan tersebut agar menggunakan panggilan InterpreterApi.create(). TfLite.initialize baru bersifat asinkron, yang berarti dalam sebagian besar kasus, ini bukan penggantian langsung: Anda harus mendaftarkan pemroses saat panggilan selesai. Lihat cuplikan kode di kode Langkah 3.
5. Tambahkan import org.tensorflow.lite.InterpreterApi; dan import org.tensorflow.lite.InterpreterApi.Options.TfLiteRuntime; ke file sumber apa pun menggunakan class org.tensorflow.lite.Interpreter atau org.tensorflow.lite.InterpreterApi.
6. Jika salah satu panggilan yang dihasilkan ke InterpreterApi.create() hanya memiliki satu argumen, tambahkan new InterpreterApi.Options() ke daftar argumen.
7. Tambahkan .setRuntime(TfLiteRuntime.FROM_SYSTEM_ONLY) ke argumen terakhir panggilan ke InterpreterApi.create().
8. Ganti semua kemunculan class org.tensorflow.lite.Interpreter lainnya dengan org.tensorflow.lite.InterpreterApi.

Jika ingin menggunakan LiteRT mandiri dan API layanan Play secara berdampingan, Anda harus menggunakan LiteRT (TF Lite) versi 2.9 atau yang lebih baru. LiteRT (TF Lite) versi 2.8 dan versi sebelumnya tidak kompatibel dengan versi API layanan Play.