Cuando pasas una imagen al ML Kit, este detecta hasta cinco objetos en la imagen junto con la posición de cada objeto. Cuando detectas objetos en transmisiones de video por Internet, cada objeto tiene un ID único que puedes usar para hacerle seguimiento de fotograma en fotograma.
Puedes usar un modelo personalizado de clasificación de imágenes para clasificar los objetos que se detectan. Consulta Modelos personalizados con ML Kit para obtener orientación sobre los requisitos de compatibilidad de los modelos, dónde encontrar modelos previamente entrenados y cómo entrenar tus propios modelos.
Existen dos formas de integrar un modelo personalizado. Puedes empaquetar el modelo colocándolo dentro de la carpeta de recursos de tu app o descargándolo de forma dinámica desde Cloud Storage. En la siguiente tabla, se comparan las dos opciones.
| Modelo agrupado | Modelo alojado |
|---|---|
| El modelo es parte del APK de la app, lo que aumenta su tamaño. | El modelo no forma parte de tu APK. Se aloja subiéndolo a Cloud Storage. Te recomendamos que uses Cloud Storage para Firebase. |
| El modelo está disponible de inmediato, incluso cuando el dispositivo Android está sin conexión | Tu app debe incluir código para descargar el modelo a pedido |
| No se necesita un proyecto de Firebase | Se requiere un proyecto de Firebase (si se usa Cloud Storage para Firebase). |
| Debes volver a publicar tu app para actualizar el modelo | El modelo de envío se actualiza sin volver a publicar la app |
| No hay pruebas A/B integradas | Pruebas A/B con Firebase Remote Config |
Probar
- Consulta la app de inicio rápido de Vision para ver un ejemplo del uso del modelo incluido y la app de inicio rápido de AutoML para ver un ejemplo del uso del modelo alojado.
- Consulta la app de demostración de Material Design para ver una implementación de extremo a extremo de esta API.
Antes de comenzar
1. En tu archivobuild.gradle.kts a nivel de proyecto, asegúrate de incluir el repositorio Maven de Google en las secciones buildscript y allprojects.
Agrega las dependencias para las bibliotecas de Android de ML Kit al archivo Gradle a nivel de la app de tu módulo, que suele ser
app/build.gradle.kts:Para empaquetar un modelo con tu app, sigue estos pasos:
dependencies { // ... // Object detection & tracking feature with custom bundled model implementation("com.google.mlkit:object-detection-custom:17.0.2") }Si quieres descargar un modelo de Cloud Storage para Firebase, asegúrate de agregar Firebase a tu proyecto de Android, en caso de que aún no lo hayas hecho. Esto no es obligatorio cuando se agrupa un modelo.
1. Carga el modelo
Puedes cargar el modelo desde una fuente incluida de forma local o desde una fuente alojada de forma remota.
Configura una fuente de modelo local
Sigue estos pasos para empaquetar el modelo con tu app:
Copia el archivo del modelo (que generalmente termina en
.tfliteo.lite) en la carpetaassets/de tu app. (Es posible que primero debas crear la carpeta. Para ello, haz clic con el botón derecho en la carpetaapp/y, luego, en New > Folder > Assets Folder).Crea un objeto
LocalModely especifica la ruta de acceso al archivo del modelo: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();
Configura una fuente de modelo alojada de forma remota
Para usar el modelo alojado de forma remota, debes descargar el archivo del modelo en el almacenamiento local del dispositivo con la lógica de tu propia app y, luego, cargarlo como un modelo local. Te recomendamos que uses Cloud Storage para Firebase para alojar un modelo. Para obtener detalles de la implementación, consulta la guía de migración de Firebase ML a Cloud Storage.
2. Configura el detector de objetos
Después de configurar las fuentes de tu modelo, configura el detector de objetos para tu caso de uso con un objeto CustomObjectDetectorOptions. Puedes cambiar los siguientes parámetros de configuración:
| Configuración del detector de objetos | |
|---|---|
| Modo de detección | STREAM_MODE (predeterminado) | SINGLE_IMAGE_MODEEn el En |
| Detecta varios objetos y hazles seguimiento | false (predeterminado) | trueYa sea para detectar y hacer seguimiento de hasta cinco objetos o solo al más prominente (predeterminado). |
| Clasifica objetos | false (predeterminado) | trueIndica si se deben clasificar los objetos detectados con el modelo de clasificador personalizado proporcionado. Para usar tu modelo de clasificación personalizado, debes establecer este parámetro en |
| Umbral de confianza de la clasificación |
Es la puntuación de confianza mínima de las etiquetas detectadas. Si no se configura, se usará cualquier umbral del clasificador especificado por los metadatos del modelo. Si el modelo no contiene metadatos o estos no especifican un umbral del clasificador, se usará un umbral predeterminado de 0.0. |
| Cantidad máxima de etiquetas por objeto |
Es la cantidad máxima de etiquetas por objeto que devolverá el detector. Si no se establece, se usará el valor predeterminado de 10. |
La API de detección y seguimiento de objetos está optimizada para estos dos casos de uso principales:
- Detección y seguimiento en vivo del objeto más prominente en el visor de la cámara.
- La detección de múltiples objetos de una imagen estática.
Para configurar la API para estos casos de uso con un modelo incluido de forma local, haz lo siguiente:
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);
Si tienes un modelo alojado de forma remota, comprueba si se descargó antes de ejecutarlo.
Aunque solo debes confirmar esto antes de ejecutar el detector, si tienes un modelo alojado de forma remota y un modelo incluido de forma local, podría tener sentido realizar esta verificación cuando crees una instancia del detector de imágenes: crea un detector a partir del modelo remoto si se descargó y a partir del modelo local en caso contrario.
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);
Si solo tienes un modelo alojado de forma remota, debes inhabilitar la funcionalidad relacionada con el modelo, por ejemplo, ocultar o inhabilitar parte de tu IU, hasta que confirmes que el modelo se descargó.
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. Prepara la imagen de entrada
Crea un objetoInputImage a partir de tu imagen.
El detector de objetos se ejecuta directamente desde un Bitmap, un ByteBuffer de NV21 o un media.Image de YUV_420_888. Se recomienda construir un objeto InputImage a partir de esas fuentes si tienes acceso directo a una de ellas. Si construyes un objeto InputImage a partir de otras fuentes, nosotros nos encargaremos de la conversión de forma interna, pero podría ser menos eficiente.
Puedes crear un objeto InputImage a partir de diferentes fuentes, que se explican a continuación.
Usa un media.Image
Para crear un objeto InputImage a partir de un objeto media.Image, como cuando se captura una imagen con la cámara de un dispositivo, pasa el objeto media.Image y la rotación de la imagen a InputImage.fromMediaImage().
Si usas la biblioteca
CameraX, las clases OnImageCapturedListener y
ImageAnalysis.Analyzer calculan el valor de rotación
por ti.
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 // ... } } }
Si no usas una biblioteca de cámaras que te proporcione el grado de rotación de la imagen, puedes calcularlo a partir del grado de rotación del dispositivo y la orientación del sensor de la cámara en el 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 }
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; }
Luego, pasa el objeto media.Image y el valor de
grado de rotación a InputImage.fromMediaImage():
Kotlin
val image = InputImage.fromMediaImage(mediaImage, rotation)
Java
InputImage image = InputImage.fromMediaImage(mediaImage, rotation);
Usa un URI de archivo
Para crear un objeto InputImage a partir de un URI de archivo, pasa el contexto de la app y el URI del archivo a InputImage.fromFilePath(). Esto es útil cuando usas
un intent ACTION_GET_CONTENT para solicitarle al usuario que seleccione
una imagen de su app de galería.
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(); }
Usa ByteBuffer o ByteArray
Para crear un objeto InputImage a partir de un ByteBuffer o un ByteArray, primero calcula el grado de rotación de la imagen como se describió anteriormente para la entrada media.Image.
Luego, crea el objeto InputImage con el búfer o el array, junto con la altura,
el ancho, el formato de codificación de color y el grado de rotación de la imagen:
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 );
Usa un Bitmap
Para crear un objeto InputImage a partir de un objeto Bitmap, realiza la siguiente declaración:
Kotlin
val image = InputImage.fromBitmap(bitmap, 0)
Java
InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
La imagen está representada por un objeto Bitmap junto con los grados de rotación.
4. Ejecuta el detector de objetos
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. Obtén información sobre los objetos etiquetados
Si la llamada a process() se ejecuta correctamente, se pasará una lista de DetectedObject al objeto de escucha que detecta el resultado correcto.
Cada DetectedObject contiene las siguientes propiedades:
| Cuadro delimitador | Un Rect que indica la posición del objeto en la imagen. |
||||||
| ID de seguimiento | Es un número entero que identifica el objeto en las imágenes. Es nulo en SINGLE_IMAGE_MODE. | ||||||
| Etiquetas |
|
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(); } }
Garantiza una excelente experiencia del usuario
Para obtener la mejor experiencia del usuario, sigue estos lineamientos en tu app:
- La detección exitosa de objetos depende de la complejidad visual del objeto. Para que se detecten, es posible que los objetos con una pequeña cantidad de características visuales deban ocupar un espacio mayor en la imagen. Debes proporcionar a los usuarios una orientación sobre cómo capturar entradas que funcionen bien con el tipo de objetos que deseas detectar.
- Cuando uses la clasificación, si deseas detectar objetos que no se incluyen de forma clara en las categorías compatibles, implementa un manejo especial para objetos desconocidos.
Además, consulta la app de muestra de Material Design del ML Kit y la colección de patrones para las funciones con tecnología de aprendizaje automático de Material Design.
Cómo mejorar el rendimiento
Si quieres usar la detección de objetos en una aplicación en tiempo real, sigue estos lineamientos para lograr la mejor velocidad de fotogramas:Cuando uses el modo de transmisión en una aplicación en tiempo real, no utilices la detección de múltiples objetos, ya que la mayoría de los dispositivos no podrán producir fotogramas adecuados.
- Si usas las APIs de
Cameraocamera2, limita las llamadas al detector. Si hay un fotograma de video nuevo disponible mientras se ejecuta el detector, ignora ese fotograma. Consulta la claseVisionProcessorBaseen la app de ejemplo de la guía de inicio rápido para ver un ejemplo. - Si usas la API de
CameraX, asegúrate de que la estrategia de contrapresión esté establecida en su valor predeterminadoImageAnalysis.STRATEGY_KEEP_ONLY_LATEST. Esto garantiza que solo se entregará una imagen para el análisis a la vez. Si se producen más imágenes cuando el analizador está ocupado, se descartarán automáticamente y no se pondrán en cola para su entrega. Una vez que se cierra la imagen que se está analizando llamando a ImageProxy.close(), se entregará la siguiente imagen más reciente. - Si usas la salida del detector para superponer gráficos en la imagen de entrada, primero obtén el resultado de ML Kit y, luego, renderiza la imagen y la superposición en un solo paso. Esto renderiza la superficie de visualización solo una vez para cada fotograma de entrada. Consulta las clases
CameraSourcePreviewyGraphicOverlayen la app de ejemplo de inicio rápido para ver un ejemplo. - Si usas la API de Camera2, captura imágenes en formato
ImageFormat.YUV_420_888. Si usas la API de Camera más antigua, captura imágenes en formatoImageFormat.NV21.