Saat Anda meneruskan gambar ke ML Kit, ML Kit akan mendeteksi hingga lima objek dalam gambar beserta posisi setiap objek dalam gambar. Saat mendeteksi objek dalam streaming video, setiap objek memiliki ID unik yang dapat Anda gunakan untuk melacak objek dari frame ke frame.
Anda dapat menggunakan model klasifikasi gambar kustom untuk mengklasifikasikan objek yang terdeteksi. Lihat Model kustom dengan ML Kit untuk panduan tentang persyaratan kompatibilitas model, tempat menemukan model terlatih, dan cara melatih model Anda sendiri.
Ada dua cara untuk mengintegrasikan model kustom. Anda dapat memaketkan model dengan menempatkannya di dalam folder aset aplikasi, atau Anda dapat mendownloadnya secara dinamis dari Cloud Storage. Tabel berikut membandingkan kedua opsi tersebut.
| Model Paket | Model yang Dihosting |
|---|---|
| Model merupakan bagian dari APK aplikasi, yang meningkatkan ukurannya. | Model bukan bagian dari APK Anda. Model dihosting dengan mengupload ke Cloud Storage. Sebaiknya gunakan Cloud Storage untuk Firebase. |
| Model akan langsung tersedia, bahkan saat perangkat Android sedang offline | Aplikasi Anda harus menyertakan kode untuk mendownload model sesuai permintaan |
| Tidak memerlukan project Firebase | Memerlukan project Firebase (jika menggunakan Cloud Storage untuk Firebase). |
| Anda harus memublikasikan ulang aplikasi untuk mengupdate model | Update model dapat dikirim tanpa memublikasikan ulang aplikasi |
| Tidak ada pengujian A/B bawaan | Pengujian A/B dengan Firebase Remote Config |
Cobalah
- Lihat aplikasi quickstart vision untuk mengetahui contoh penggunaan model paket dan aplikasi quickstart automl untuk mengetahui contoh penggunaan model yang dihosting.
- Lihat aplikasi showcase Desain Material untuk mengetahui penerapan API ini secara menyeluruh.
Sebelum memulai
1. Dalam file level projectbuild.gradle.kts, pastikan Anda memasukkan
repositori Maven Google di bagian buildscript dan
allprojects.
Tambahkan dependensi untuk library Android ML Kit ke file gradle level aplikasi modul Anda, biasanya
app/build.gradle.kts:Untuk memaketkan model dengan aplikasi Anda:
dependencies { // ... // Object detection & tracking feature with custom bundled model implementation("com.google.mlkit:object-detection-custom:17.0.2") }Jika Anda ingin mendownload model dari Cloud Storage untuk Firebase, pastikan Anda menambahkan Firebase ke project Android, jika belum melakukannya. Langkah ini tidak diperlukan jika Anda memaketkan model.
1. Muat model
Anda dapat memuat model dari sumber yang dipaketkan secara lokal atau sumber yang dihosting dari jarak jauh.
Mengonfigurasi sumber model lokal
Untuk memaketkan model dengan aplikasi Anda:
Salin file model (biasanya diakhiri dengan
.tfliteatau.lite) ke folderassets/aplikasi Anda. (Anda mungkin perlu membuat folder terlebih dahulu dengan mengklik kanan folderapp/, lalu mengklik Baru > Folder > Folder Aset.)Buat objek
LocalModeldengan menentukan jalur ke file model:Kotlin
val localModel = LocalModel.Builder() .setAssetFilePath("model.tflite") // or .setAbsoluteFilePath(absolute path to model file) // or .setUri(URI to model file) .build()
Java
LocalModel localModel = new LocalModel.Builder() .setAssetFilePath("model.tflite") // or .setAbsoluteFilePath(absolute path to model file) // or .setUri(URI to model file) .build();
Mengonfigurasi sumber model yang dihosting dari jarak jauh
Untuk menggunakan model yang dihosting dari jarak jauh, Anda harus mendownload file model ke penyimpanan lokal perangkat menggunakan logika aplikasi Anda sendiri, lalu memuatnya sebagai model lokal. Sebaiknya gunakan Cloud Storage untuk Firebase guna menghosting model. Untuk mengetahui detail penerapan, lihat panduan migrasi Firebase ML ke Cloud Storage.
2. Mengonfigurasi detektor objek
Setelah mengonfigurasi sumber model Anda, konfigurasikan detektor objek untuk kasus penggunaan Anda dengan objek CustomObjectDetectorOptions. Anda dapat mengubah setelan berikut:
| Setelan Detektor Objek | |
|---|---|
| Mode deteksi |
STREAM_MODE (default) | SINGLE_IMAGE_MODE
Dalam Dalam |
| Mendeteksi dan melacak beberapa objek |
false (default) | true
Mendeteksi dan melacak hingga 5 objek atau hanya objek yang paling tampil beda (default). |
| Mengklasifikasikan objek |
false (default) | true
Mengklasifikasikan objek yang terdeteksi menggunakan model pengklasifikasi kustom yang disediakan
atau tidak. Untuk menggunakan model klasifikasi kustom
Anda harus menetapkan nilai ini ke |
| Batas keyakinan klasifikasi |
Skor keyakinan minimum label yang terdeteksi. Jika tidak ditetapkan, batas pengklasifikasi yang ditentukan oleh metadata model akan digunakan. Jika model tidak berisi metadata atau metadata tidak menentukan batas pengklasifikasi, batas default 0.0 akan di gunakan. |
| Label maksimum per objek |
Jumlah maksimum label per objek yang akan ditampilkan detektor. Jika tidak ditetapkan, nilai default 10 akan digunakan. |
API deteksi dan pelacakan objek dioptimalkan untuk dua kasus penggunaan inti berikut ini:
- Deteksi langsung dan pelacakan objek paling tampil beda di jendela bidik kamera.
- Deteksi beberapa objek dari gambar statis.
Untuk mengonfigurasi API bagi kasus penggunaan ini, dengan model yang dipaketkan secara lokal:
Kotlin
// Live detection and tracking val customObjectDetectorOptions = CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.STREAM_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build() // Multiple object detection in static images val customObjectDetectorOptions = CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableMultipleObjects() .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build() val objectDetector = ObjectDetection.getClient(customObjectDetectorOptions)
Java
// Live detection and tracking CustomObjectDetectorOptions customObjectDetectorOptions = new CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.STREAM_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build(); // Multiple object detection in static images CustomObjectDetectorOptions customObjectDetectorOptions = new CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableMultipleObjects() .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build(); ObjectDetector objectDetector = ObjectDetection.getClient(customObjectDetectorOptions);
Jika Anda memiliki model yang dihosting dari jarak jauh, Anda harus memeriksa apakah model tersebut sudah didownload sebelum menjalankannya.
Meskipun Anda hanya perlu mengonfirmasi hal ini sebelum menjalankan detektor, jika Anda memiliki model yang dihosting dari jarak jauh dan model yang dipaketkan secara lokal, sebaiknya lakukan pemeriksaan ini saat membuat instance detektor gambar: buat detektor dari model jarak jauh jika model tersebut sudah didownload, dan dari model lokal jika belum didownload.
Kotlin
val modelFile = File(context.cacheDir, "my_remote_model.tflite") val model = if (modelFile.exists()) { // Use the downloaded model if available LocalModel.Builder().setAbsoluteFilePath(modelFile.absolutePath).build() } else { // Fall back to the bundled model LocalModel.Builder().setAssetFilePath("model.tflite").build() } val customObjectDetectorOptions = CustomObjectDetectorOptions.Builder(model) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build() val objectDetector = ObjectDetection.getClient(customObjectDetectorOptions)
Java
File modelFile = new File(context.getCacheDir(), "my_remote_model.tflite"); LocalModel model; if (modelFile.exists()) { // Use the downloaded model if available model = new LocalModel.Builder().setAbsoluteFilePath(modelFile.getAbsolutePath()).build(); } else { // Fall back to the bundled model model = new LocalModel.Builder().setAssetFilePath("model.tflite").build(); } CustomObjectDetectorOptions customObjectDetectorOptions = new CustomObjectDetectorOptions.Builder(model) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build(); ObjectDetector objectDetector = ObjectDetection.getClient(customObjectDetectorOptions);
Jika Anda hanya memiliki model yang dihosting dari jarak jauh, Anda harus menonaktifkan fungsionalitas terkait model, misalnya membuat sebagian UI berwarna abu-abu atau menyembunyikannya, hingga Anda mengonfirmasi model tersebut telah didownload.
Kotlin
val localFile = File(context.cacheDir, "my_remote_model.tflite") if (localFile.exists()) { // Model is already cached, initialize immediately initializeDetector(localFile) } else { // Model is not yet available, show loading UI and start download showLoadingUI() val storage = Firebase.storage val modelRef = storage.getReferenceFromUrl("gs://YOUR_BUCKET/path/to/model.tflite") modelRef.getFile(localFile) .addOnSuccessListener { // Download complete, initialize the detector hideLoadingUI() initializeDetector(localFile) } .addOnFailureListener { // Handle download error showErrorUI() } } private fun initializeDetector(modelFile: File) { val localModel = LocalModel.Builder().setAbsoluteFilePath(modelFile.absolutePath).build() val customObjectDetectorOptions = CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableClassification() .build() val objectDetector = ObjectDetection.getClient(customObjectDetectorOptions) // Enable ML-related UI features here enableMLFeatures(objectDetector) }
Java
File localFile = new File(context.getCacheDir(), "my_remote_model.tflite"); if (localFile.exists()) { // Model is already cached, initialize immediately initializeDetector(localFile); } else { // Model is not yet available, show loading UI and start download showLoadingUI(); FirebaseStorage storage = FirebaseStorage.getInstance(); StorageReference modelRef = storage.getReferenceFromUrl("gs://YOUR_BUCKET/path/to/model.tflite"); modelRef.getFile(localFile) .addOnSuccessListener(new OnSuccessListener<FileDownloadTask.TaskSnapshot>() { @Override public void onSuccess(FileDownloadTask.TaskSnapshot taskSnapshot) { // Download complete, initialize the detector hideLoadingUI(); initializeDetector(localFile); } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle download error showErrorUI(); } }); } private void initializeDetector(File modelFile) { LocalModel localModel = new LocalModel.Builder().setAbsoluteFilePath(modelFile.getAbsolutePath()).build(); CustomObjectDetectorOptions customObjectDetectorOptions = new CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableClassification() .build(); ObjectDetector objectDetector = ObjectDetection.getClient(customObjectDetectorOptions); // Enable ML-related UI features here enableMLFeatures(objectDetector); }
3. Siapkan gambar input
Buat objekInputImage dari gambar Anda.
Detektor objek berjalan langsung dari Bitmap, ByteBuffer NV21, atau media.Image YUV_420_888. Membuat InputImage dari sumber tersebut direkomendasikan jika Anda memiliki akses langsung ke salah satu sumber tersebut. Jika Anda membuat InputImage dari sumber lain, kami akan menangani konversi secara internal untuk Anda dan mungkin kurang efisien.
Anda dapat membuat InputImage
objek dari beberapa sumber, yang masing-masing langkahnya dijelaskan di bawah.
Menggunakan media.Image
Untuk membuat objek InputImage
dari objek media.Image, seperti saat mengambil gambar dari kamera perangkat, teruskan objek media.Image dan rotasi gambar ke InputImage.fromMediaImage().
Jika Anda menggunakan
library CameraX, class OnImageCapturedListener dan
ImageAnalysis.Analyzer akan menghitung nilai rotasi
untuk Anda.
Kotlin
private class YourImageAnalyzer : ImageAnalysis.Analyzer { override fun analyze(imageProxy: ImageProxy) { val mediaImage = imageProxy.image if (mediaImage != null) { val image = InputImage.fromMediaImage(mediaImage, imageProxy.imageInfo.rotationDegrees) // Pass image to an ML Kit Vision API // ... } } }
Java
private class YourAnalyzer implements ImageAnalysis.Analyzer { @Override public void analyze(ImageProxy imageProxy) { Image mediaImage = imageProxy.getImage(); if (mediaImage != null) { InputImage image = InputImage.fromMediaImage(mediaImage, imageProxy.getImageInfo().getRotationDegrees()); // Pass image to an ML Kit Vision API // ... } } }
Jika Anda tidak menggunakan library kamera yang memberi derajat rotasi gambar, Anda dapat menghitungnya dari derajat rotasi perangkat dan orientasi sensor kamera pada perangkat:
Kotlin
private val ORIENTATIONS = SparseIntArray() init { ORIENTATIONS.append(Surface.ROTATION_0, 0) ORIENTATIONS.append(Surface.ROTATION_90, 90) ORIENTATIONS.append(Surface.ROTATION_180, 180) ORIENTATIONS.append(Surface.ROTATION_270, 270) } /** * Get the angle by which an image must be rotated given the device's current * orientation. */ @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP) @Throws(CameraAccessException::class) private fun getRotationCompensation(cameraId: String, activity: Activity, isFrontFacing: Boolean): Int { // Get the device's current rotation relative to its "native" orientation. // Then, from the ORIENTATIONS table, look up the angle the image must be // rotated to compensate for the device's rotation. val deviceRotation = activity.windowManager.defaultDisplay.rotation var rotationCompensation = ORIENTATIONS.get(deviceRotation) // Get the device's sensor orientation. val cameraManager = activity.getSystemService(CAMERA_SERVICE) as CameraManager val sensorOrientation = cameraManager .getCameraCharacteristics(cameraId) .get(CameraCharacteristics.SENSOR_ORIENTATION)!! if (isFrontFacing) { rotationCompensation = (sensorOrientation + rotationCompensation) % 360 } else { // back-facing rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360 } return rotationCompensation }
Java
private static final SparseIntArray ORIENTATIONS = new SparseIntArray(); static { ORIENTATIONS.append(Surface.ROTATION_0, 0); ORIENTATIONS.append(Surface.ROTATION_90, 90); ORIENTATIONS.append(Surface.ROTATION_180, 180); ORIENTATIONS.append(Surface.ROTATION_270, 270); } /** * Get the angle by which an image must be rotated given the device's current * orientation. */ @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP) private int getRotationCompensation(String cameraId, Activity activity, boolean isFrontFacing) throws CameraAccessException { // Get the device's current rotation relative to its "native" orientation. // Then, from the ORIENTATIONS table, look up the angle the image must be // rotated to compensate for the device's rotation. int deviceRotation = activity.getWindowManager().getDefaultDisplay().getRotation(); int rotationCompensation = ORIENTATIONS.get(deviceRotation); // Get the device's sensor orientation. CameraManager cameraManager = (CameraManager) activity.getSystemService(CAMERA_SERVICE); int sensorOrientation = cameraManager .getCameraCharacteristics(cameraId) .get(CameraCharacteristics.SENSOR_ORIENTATION); if (isFrontFacing) { rotationCompensation = (sensorOrientation + rotationCompensation) % 360; } else { // back-facing rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360; } return rotationCompensation; }
Kemudian, teruskan objek media.Image dan nilai derajat rotasi ke InputImage.fromMediaImage():
Kotlin
val image = InputImage.fromMediaImage(mediaImage, rotation)
Java
InputImage image = InputImage.fromMediaImage(mediaImage, rotation);
Menggunakan URI file
Untuk membuat objek dari URI file, teruskan konteks aplikasi dan URI file ke InputImage.fromFilePath().InputImage Hal ini berguna saat Anda
menggunakan intent ACTION_GET_CONTENT untuk meminta pengguna memilih
gambar dari aplikasi galeri mereka.
Kotlin
val image: InputImage try { image = InputImage.fromFilePath(context, uri) } catch (e: IOException) { e.printStackTrace() }
Java
InputImage image; try { image = InputImage.fromFilePath(context, uri); } catch (IOException e) { e.printStackTrace(); }
Menggunakan ByteBuffer atau ByteArray
Untuk membuat objek InputImage
dari ByteBuffer atau ByteArray, pertama-tama hitung derajat rotasi gambar seperti yang dijelaskan sebelumnya untuk input media.Image.
Kemudian, buat objek InputImage dengan buffer atau array, beserta tinggi, lebar, format encoding warna, dan derajat rotasi gambar:
Kotlin
val image = InputImage.fromByteBuffer( byteBuffer, /* image width */ 480, /* image height */ 360, rotationDegrees, InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12 ) // Or: val image = InputImage.fromByteArray( byteArray, /* image width */ 480, /* image height */ 360, rotationDegrees, InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12 )
Java
InputImage image = InputImage.fromByteBuffer(byteBuffer, /* image width */ 480, /* image height */ 360, rotationDegrees, InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12 ); // Or: InputImage image = InputImage.fromByteArray( byteArray, /* image width */480, /* image height */360, rotation, InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12 );
Menggunakan Bitmap
Untuk membuat objek InputImage
dari objek Bitmap, buat deklarasi berikut:
Kotlin
val image = InputImage.fromBitmap(bitmap, 0)
Java
InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
Gambar direpresentasikan oleh objek Bitmap bersama dengan derajat rotasi.
4. Menjalankan detektor objek
Kotlin
objectDetector .process(image) .addOnFailureListener(e -> {...}) .addOnSuccessListener(results -> { for (detectedObject in results) { // ... } });
Java
objectDetector .process(image) .addOnFailureListener(e -> {...}) .addOnSuccessListener(results -> { for (DetectedObject detectedObject : results) { // ... } });
5. Mendapatkan informasi tentang objek berlabel
Jika panggilan ke process() berhasil, daftar DetectedObject akan diteruskan ke pemroses peristiwa sukses.
Setiap DetectedObject berisi properti berikut:
| Kotak pembatas | Rect yang menunjukkan posisi objek dalam
gambar. |
||||||
| ID Pelacakan | Bilangan bulat yang mengidentifikasi objek lintas gambar. Null dalam SINGLE_IMAGE_MODE. | ||||||
| Label |
|
Kotlin
// The list of detected objects contains one item if multiple // object detection wasn't enabled. for (detectedObject in results) { val boundingBox = detectedObject.boundingBox val trackingId = detectedObject.trackingId for (label in detectedObject.labels) { val text = label.text val index = label.index val confidence = label.confidence } }
Java
// The list of detected objects contains one item if multiple // object detection wasn't enabled. for (DetectedObject detectedObject : results) { Rect boundingBox = detectedObject.getBoundingBox(); Integer trackingId = detectedObject.getTrackingId(); for (Label label : detectedObject.getLabels()) { String text = label.getText(); int index = label.getIndex(); float confidence = label.getConfidence(); } }
Memastikan pengalaman pengguna yang baik
Untuk mendapatkan pengalaman pengguna terbaik, ikuti pedoman ini dalam aplikasi:
- Keberhasilan deteksi objek bergantung pada kompleksitas visual objek. Agar terdeteksi, objek dengan sedikit fitur visual mungkin perlu menempati bagian yang lebih besar pada gambar. Anda sebaiknya memberikan panduan kepada pengguna tentang pengambilan input yang tepat bagi jenis objek yang ingin Anda deteksi.
- Saat menggunakan klasifikasi, jika ingin mendeteksi objek yang tidak secara jelas termasuk dalam kategori yang didukung, terapkan penanganan khusus untuk objek yang tidak diketahui.
Selain itu, lihat aplikasi showcase Desain Material ML Kit dan koleksi Pola Desain Material untuk fitur yang didukung machine learning.
Meningkatkan performa
Jika ingin menggunakan deteksi objek dalam aplikasi real-time, ikuti pedoman ini untuk mencapai frekuensi frame terbaik:Saat menggunakan mode streaming dalam aplikasi real-time, jangan gunakan deteksi beberapa objek, karena sebagian besar perangkat tidak akan dapat menghasilkan frekuensi frame yang memadai.
- Jika Anda menggunakan
Cameraataucamera2API, batasi panggilan ke detektor. Jika frame video baru tersedia saat detektor sedang berjalan, hapus frame tersebut. Lihat classVisionProcessorBasedalam aplikasi contoh panduan memulai untuk digunakan sebagai contoh. - Jika Anda menggunakan
CameraXAPI, pastikan strategi backpressure ditetapkan ke nilai defaultImageAnalysis.STRATEGY_KEEP_ONLY_LATEST. Hal ini menjamin hanya satu gambar yang akan dikirimkan untuk analisis dalam satu waktu. Jika lebih banyak gambar dihasilkan saat penganalisis sedang sibuk, gambar tersebut akan otomatis dihapus dan tidak dimasukkan ke antrean untuk pengiriman. Setelah gambar yang sedang dianalisis ditutup dengan memanggil ImageProxy.close(), gambar terbaru berikutnya akan dikirimkan. - Jika Anda menggunakan output detektor untuk menempatkan grafis pada
gambar input, pertama-tama dapatkan hasilnya dari ML Kit, lalu render gambar
dan tempatkan grafis dalam satu langkah. Hal ini hanya merender ke permukaan tampilan
hanya sekali untuk setiap frame input. Lihat class
CameraSourcePreviewdanGraphicOverlaydalam aplikasi contoh panduan memulai untuk digunakan sebagai contoh. - Jika Anda menggunakan Camera2 API, ambil gambar dalam
ImageFormat.YUV_420_888format. Jika Anda menggunakan Camera API versi lama, ambil gambar dalamImageFormat.NV21format.