Etichetta le immagini con un modello personalizzato su Android

Puoi utilizzare ML Kit per riconoscere le entità in un'immagine ed etichettarle. Questa API supporta un'ampia gamma di modelli personalizzati di classificazione delle immagini. Consulta la sezione Modelli personalizzati con ML Kit per indicazioni sui requisiti di compatibilità dei modelli, su dove trovare modelli preaddestrati e su come addestrare i tuoi modelli.

Esistono due modi per integrare l'etichettatura delle immagini con i modelli personalizzati: raggruppando la pipeline come parte dell'app o utilizzando una pipeline non raggruppata che dipende da Google Play Services. Se selezioni la pipeline separata, la tua app sarà più piccola. Vedi la tabella seguente per i dettagli.

	In bundle	Senza pacchetto
Nome della raccolta	com.google.mlkit:image-labeling-custom	com.google.android.gms:play-services-mlkit-image-labeling-custom
Implementazione	Pipeline è collegato staticamente alla tua app al momento della compilazione.	La pipeline viene scaricata in modo dinamico utilizzando Google Play Services.
Dimensioni dell'app	Aumento delle dimensioni di circa 3,8 MB.	Aumento delle dimensioni di circa 200 kB.
Tempo di inizializzazione	Pipeline è disponibile immediatamente.	Potrebbe essere necessario attendere il download della pipeline prima del primo utilizzo.
Fase del ciclo di vita dell'API	Disponibilità generale (GA)	Beta

Nota: la versione separata dell'etichettatura delle immagini con modelli personalizzati è offerta in versione beta, il che significa che potrebbe essere modificata in modi incompatibili con le versioni precedenti e non è soggetta a SLA (accordo sul livello del servizio) o a norme sul ritiro.

Esistono due modi per integrare un modello personalizzato: raggrupparlo inserendolo nella cartella degli asset dell'app o scaricarlo dinamicamente da Firebase. La tabella seguente mette a confronto queste due opzioni.

Modello in bundle	Modello ospitato
Il modello fa parte dell'APK della tua app, il che ne aumenta le dimensioni.	Il modello non fa parte dell'APK. Viene ospitato tramite caricamento su Cloud Storage. Ti consigliamo di utilizzare Cloud Storage per Firebase.
Il modello è disponibile immediatamente, anche quando il dispositivo Android è offline	La tua app deve includere il codice per scaricare il modello on demand
Non è necessario un progetto Firebase	Richiede un progetto Firebase (se utilizzi Cloud Storage for Firebase).
Devi ripubblicare l'app per aggiornare il modello	Eseguire il push degli aggiornamenti del modello senza ripubblicare l'app
Nessun test A/B integrato	Test A/B con Firebase Remote Config

Prova

• Consulta l'app di avvio rapido di Vision per un esempio di utilizzo del modello in bundle e l'app di avvio rapido di AutoML per un esempio di utilizzo del modello ospitato.

Prima di iniziare

1. Nel file build.gradle.kts a livello di progetto, assicurati di includere il repository Maven di Google nelle sezioni buildscript e allprojects.

2. Aggiungi le dipendenze per le librerie Android ML Kit al file Gradle a livello di app del modulo, che di solito è app/build.gradle.kts. Scegli una delle seguenti dipendenze in base alle tue esigenze:

   Per raggruppare la pipeline con la tua app:

   dependencies {
     // ...
     // Use this dependency to bundle the pipeline with your app
     implementation("com.google.mlkit:image-labeling-custom:17.0.3")
   }
   

   Per l'utilizzo della pipeline in Google Play Services:

   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")
   }
   

3. Se scegli di utilizzare la pipeline in Google Play Services, puoi configurare la tua app per scaricare automaticamente la pipeline sul dispositivo dopo l'installazione dell'app dal Play Store. Per farlo, aggiungi la seguente dichiarazione al file AndroidManifest.xml della tua app:

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

   Puoi anche controllare esplicitamente la disponibilità della pipeline e richiedere il download tramite l'API ModuleInstallClient di Google Play Services.

   Se non attivi i download della pipeline in fase di installazione o non richiedi il download esplicito, la pipeline viene scaricata la prima volta che esegui l'etichettatore. Le richieste effettuate prima del completamento del download non producono risultati.

4. Se vuoi scaricare un modello utilizzando Cloud Storage for Firebase, assicurati di aggiungere Firebase al tuo progetto Android, se non l'hai già fatto. Questa operazione non è necessaria quando raggruppi il modello.

1. Carica il modello

Puoi caricare il modello da un'origine raggruppata localmente o da un'origine ospitata in remoto.

Configurare un'origine modello locale

Per raggruppare il modello con l'app:

1. Copia il file del modello (di solito termina con .tflite o .lite) nella cartella assets/ dell'app. Potresti dover creare prima la cartella facendo clic con il tasto destro del mouse sulla cartella app/, poi facendo clic su Nuovo > Cartella > Cartella asset.

2. Crea l'oggetto LocalModel, specificando il percorso del file del modello:

   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();

   Nota: le app che hanno come target Android 11 (livello API 30) non possono più accedere ai file dall'archivio esterno a causa degli aggiornamenti dell'archivio in Android 11.
   Nota: se hai un modello addestrato con AutoML Vision Edge in Firebase (non Google Cloud), le istruzioni precedenti potrebbero non funzionare. Segui la guida alla migrazione per istruzioni.

Configura un'origine modello ospitata in remoto

Per utilizzare il modello ospitato in remoto, devi scaricare il file del modello nello spazio di archiviazione locale del dispositivo utilizzando la logica della tua app, quindi caricarlo come modello locale. Ti consigliamo di utilizzare Cloud Storage for Firebase per ospitare un modello. Per i dettagli di implementazione, consulta la guida alla migrazione da Firebase ML a Cloud Storage.

Configurare lo strumento di etichettatura delle immagini

Dopo aver configurato le origini del modello, crea un oggetto ImageLabeler da una di queste.

Sono disponibili le seguenti opzioni:

Opzioni
confidenceThreshold	Punteggio di confidenza minimo delle etichette rilevate. Se non impostato, verrà utilizzata qualsiasi soglia del classificatore specificata dai metadati del modello. Se il modello non contiene metadati o i metadati non specificano una soglia del classificatore, verrà utilizzata una soglia predefinita di 0,0.
maxResultCount	Numero massimo di etichette da restituire. Se non impostato, verrà utilizzato il valore predefinito di 10.

Se hai solo un modello in bundle locale, crea un annotatore dall'oggetto LocalModel:

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);

Se hai un modello ospitato in remoto, devi verificare che sia stato scaricato prima della sua esecuzione.

Anche se devi confermare questa operazione solo prima di eseguire l'etichettatore, se hai sia un modello ospitato in remoto sia un modello in bundle locale, potrebbe essere utile eseguire questo controllo durante l'istanza dell'etichettatore di immagini: crea un etichettatore dal modello remoto se è stato scaricato e dal modello locale in caso contrario.

Kotlin

val modelFile = File(context.cacheDir, "my_downloaded_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 options = CustomImageLabelerOptions.Builder(model)
    .setConfidenceThreshold(0.5f)
    .setMaxResultCount(5)
    .build()
val labeler = ImageLabeling.getClient(options)

Java

File modelFile = new File(context.getCacheDir(), "my_downloaded_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();
}
CustomImageLabelerOptions options = new CustomImageLabelerOptions.Builder(model)
    .setConfidenceThreshold(0.5f)
    .setMaxResultCount(5)
    .build();
ImageLabeler labeler = ImageLabeling.getClient(options);

Se hai solo un modello ospitato in remoto, devi disattivare la funzionalità correlata al modello, ad esempio disattivare o nascondere parte della tua UI, finché non confermi che il modello è stato scaricato.

Kotlin

val localFile = File(context.cacheDir, "my_remote_model.tflite")
if (localFile.exists()) {
    initializeLabeler(localFile)
} else {
    showLoadingUI()
    val storage = Firebase.storage
    val modelRef = storage.getReferenceFromUrl("gs://YOUR_BUCKET/path/to/model.tflite")
    modelRef.getFile(localFile)
        .addOnSuccessListener {
            hideLoadingUI()
            initializeLabeler(localFile)
        }
        .addOnFailureListener {
            showErrorUI()
        }
}

private fun initializeLabeler(modelFile: File) {
    val localModel = LocalModel.Builder().setAbsoluteFilePath(modelFile.absolutePath).build()
    val options = CustomImageLabelerOptions.Builder(localModel).build()
    val labeler = ImageLabeling.getClient(options)
    enableMLFeatures(labeler)
}

Java

File localFile = new File(context.getCacheDir(), "my_remote_model.tflite");
if (localFile.exists()) {
    initializeLabeler(localFile);
} else {
    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) {
                hideLoadingUI();
                initializeLabeler(localFile);
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception exception) {
                showErrorUI();
            }
        });
}

private void initializeLabeler(File modelFile) {
    LocalModel localModel = new LocalModel.Builder().setAbsoluteFilePath(modelFile.getAbsolutePath()).build();
    CustomImageLabelerOptions options = new CustomImageLabelerOptions.Builder(localModel).build();
    ImageLabeler labeler = ImageLabeling.getClient(options);
    enableMLFeatures(labeler);
}

2. Prepara l'immagine di input

Poi, per ogni immagine che vuoi etichettare, crea un oggetto InputImage dall'immagine. L'etichettatore di immagini funziona più velocemente quando utilizzi un Bitmap o, se utilizzi l'API camera2, un media.Image YUV_420_888, che sono consigliati quando possibile.

Puoi creare un oggetto InputImage da diverse origini, ognuna delle quali è spiegata di seguito.

Utilizzo di un media.Image

Per creare un oggetto InputImage da un oggetto media.Image, ad esempio quando acquisisci un'immagine dalla fotocamera di un dispositivo, passa l'oggetto media.Image e la rotazione dell'immagine a InputImage.fromMediaImage().

Se utilizzi la libreria CameraX, le classi OnImageCapturedListener e ImageAnalysis.Analyzer calcolano il valore di rotazione per te.

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
          // ...
        }
    }
}

Se non utilizzi una libreria di fotocamere che fornisce il grado di rotazione dell'immagine, puoi calcolarlo dal grado di rotazione del dispositivo e dall'orientamento del sensore della videocamera nel dispositivo:

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
}
MLKitVisionImage.kt

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

Poi, passa l'oggetto media.Image e il valore del grado di rotazione a InputImage.fromMediaImage():

Kotlin

val image = InputImage.fromMediaImage(mediaImage, rotation)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromMediaImage(mediaImage, rotation);

Utilizzo di un URI file

Per creare un oggetto InputImage da un URI file, passa il contesto dell'app e l'URI file a InputImage.fromFilePath(). Questa operazione è utile quando utilizzi un intent ACTION_GET_CONTENT per chiedere all'utente di selezionare un'immagine dalla sua app di galleria.

Kotlin

val image: InputImage
try {
    image = InputImage.fromFilePath(context, uri)
} catch (e: IOException) {
    e.printStackTrace()
}
MLKitVisionImage.kt

Java

InputImage image;
try {
    image = InputImage.fromFilePath(context, uri);
} catch (IOException e) {
    e.printStackTrace();
}

Utilizzo di ByteBuffer o ByteArray

Per creare un oggetto InputImage da un ByteBuffer o da un ByteArray, calcola prima il grado di rotazione dell'immagine come descritto in precedenza per l'input media.Image. Quindi, crea l'oggetto InputImage con il buffer o l'array, insieme all'altezza, alla larghezza, al formato di codifica del colore e al grado di rotazione dell'immagine:

Kotlin

val image = InputImage.fromByteBuffer(
        byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt
// Or:
val image = InputImage.fromByteArray(
        byteArray,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromByteBuffer(byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);
MLKitVisionImage.java
// Or:
InputImage image = InputImage.fromByteArray(
        byteArray,
        /* image width */480,
        /* image height */360,
        rotation,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);
MLKitVisionImage.java

Utilizzo di un Bitmap

Per creare un oggetto InputImage da un oggetto Bitmap, effettua la seguente dichiarazione:

Kotlin

val image = InputImage.fromBitmap(bitmap, 0)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
MLKitVisionImage.java

L'immagine è rappresentata da un oggetto Bitmap insieme ai gradi di rotazione.

3. Esegui lo strumento di etichettatura delle immagini

Per etichettare gli oggetti in un'immagine, passa l'oggetto image al metodo process() di ImageLabeler.

Kotlin

labeler.process(image)
        .addOnSuccessListener { labels ->
            // Task completed successfully
            // ...
        }
        .addOnFailureListener { e ->
            // Task failed with an exception
            // ...
        }
ImageLabelingActivity.kt

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
                // ...
            }
        });
ImageLabelingActivity.java

Nota: se utilizzi l'API CameraX, assicurati di chiudere ImageProxy al termine dell'utilizzo, ad esempio aggiungendo un OnCompleteListener a Task restituito dal metodo process. Per un esempio, consulta la classe VisionProcessorBase nell'app di esempio della guida rapida.

4. Ricevere informazioni sulle entità etichettate

Se l'operazione di etichettatura delle immagini va a buon fine, all'ascoltatore di esito positivo viene trasmesso un elenco di oggetti ImageLabel. Ogni oggetto ImageLabel rappresenta qualcosa che è stato etichettato nell'immagine. Puoi ottenere la descrizione testuale di ogni etichetta (se disponibile nei metadati del file del modello LiteRT), il punteggio di confidenza e l'indice. Ad esempio:

Kotlin

for (label in labels) {
    val text = label.text
    val confidence = label.confidence
    val index = label.index
}
ImageLabelingActivity.kt

Java

for (ImageLabel label : labels) {
    String text = label.getText();
    float confidence = label.getConfidence();
    int index = label.getIndex();
}
ImageLabelingActivity.java

Nota :se utilizzi un modello LiteRT incompatibile con ML Kit, riceverai un MlKitException con il codice di errore MlKitException#INVALID_ARGUMENT e alcuni dettagli sul motivo dell'incompatibilità. Per maggiori dettagli, consulta i Requisiti di compatibilità dei modelli personalizzati.

Suggerimenti per migliorare il rendimento in tempo reale

Se vuoi etichettare le immagini in un'applicazione in tempo reale, segui queste linee guida per ottenere i migliori frame rate:

• Se utilizzi l'API Camera o camera2, limita le chiamate al sistema di etichettatura delle immagini. Se un nuovo frame video diventa disponibile mentre è in esecuzione l'etichettatore di immagini, rilascia il frame. Per un esempio, consulta la classe VisionProcessorBase nell'app di esempio della guida rapida.
• Se utilizzi l'API CameraX, assicurati che la strategia di contropressione sia impostata sul valore predefinito ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST. In questo modo, viene garantita la consegna di una sola immagine alla volta per l'analisi. Se vengono prodotte più immagini quando l'analizzatore è occupato, queste verranno eliminate automaticamente e non verranno messe in coda per la consegna. Una volta chiusa l'immagine analizzata chiamando ImageProxy.close(), verrà inviata l'immagine più recente successiva.
• Se utilizzi l'output dell'etichettatore di immagini per sovrapporre elementi grafici all'immagine di input, recupera prima il risultato da ML Kit, poi esegui il rendering dell'immagine e la sovrapposizione in un unico passaggio. Il rendering viene eseguito sulla superficie di visualizzazione solo una volta per ogni frame di input. Per un esempio, consulta le classi CameraSourcePreview e GraphicOverlay nell'app di esempio di avvio rapido.
• Se utilizzi l'API Camera2, acquisisci immagini in formato ImageFormat.YUV_420_888. Se utilizzi l'API Camera precedente, acquisisci immagini in formato ImageFormat.NV21.