Mit ML Kit können Sie Entitäten in einem Bild erkennen und mit Labels versehen. Diese API unterstützt eine Vielzahl von benutzerdefinierten Bildklassifizierungsmodellen. Unter Benutzerdefinierte Modelle mit ML Kit finden Sie Informationen zu den Anforderungen an die Modellkompatibilität sowie dazu, wo Sie vortrainierte Modelle finden und wie Sie Ihre eigenen Modelle trainieren.
Es gibt zwei Möglichkeiten, das Labeling von Bildern in benutzerdefinierte Modelle zu integrieren: Sie können die Pipeline als Teil Ihrer App bündeln oder eine nicht gebündelte Pipeline verwenden, die von Google Play-Diensten abhängig ist. Wenn Sie die nicht gebündelte Pipeline auswählen, ist Ihre Anwendung kleiner. Weitere Details finden Sie in der Tabelle unten.
Gebündelt | Nicht gruppiert | |
---|---|---|
Name der Bibliothek | com.google.mlkit:image-labeling-custom | com.google.android.gms:play-services-mlkit-image-labeling-custom |
Implementierung | Die Pipeline ist zum Zeitpunkt der Erstellung statisch mit Ihrer Anwendung verknüpft. | Die Pipeline wird dynamisch über die Google Play-Dienste heruntergeladen. |
App-Größe | Die Größe beträgt ca.3,8 MB. | Größe um ca. 200 KB erhöht. |
Initialisierungszeit | Pipeline ist sofort verfügbar. | Vor der ersten Verwendung muss möglicherweise auf den Download der Pipeline gewartet werden. |
API-Lebenszyklusphase | General Availability (GA) | Beta |
Es gibt zwei Möglichkeiten, ein benutzerdefiniertes Modell zu integrieren: Sie können das Modell bündeln, indem Sie es in den Asset-Ordner Ihrer App einfügen, oder es dynamisch von Firebase herunterladen. In der folgenden Tabelle werden diese beiden Optionen verglichen.
Gebündeltes Modell | Gehostetes Modell |
---|---|
Das Modell ist Teil des APK deiner App, das dessen Größe erhöht. | Das Modell gehört nicht zu Ihrem APK. Sie wird durch Hochladen in Firebase Machine Learning gehostet. |
Das Modell ist sofort verfügbar, auch wenn das Android-Gerät offline ist | Das Modell wird bei Bedarf heruntergeladen |
Kein Firebase-Projekt erforderlich | Erfordert ein Firebase-Projekt |
Du musst deine App neu veröffentlichen, um das Modell zu aktualisieren | Modellaktualisierungen übertragen, ohne die App noch einmal zu veröffentlichen |
Keine integrierten A/B-Tests | Einfache A/B-Tests mit Firebase Remote Config |
Ausprobieren
- In der Kurzanleitungsanwendung für Vision finden Sie ein Verwendungsbeispiel für das gebündelte Modell und in der Kurzanleitung für AutoML ein Beispiel für die Verwendung des gehosteten Modells.
Hinweis
Fügen Sie in der Datei
build.gradle
auf Projektebene in den Abschnittenbuildscript
undallprojects
das Maven-Repository von Google ein.Fügen Sie die Abhängigkeiten für die ML Kit-Android-Bibliotheken der Gradle-Datei auf App-Ebene Ihres Moduls hinzu. Diese ist in der Regel
app/build.gradle
. Wählen Sie je nach Ihren Anforderungen eine der folgenden Abhängigkeiten aus:So bündeln Sie die Pipeline mit Ihrer App:
dependencies { // ... // Use this dependency to bundle the pipeline with your app implementation 'com.google.mlkit:image-labeling-custom:17.0.2' }
Zur Verwendung der Pipeline in den Google Play-Diensten:
dependencies { // ... // Use this dependency to use the dynamically downloaded pipeline in Google Play Services implementation 'com.google.android.gms:play-services-mlkit-image-labeling-custom:16.0.0-beta5' }
Wenn Sie die Pipeline in den Google Play-Diensten verwenden, können Sie Ihre App so konfigurieren, dass die Pipeline nach der Installation Ihrer App aus dem Play Store automatisch auf das Gerät heruntergeladen wird. Fügen Sie dazu der Datei
AndroidManifest.xml
Ihrer Anwendung die folgende Deklaration hinzu:<application ...> ... <meta-data android:name="com.google.mlkit.vision.DEPENDENCIES" android:value="custom_ica" /> <!-- To use multiple downloads: android:value="custom_ica,download2,download3" --> </application>
Sie können die Verfügbarkeit der Pipeline auch explizit über die ModuleInstallClient API der Google Play-Dienste prüfen und einen Download anfordern.
Wenn Sie weder Pipeline-Downloads bei der Installation aktivieren noch explizite Downloads anfordern, wird die Pipeline bei der ersten Ausführung des Labelerstellers heruntergeladen. Anfragen, die Sie vor dem Abschluss des Downloads stellen, generieren keine Ergebnisse.
Fügen Sie die Abhängigkeit
linkFirebase
hinzu, wenn Sie ein Modell dynamisch von Firebase herunterladen möchten:Fügen Sie zum dynamischen Herunterladen eines Modells aus Firebase die Abhängigkeit
linkFirebase
hinzu:dependencies { // ... // Image labeling feature with model downloaded from Firebase implementation 'com.google.mlkit:image-labeling-custom:17.0.2' // Or use the dynamically downloaded pipeline in Google Play Services // implementation 'com.google.android.gms:play-services-mlkit-image-labeling-custom:16.0.0-beta5' implementation 'com.google.mlkit:linkfirebase:17.0.0' }
Wenn Sie ein Modell herunterladen möchten, müssen Sie Firebase zu Ihrem Android-Projekt hinzufügen, falls Sie dies noch nicht getan haben. Dies ist nicht erforderlich, wenn Sie das Modell bündeln.
1. Modell laden
Lokale Modellquelle konfigurieren
So bündeln Sie das Modell mit Ihrer App:
Kopieren Sie die Modelldatei (mit der Endung
.tflite
oder.lite
) in den Ordnerassets/
Ihrer Anwendung. Möglicherweise müssen Sie den Ordner zuerst erstellen, indem Sie mit der rechten Maustaste auf den Ordnerapp/
und dann auf Neu > Ordner > Asset-Ordner klicken.Fügen Sie dann der Datei
build.gradle
Ihrer App Folgendes hinzu, damit Gradle die Modelldatei beim Erstellen der App nicht komprimiert:android { // ... aaptOptions { noCompress "tflite" // or noCompress "lite" } }
Die Modelldatei ist im App-Paket enthalten und steht ML Kit als Roh-Asset zur Verfügung.
Erstellen Sie ein
LocalModel
-Objekt und geben Sie den Pfad zur Modelldatei an:Kotlin
val localModel = LocalModel.Builder() .setAssetFilePath("model.tflite") // or .setAbsoluteFilePath(absolute file path to model file) // or .setUri(URI to model file) .build()
Java
LocalModel localModel = new LocalModel.Builder() .setAssetFilePath("model.tflite") // or .setAbsoluteFilePath(absolute file path to model file) // or .setUri(URI to model file) .build();
Firebase-gehostete Modellquelle konfigurieren
Wenn Sie das ferngehostete Modell verwenden möchten, erstellen Sie mit FirebaseModelSource
ein RemoteModel
-Objekt. Geben Sie dabei den Namen an, den Sie dem Modell bei der Veröffentlichung zugewiesen haben:
Kotlin
// Specify the name you assigned in the Firebase console. val remoteModel = CustomRemoteModel .Builder(FirebaseModelSource.Builder("your_model_name").build()) .build()
Java
// Specify the name you assigned in the Firebase console. CustomRemoteModel remoteModel = new CustomRemoteModel .Builder(new FirebaseModelSource.Builder("your_model_name").build()) .build();
Starten Sie dann die Aufgabe zum Herunterladen des Modells und geben Sie die Bedingungen an, unter denen Sie den Download zulassen möchten. Wenn sich das Modell nicht auf dem Gerät befindet oder eine neuere Version des Modells verfügbar ist, wird es von der Aufgabe asynchron von Firebase heruntergeladen:
Kotlin
val downloadConditions = DownloadConditions.Builder() .requireWifi() .build() RemoteModelManager.getInstance().download(remoteModel, downloadConditions) .addOnSuccessListener { // Success. }
Java
DownloadConditions downloadConditions = new DownloadConditions.Builder() .requireWifi() .build(); RemoteModelManager.getInstance().download(remoteModel, downloadConditions) .addOnSuccessListener(new OnSuccessListener() { @Override public void onSuccess(@NonNull Task task) { // Success. } });
Viele Anwendungen starten die Downloadaufgabe im Initialisierungscode, Sie können dies jedoch jederzeit tun, bevor Sie das Modell verwenden müssen.
Labelersteller für Bilder konfigurieren
Nachdem Sie die Modellquellen konfiguriert haben, erstellen Sie aus einer davon ein ImageLabeler
-Objekt.
Folgende Optionen sind verfügbar:
Optionen | |
---|---|
confidenceThreshold
|
Minimaler Konfidenzwert erkannter Labels. Wenn nichts anderes festgelegt ist, wird jeder durch die Metadaten des Modells angegebene Klassifikatorgrenzwert verwendet. Wenn das Modell keine Metadaten enthält oder die Metadaten keinen Klassifikatorschwellenwert angeben, wird ein Standardschwellenwert von 0,0 verwendet. |
maxResultCount
|
Maximale Anzahl der zurückzugebenden Labels. Wenn die Richtlinie nicht konfiguriert ist, wird der Standardwert 10 verwendet. |
Wenn Sie nur ein lokal gebündeltes Modell haben, erstellen Sie einfach einen Labelersteller aus Ihrem LocalModel
-Objekt:
Kotlin
val customImageLabelerOptions = CustomImageLabelerOptions.Builder(localModel) .setConfidenceThreshold(0.5f) .setMaxResultCount(5) .build() val labeler = ImageLabeling.getClient(customImageLabelerOptions)
Java
CustomImageLabelerOptions customImageLabelerOptions = new CustomImageLabelerOptions.Builder(localModel) .setConfidenceThreshold(0.5f) .setMaxResultCount(5) .build(); ImageLabeler labeler = ImageLabeling.getClient(customImageLabelerOptions);
Bei einem remote gehosteten Modell müssen Sie prüfen, ob es heruntergeladen wurde, bevor Sie es ausführen. Sie können den Status der Modelldownloadaufgabe mit der Methode isModelDownloaded()
des Modellmanagers prüfen.
Sie müssen dies nur vor dem Ausführen des Labelerstellers bestätigen. Wenn Sie sowohl ein remote gehostetes Modell als auch ein lokal gebündeltes Modell haben, kann es jedoch sinnvoll sein, diese Prüfung beim Instanziieren des Bildlabelerstellers durchzuführen: Erstellen Sie einen Labelersteller aus dem Remote-Modell, wenn es heruntergeladen wurde, und andernfalls aus dem lokalen Modell.
Kotlin
RemoteModelManager.getInstance().isModelDownloaded(remoteModel) .addOnSuccessListener { isDownloaded -> val optionsBuilder = if (isDownloaded) { CustomImageLabelerOptions.Builder(remoteModel) } else { CustomImageLabelerOptions.Builder(localModel) } val options = optionsBuilder .setConfidenceThreshold(0.5f) .setMaxResultCount(5) .build() val labeler = ImageLabeling.getClient(options) }
Java
RemoteModelManager.getInstance().isModelDownloaded(remoteModel) .addOnSuccessListener(new OnSuccessListener() { @Override public void onSuccess(Boolean isDownloaded) { CustomImageLabelerOptions.Builder optionsBuilder; if (isDownloaded) { optionsBuilder = new CustomImageLabelerOptions.Builder(remoteModel); } else { optionsBuilder = new CustomImageLabelerOptions.Builder(localModel); } CustomImageLabelerOptions options = optionsBuilder .setConfidenceThreshold(0.5f) .setMaxResultCount(5) .build(); ImageLabeler labeler = ImageLabeling.getClient(options); } });
Wenn Sie nur ein extern gehostetes Modell haben, sollten Sie die modellbezogenen Funktionen deaktivieren, z. B. einen Teil Ihrer UI ausblenden oder ausblenden, bis Sie bestätigen, dass das Modell heruntergeladen wurde. Dazu hängen Sie einen Listener an die Methode download()
des Modellmanagers an:
Kotlin
RemoteModelManager.getInstance().download(remoteModel, conditions) .addOnSuccessListener { // Download complete. Depending on your app, you could enable the ML // feature, or switch from the local model to the remote model, etc. }
Java
RemoteModelManager.getInstance().download(remoteModel, conditions) .addOnSuccessListener(new OnSuccessListener() { @Override public void onSuccess(Void v) { // Download complete. Depending on your app, you could enable // the ML feature, or switch from the local model to the remote // model, etc. } });
2. Eingabebild vorbereiten
Erstellen Sie dann für jedes Bild, das Sie mit einem Label versehen möchten, einInputImage
-Objekt aus Ihrem Bild. Der Bildlabelersteller wird am schnellsten ausgeführt, wenn Sie Bitmap
oder bei Verwendung der Camera2 API eine YUV_420_888 media.Image
verwenden. Diese Methode wird nach Möglichkeit empfohlen.
Sie können ein InputImage
-Objekt aus verschiedenen Quellen erstellen. Diese werden im Folgenden beschrieben.
Mit einem media.Image
Wenn Sie ein InputImage
-Objekt aus einem media.Image
-Objekt erstellen möchten, z. B. wenn Sie ein Bild mit der Kamera eines Geräts aufnehmen, übergeben Sie das media.Image
-Objekt und die Bilddrehung an InputImage.fromMediaImage()
.
Wenn Sie die
CameraX-Bibliothek verwenden, berechnen die Klassen OnImageCapturedListener
und ImageAnalysis.Analyzer
den Rotationswert für Sie.
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 // ... } } }
Wenn du keine Kamerabibliothek verwendest, die den Drehgrad des Bildes angibt, kannst du ihn anhand des Gerätedrehungsgrads und der Ausrichtung des Kamerasensors im Gerät berechnen:
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; }
Übergeben Sie dann das Objekt media.Image
und den Wert für den Rotationsgrad an InputImage.fromMediaImage()
:
Kotlin
val image = InputImage.fromMediaImage(mediaImage, rotation)
Java
InputImage image = InputImage.fromMediaImage(mediaImage, rotation);
Datei-URI verwenden
Übergeben Sie den App-Kontext und den Datei-URI an InputImage.fromFilePath()
, um ein InputImage
-Objekt aus einem Datei-URI zu erstellen. Das ist nützlich, wenn du den Nutzer mit einem ACTION_GET_CONTENT
-Intent zur Auswahl eines Bildes aus der Galerie-App aufforderst.
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(); }
Mit ByteBuffer
oder ByteArray
Berechnen Sie zuerst den Bilddrehungsgrad wie zuvor für die media.Image
-Eingabe beschrieben, um ein InputImage
-Objekt aus einem ByteBuffer
- oder ByteArray
-Objekt zu erstellen.
Erstellen Sie dann das InputImage
-Objekt mit dem Puffer oder Array und geben dabei Höhe, Breite, Farbcodierungsformat und Rotationsgrad des Bildes an:
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 );
Mit einem Bitmap
Mit der folgenden Deklaration kannst du ein InputImage
-Objekt aus einem Bitmap
-Objekt erstellen:
Kotlin
val image = InputImage.fromBitmap(bitmap, 0)
Java
InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
Das Bild wird durch ein Bitmap
-Objekt zusammen mit Rotationsgraden dargestellt.
3. Labelersteller für Bilder ausführen
Übergeben Sie das Objekt image
an die Methode process()
der ImageLabeler
, um Objekte in einem Bild mit einem Label zu versehen.
Kotlin
labeler.process(image) .addOnSuccessListener { labels -> // Task completed successfully // ... } .addOnFailureListener { e -> // Task failed with an exception // ... }
Java
labeler.process(image) .addOnSuccessListener(new OnSuccessListener<List<ImageLabel>>() { @Override public void onSuccess(List<ImageLabel> labels) { // Task completed successfully // ... } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Task failed with an exception // ... } });
4. Informationen zu Elementen mit Labels abrufen
Wenn der Vorgang zum Beschriften von Bildern erfolgreich ist, wird eine Liste vonImageLabel
-Objekten an den Erfolgs-Listener übergeben. Jedes ImageLabel
-Objekt steht für etwas, das im Bild mit einem Label versehen wurde. Sie können für jedes Label die Textbeschreibung (sofern in den Metadaten der TensorFlow Lite-Modelldatei verfügbar), den Konfidenzwert und den Index abrufen. Beispiel:
Kotlin
for (label in labels) { val text = label.text val confidence = label.confidence val index = label.index }
Java
for (ImageLabel label : labels) { String text = label.getText(); float confidence = label.getConfidence(); int index = label.getIndex(); }
Tipps zur Verbesserung der Echtzeitleistung
Wenn Sie Bilder in einer Echtzeitanwendung mit Labels versehen möchten, beachten Sie die folgenden Richtlinien, um die besten Framerates zu erzielen:
- Wenn Sie die API
Camera
odercamera2
verwenden, drosseln Sie Aufrufe an den Labelersteller für Bilder. Falls ein neuer Videoframe verfügbar wird, während der Bildlabelersteller ausgeführt wird, löschen Sie ihn. Ein Beispiel hierfür finden Sie in der Beispiel-App der Kurzanleitung in der KlasseVisionProcessorBase
. - Wenn Sie die
CameraX
API verwenden, muss die Abwärtsdruckstrategie auf den StandardwertImageAnalysis.STRATEGY_KEEP_ONLY_LATEST
festgelegt sein. Dadurch wird garantiert, dass jeweils nur ein Bild zur Analyse gesendet wird. Wenn weitere Bilder erstellt werden, wenn das Analysetool ausgelastet ist, werden diese automatisch gelöscht und nicht in die Warteschlange gestellt. Sobald das zu analysierende Bild durch Aufrufen von ImageProxy.close() geschlossen wurde, wird das jeweils neueste Image bereitgestellt. - Wenn Sie die Ausgabe des Bildlabelerstellers verwenden, um Grafiken über das Eingabebild einzublenden, rufen Sie zuerst das Ergebnis aus ML Kit ab und rendern Sie dann das Bild und das Overlay in einem einzigen Schritt. Dies wird für jeden Eingabeframe nur einmal auf der Anzeigeoberfläche gerendert. Ein Beispiel finden Sie in der Beispiel-App aus der Kurzanleitung in den Klassen
CameraSourcePreview
undGraphicOverlay
. - Wenn du die Camera2 API verwendest, nimm Bilder im
ImageFormat.YUV_420_888
-Format auf. Wenn du die ältere Camera API verwendest, nimm Bilder imImageFormat.NV21
-Format auf.