Detecta, haz un seguimiento y clasifica objetos con un modelo de clasificación personalizado en iOS

Puedes usar ML Kit para detectar objetos en fotogramas de video sucesivos y hacerles seguimiento.

Cuando pasas una imagen al Kit de AA, este detecta hasta cinco objetos en la imagen, junto con la posición de cada uno de ellos. Cuando se detectan objetos en transmisiones de video por Internet, cada objeto tiene un ID único que puedes usar para seguirlo de fotograma a fotograma.

Puedes usar un modelo de clasificación de imágenes personalizado para clasificar los objetos que se detectan. Consulta Modelos personalizados con el kit de AA 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.

Hay dos formas de integrar un modelo personalizado. Para empaquetar el modelo, puedes colocarlo dentro de la carpeta de elementos de tu app o descargarlo de forma dinámica desde Firebase. En la siguiente tabla, se comparan las dos opciones.

Modelo incluido Modelo alojado
El modelo es parte del archivo .ipa de tu app, que aumenta su tamaño. El modelo no forma parte del archivo .ipa de tu app. Se aloja mediante la carga del aprendizaje automático de Firebase.
El modelo está disponible de inmediato, incluso cuando el dispositivo Android está sin conexión El modelo se descarga a pedido
No se necesita un proyecto de Firebase Se requiere un proyecto de Firebase.
Debes volver a publicar tu app para actualizar el modelo El modelo de envío se actualiza sin volver a publicar la app
Sin pruebas A/B integradas Pruebas A/B sencillas con Firebase Remote Config

Probar

Antes de comenzar

  1. Incluye las bibliotecas del ML Kit en tu Podfile:

    Para empaquetar un modelo con tu app, sigue estos pasos:

    pod 'GoogleMLKit/ObjectDetectionCustom', '3.2.0'

    Para descargar un modelo de Firebase de forma dinámica, agrega la dependencia LinkFirebase:

    pod 'GoogleMLKit/ObjectDetectionCustom', '3.2.0'
pod 'GoogleMLKit/LinkFirebase', '3.2.0'

  2. Después de instalar o actualizar los Pods de tu proyecto, abre el proyecto de Xcode con su .xcworkspace. El Kit de AA es compatible con Xcode 13.2.1 o versiones posteriores.

  3. Si quieres descargar un modelo, asegúrate de agregar Firebase a tu proyecto de iOS, en caso de que aún no lo hayas hecho. Esto no es obligatorio cuando se empaqueta un modelo.

1. Carga el modelo

Configura una fuente de modelo local

Para empaquetar el modelo con tu app, haz lo siguiente:

  1. Copia el archivo del modelo (que suele terminar en .tflite o .lite) a tu proyecto de Xcode, con cuidado de seleccionar Copy bundle resources cuando lo hagas. El archivo del modelo se incluirá en el paquete de la aplicación y estará disponible para el ML Kit.

  2. Crea un objeto LocalModel y especifica la ruta al archivo del modelo:

    Swift

    let localModel = LocalModel(path: localModelFilePath)

    Objective‑C

    MLKLocalModel *localModel =
    [[MLKLocalModel alloc] initWithPath:localModelFilePath];

Configura una fuente de modelo alojada en Firebase

Para usar el modelo alojado de forma remota, crea un objeto CustomRemoteModel y especifica el nombre que le asignaste al modelo cuando lo publicaste:

Swift

let firebaseModelSource = FirebaseModelSource(
    name: "your_remote_model") // The name you assigned in
                               // the Firebase console.
let remoteModel = CustomRemoteModel(remoteModelSource: firebaseModelSource)

Objective‑C

MLKFirebaseModelSource *firebaseModelSource =
    [[MLKFirebaseModelSource alloc]
        initWithName:@"your_remote_model"]; // The name you assigned in
                                            // the Firebase console.
MLKCustomRemoteModel *remoteModel =
    [[MLKCustomRemoteModel alloc]
        initWithRemoteModelSource:firebaseModelSource];

Luego, inicia la tarea de descarga del modelo y especifica las condiciones en las que deseas permitir la descarga. Si el modelo no está en el dispositivo o si hay una versión más reciente de este, la tarea descargará el modelo de Firebase de forma asíncrona:

Swift

let downloadConditions = ModelDownloadConditions(
  allowsCellularAccess: true,
  allowsBackgroundDownloading: true
)

let downloadProgress = ModelManager.modelManager().download(
  remoteModel,
  conditions: downloadConditions
)

Objective‑C

MLKModelDownloadConditions *downloadConditions =
    [[MLKModelDownloadConditions alloc] initWithAllowsCellularAccess:YES
                                         allowsBackgroundDownloading:YES];

NSProgress *downloadProgress =
    [[MLKModelManager modelManager] downloadModel:remoteModel
                                       conditions:downloadConditions];

Muchas apps comienzan la tarea de descarga en su código de inicialización, pero puedes hacerlo en cualquier momento antes de usar el modelo.

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 las siguientes opciones de configuración:

Configuración del detector de objetos
Modo de detección STREAM_MODE (predeterminado) | SINGLE_IMAGE_MODE

En STREAM_MODE (predeterminado), el detector de objetos se ejecuta con latencia baja, pero puede generar resultados incompletos (como cuadros de límite o etiquetas de categoría no especificados) en las primeras invocaciones del detector. Además, en el STREAM_MODE, el detector asigna ID de seguimiento a los objetos, que puedes usar para hacer seguimiento de objetos en los marcos. Usa este modo cuando quieras hacer seguimiento de objetos o cuando la latencia baja es importante, como cuando procesas transmisiones de video en tiempo real.

En SINGLE_IMAGE_MODE, el detector de objetos muestra el resultado una vez que se determina el cuadro de límite del objeto. Si también habilitas la clasificación, se muestra el resultado después de que el cuadro de límite y la etiqueta de categoría estén disponibles. En consecuencia, la latencia de detección es potencialmente más alta. Además, en SINGLE_IMAGE_MODE, no se asignan ID de seguimiento. Usa este modo si la latencia no es crítica y no quieres lidiar con resultados parciales.
Detecta varios objetos y hazles seguimiento false (predeterminado) | true

Ya sea para detectar y hacer seguimiento de hasta cinco objetos o solo al más prominente (predeterminado).
Clasificar objetos false (predeterminado) | true

Indica si se deben clasificar los objetos detectados o no con el modelo de clasificación personalizado proporcionado. Para usar tu modelo de clasificación personalizado, debes configurarlo como true.

Umbral de confianza de la clasificación

Puntuación de confianza mínima de las etiquetas detectadas. Si no se configura, se usará cualquier umbral de clasificador especificado por los metadatos del modelo. Si el modelo no contiene metadatos o estos no especifican un umbral de clasificador, se usará un umbral predeterminado de 0.0.
Cantidad máxima de etiquetas por objeto

Cantidad máxima de etiquetas por objeto que mostrará el detector. Si no la estableces, se usará el valor predeterminado de 10.

Si solo tienes un modelo empaquetado localmente, crea un detector de objetos a partir del objeto LocalModel:

Swift

let options = CustomObjectDetectorOptions(localModel: localModel)
options.detectorMode = .singleImage
options.shouldEnableClassification = true
options.shouldEnableMultipleObjects = true
options.classificationConfidenceThreshold = NSNumber(value: 0.5)
options.maxPerObjectLabelCount = 3

Objective‑C

MLKCustomObjectDetectorOptions *options =
    [[MLKCustomObjectDetectorOptions alloc] initWithLocalModel:localModel];
options.detectorMode = MLKObjectDetectorModeSingleImage;
options.shouldEnableClassification = YES;
options.shouldEnableMultipleObjects = YES;
options.classificationConfidenceThreshold = @(0.5);
options.maxPerObjectLabelCount = 3;

Si tienes un modelo alojado de forma remota, comprueba si se descargó antes de ejecutarlo. Puedes verificar el estado de la tarea de descarga del modelo con el método isModelDownloaded(remoteModel:) del administrador del modelo.

Aunque solo tienes que confirmar esto antes de ejecutar el detector de objetos, si tienes un modelo alojado de forma remota y uno empaquetado localmente, tendría sentido realizar esta verificación cuando se crea una instancia de ObjectDetector: crea un detector desde el modelo remoto si se descargó o, en su defecto, desde el modelo local.

Swift

var options: CustomObjectDetectorOptions!
if (ModelManager.modelManager().isModelDownloaded(remoteModel)) {
  options = CustomObjectDetectorOptions(remoteModel: remoteModel)
} else {
  options = CustomObjectDetectorOptions(localModel: localModel)
}
options.detectorMode = .singleImage
options.shouldEnableClassification = true
options.shouldEnableMultipleObjects = true
options.classificationConfidenceThreshold = NSNumber(value: 0.5)
options.maxPerObjectLabelCount = 3

Objective‑C

MLKCustomObjectDetectorOptions *options;
if ([[MLKModelManager modelManager] isModelDownloaded:remoteModel]) {
  options = [[MLKCustomObjectDetectorOptions alloc] initWithRemoteModel:remoteModel];
} else {
  options = [[MLKCustomObjectDetectorOptions alloc] initWithLocalModel:localModel];
}
options.detectorMode = MLKObjectDetectorModeSingleImage;
options.shouldEnableClassification = YES;
options.shouldEnableMultipleObjects = YES;
options.classificationConfidenceThreshold = @(0.5);
options.maxPerObjectLabelCount = 3;

Si solo tienes un modelo alojado de forma remota, debes inhabilitar la funcionalidad relacionada con el modelo, por ejemplo, oculta o inhabilita parte de tu IU, hasta que confirmes que el modelo se descargó.

Puedes obtener el estado de descarga del modelo si adjuntas observadores al Centro de notificaciones predeterminado. Asegúrate de utilizar una referencia débil para self en el bloque de observador, ya que las descargas pueden demorar un tiempo y el objeto de origen se puede liberar antes de que finalice la descarga. Por ejemplo:

Swift

NotificationCenter.default.addObserver(
    forName: .mlkitModelDownloadDidSucceed,
    object: nil,
    queue: nil
) { [weak self] notification in
    guard let strongSelf = self,
        let userInfo = notification.userInfo,
        let model = userInfo[ModelDownloadUserInfoKey.remoteModel.rawValue]
            as? RemoteModel,
        model.name == "your_remote_model"
        else { return }
    // The model was downloaded and is available on the device
}

NotificationCenter.default.addObserver(
    forName: .mlkitModelDownloadDidFail,
    object: nil,
    queue: nil
) { [weak self] notification in
    guard let strongSelf = self,
        let userInfo = notification.userInfo,
        let model = userInfo[ModelDownloadUserInfoKey.remoteModel.rawValue]
            as? RemoteModel
        else { return }
    let error = userInfo[ModelDownloadUserInfoKey.error.rawValue]
    // ...
}

Objective‑C

__weak typeof(self) weakSelf = self;

[NSNotificationCenter.defaultCenter
    addObserverForName:MLKModelDownloadDidSucceedNotification
                object:nil
                 queue:nil
            usingBlock:^(NSNotification *_Nonnull note) {
              if (weakSelf == nil | note.userInfo == nil) {
                return;
              }
              __strong typeof(self) strongSelf = weakSelf;

              MLKRemoteModel *model = note.userInfo[MLKModelDownloadUserInfoKeyRemoteModel];
              if ([model.name isEqualToString:@"your_remote_model"]) {
                // The model was downloaded and is available on the device
              }
            }];

[NSNotificationCenter.defaultCenter
    addObserverForName:MLKModelDownloadDidFailNotification
                object:nil
                 queue:nil
            usingBlock:^(NSNotification *_Nonnull note) {
              if (weakSelf == nil | note.userInfo == nil) {
                return;
              }
              __strong typeof(self) strongSelf = weakSelf;

              NSError *error = note.userInfo[MLKModelDownloadUserInfoKeyError];
            }];

La API de detección y seguimiento de objetos está optimizada para los siguientes dos casos prácticos 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.

Si deseas configurar la API para estos casos de uso, haz lo siguiente:

Swift

// Live detection and tracking
let options = CustomObjectDetectorOptions(localModel: localModel)
options.shouldEnableClassification = true
options.maxPerObjectLabelCount = 3

// Multiple object detection in static images
let options = CustomObjectDetectorOptions(localModel: localModel)
options.detectorMode = .singleImage
options.shouldEnableMultipleObjects = true
options.shouldEnableClassification = true
options.maxPerObjectLabelCount = 3

Objective‑C

// Live detection and tracking
MLKCustomObjectDetectorOptions *options =
    [[MLKCustomObjectDetectorOptions alloc] initWithLocalModel:localModel];
options.shouldEnableClassification = YES;
options.maxPerObjectLabelCount = 3;

// Multiple object detection in static images
MLKCustomObjectDetectorOptions *options =
    [[MLKCustomObjectDetectorOptions alloc] initWithLocalModel:localModel];
options.detectorMode = MLKObjectDetectorModeSingleImage;
options.shouldEnableMultipleObjects = YES;
options.shouldEnableClassification = YES;
options.maxPerObjectLabelCount = 3;

3. Prepara la imagen de entrada

Crea un objeto VisionImage mediante una UIImage o CMSampleBuffer.

Si usas un UIImage, sigue estos pasos:

  • Crea un objeto VisionImage con la UIImage. Asegúrate de especificar el .orientation correcto.

    Swift

    let image = VisionImage(image: UIImage)
visionImage.orientation = image.imageOrientation

    Objective‑C

    MLKVisionImage *visionImage = [[MLKVisionImage alloc] initWithImage:image];
visionImage.orientation = image.imageOrientation;

Si usas un CMSampleBuffer, sigue estos pasos:

  • Especifica la orientación de los datos de imagen que contiene CMSampleBuffer.

    Para obtener la orientación de la imagen, haz lo siguiente:

    Swift

    func imageOrientation(
  deviceOrientation: UIDeviceOrientation,
  cameraPosition: AVCaptureDevice.Position
) -> UIImage.Orientation {
  switch deviceOrientation {
  case .portrait:
    return cameraPosition == .front ? .leftMirrored : .right
  case .landscapeLeft:
    return cameraPosition == .front ? .downMirrored : .up
  case .portraitUpsideDown:
    return cameraPosition == .front ? .rightMirrored : .left
  case .landscapeRight:
    return cameraPosition == .front ? .upMirrored : .down
  case .faceDown, .faceUp, .unknown:
    return .up
  }
}

    Objective‑C

    - (UIImageOrientation)
  imageOrientationFromDeviceOrientation:(UIDeviceOrientation)deviceOrientation
                         cameraPosition:(AVCaptureDevicePosition)cameraPosition {
  switch (deviceOrientation) {
    case UIDeviceOrientationPortrait:
      return cameraPosition == AVCaptureDevicePositionFront ? UIImageOrientationLeftMirrored
                                                            : UIImageOrientationRight;

    case UIDeviceOrientationLandscapeLeft:
      return cameraPosition == AVCaptureDevicePositionFront ? UIImageOrientationDownMirrored
                                                            : UIImageOrientationUp;
    case UIDeviceOrientationPortraitUpsideDown:
      return cameraPosition == AVCaptureDevicePositionFront ? UIImageOrientationRightMirrored
                                                            : UIImageOrientationLeft;
    case UIDeviceOrientationLandscapeRight:
      return cameraPosition == AVCaptureDevicePositionFront ? UIImageOrientationUpMirrored
                                                            : UIImageOrientationDown;
    case UIDeviceOrientationUnknown:
    case UIDeviceOrientationFaceUp:
    case UIDeviceOrientationFaceDown:
      return UIImageOrientationUp;
  }
}
  • Crea un objeto VisionImage con el objeto CMSampleBuffer y la orientación:

    Swift

    let image = VisionImage(buffer: sampleBuffer)
image.orientation = imageOrientation(
  deviceOrientation: UIDevice.current.orientation,
  cameraPosition: cameraPosition)

    Objective‑C

     MLKVisionImage *image = [[MLKVisionImage alloc] initWithBuffer:sampleBuffer];
 image.orientation =
   [self imageOrientationFromDeviceOrientation:UIDevice.currentDevice.orientation
                                cameraPosition:cameraPosition];

4. Crea y ejecuta el detector de objetos

  1. Crea un detector de objetos nuevo:

    Swift

    let objectDetector = ObjectDetector.objectDetector(options: options)

    Objective‑C

    MLKObjectDetector *objectDetector = [MLKObjectDetector objectDetectorWithOptions:options];

  2. Luego, usa el detector:

    De forma asíncrona:

    Swift

    objectDetector.process(image) { objects, error in
    guard error == nil, let objects = objects, !objects.isEmpty else {
        // Handle the error.
        return
    }
    // Show results.
}

    Objective‑C

    [objectDetector
    processImage:image
      completion:^(NSArray *_Nullable objects,
                   NSError *_Nullable error) {
        if (objects.count == 0) {
            // Handle the error.
            return;
        }
        // Show results.
     }];

    De forma síncrona:

    Swift

    var objects: [Object]
do {
    objects = try objectDetector.results(in: image)
} catch let error {
    // Handle the error.
    return
}
// Show results.

    Objective‑C

    NSError *error;
NSArray *objects =
    [objectDetector resultsInImage:image error:&error];
// Show results or handle the error.

5. Obtén información sobre los objetos etiquetados

Si la llamada al procesador de imágenes se ejecuta correctamente, este pasa una lista de Object al controlador de finalización o la muestra, dependiendo de si llamaste al método asíncrono o síncrono.

Cada Object contiene las siguientes propiedades:

frame Es un CGRect que indica la posición del objeto en la imagen.
trackingID Un número entero que identifica el objeto en las imágenes o "nil" en SINGLE_IMAGE_MODE.
labels
label.text La descripción de texto de la etiqueta. Solo se muestra si los metadatos del modelo de TensorFlow Lite contienen descripciones de etiquetas.
label.index Es el índice de la etiqueta entre todas las etiquetas compatibles con el clasificador.
label.confidence El valor de confianza de la clasificación del objeto.

Swift

// objects contains one item if multiple object detection wasn't enabled.
for object in objects {
  let frame = object.frame
  let trackingID = object.trackingID
  let description = object.labels.enumerated().map { (index, label) in
    "Label \(index): \(label.text), \(label.confidence), \(label.index)"
  }.joined(separator: "\n")
}

Objective‑C

// The list of detected objects contains one item if multiple object detection
// wasn't enabled.
for (MLKObject *object in objects) {
  CGRect frame = object.frame;
  NSNumber *trackingID = object.trackingID;
  for (MLKObjectLabel *label in object.labels) {
    NSString *labelString =
        [NSString stringWithFormat:@"%@, %f, %lu",
                                   label.text,
                                   label.confidence,
                                   (unsigned long)label.index];
  }
}

Garantizar una excelente experiencia del usuario

Para obtener la mejor experiencia del usuario, sigue estos lineamientos en tu app:

  • La detección correcta de objetos depende de la complejidad visual del objeto. Para poder detectarse, es posible que los objetos con una pequeña cantidad de características visuales deban ocupar una parte más grande de la imagen. Debes proporcionar a los usuarios orientación sobre cómo capturar entradas que funcionen bien con el tipo de objetos que deseas detectar.
  • Cuando usas la clasificación, si deseas detectar objetos que no se incluyen de forma clara en las categorías admitidas, implementa un manejo especial para objetos desconocidos.

Además, consulta la [app de muestra de Material Design del Kit de AA][showcase-link]{: .external } 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 uses la detección de varios objetos, ya que la mayoría de los dispositivos no podrán producir velocidades de fotogramas adecuadas.

  • Para procesar fotogramas de video, usa la API síncrona results(in:) del detector. Llama a este método desde la función captureOutput(_, didOutput:from:) de AVCaptureVideoDataOutputSampleBufferDelegate para obtener resultados de un fotograma de video determinado de manera síncrona. Mantén el alwaysDiscardsLateVideoFrames de AVCaptureVideoDataOutput como true para limitar las llamadas al detector. Si hay un fotograma de video nuevo disponible mientras se ejecuta el detector, se descartará.
  • Si usas la salida del detector para superponer gráficos en la imagen de entrada, primero obtén el resultado del ML Kit y, luego, procesa la imagen y la superposición en un solo paso. De esta manera, renderizas en la superficie de visualización solo una vez por cada fotograma de entrada procesado. Consulta updatePreviewOverlayViewWithLastFrame en la muestra de inicio rápido del Kit de AA para ver un ejemplo.