Пометка изображений с помощью модели, обученной AutoML на платформах Apple

После того, как вы дрессировать свою собственную модель с помощью AutoML видения Грани , вы можете использовать его в приложении к изображениям этикетки.

Есть два способа интегрировать модели, обученные в AutoML Vision Edge. Вы можете связать модель, скопировав файлы модели в свой проект Xcode, или вы можете динамически загрузить ее из Firebase.

Варианты комплектации модели
В вашем приложении
  • Модель входит в комплект
  • Модель доступна сразу, даже если устройство Apple отключено.
  • Нет необходимости в проекте Firebase
Размещено на Firebase
  • Хост модель, загрузив его в Firebase Machine Learning
  • Уменьшает размер пакета приложений
  • Модель скачивается по запросу
  • Отправляйте обновления модели без повторной публикации вашего приложения
  • Easy A / B тестирование с Firebase Remote Config
  • Требуется проект Firebase

Прежде чем вы начнете

  1. Включите библиотеки ML Kit в свой подфайл:

    Чтобы связать модель с вашим приложением:

    pod 'GoogleMLKit/ImageLabelingCustom'
    

    Для динамически загружать модели из Firebase, добавьте LinkFirebase зависимость:

    pod 'GoogleMLKit/ImageLabelingCustom'
    pod 'GoogleMLKit/LinkFirebase'
    
  2. После установки или обновления Бобы вашего проекта, откройте свой проект Xcode , используя его .xcworkspace . ML Kit поддерживается в Xcode версии 12.2 или выше.

  3. Если вы хотите , чтобы загрузить модель, убедитесь , что вы добавить Firebase в свой Android проекта , если вы еще не сделали этого. При комплектации модели этого не требуется.

1. Загрузите модель.

Настроить источник локальной модели

Чтобы связать модель с вашим приложением:

  1. Извлеките модель и ее метаданные из zip-архива, который вы скачали из консоли Firebase, в папку:

    your_model_directory
      |____dict.txt
      |____manifest.json
      |____model.tflite
    

    Все три файла должны находиться в одной папке. Мы рекомендуем использовать файлы в том виде, в котором они были загружены, без изменений (включая имена файлов).

  2. Скопируйте папку в свой проект Xcode, заботясь , чтобы выбрать Создать папку ссылки , когда вы делаете это. Файл модели и метаданные будут включены в комплект приложения и доступны для ML Kit.

  3. Создание LocalModel объекта, указав путь к файлу модели манифеста:

    Быстрый

    guard let manifestPath = Bundle.main.path(
        forResource: "manifest",
        ofType: "json",
        inDirectory: "your_model_directory"
    ) else { return true }
    let localModel = LocalModel(manifestPath: manifestPath)
    

    Цель-C

    NSString *manifestPath =
        [NSBundle.mainBundle pathForResource:@"manifest"
                                      ofType:@"json"
                                 inDirectory:@"your_model_directory"];
    MLKLocalModel *localModel =
        [[MLKLocalModel alloc] initWithManifestPath:manifestPath];
    

Настройте источник модели, размещенный в Firebase

Для того, чтобы использовать дистанционно размещаемую модель, создать CustomRemoteModel объект, указав имя присвоенного модель , когда вы опубликовали его:

Быстрый

// Initialize the model source with the name you assigned in
// the Firebase console.
let remoteModelSource = FirebaseModelSource(name: "your_remote_model")
let remoteModel = CustomRemoteModel(remoteModelSource: remoteModelSource)

Цель-C

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

Затем запустите задачу загрузки модели, указав условия, при которых вы хотите разрешить загрузку. Если модели нет на устройстве или доступна более новая версия модели, задача асинхронно загрузит модель из Firebase:

Быстрый

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

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

Цель-C

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

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

Многие приложения запускают задачу загрузки в своем коде инициализации, но вы можете сделать это в любой момент, прежде чем вам понадобится использовать модель.

Создайте этикетировщик изображения на основе вашей модели

После настройки источников модели, создать ImageLabeler объект из одного из них.

Если у вас есть только локально комплектация модели, просто создать этикетировочный из вашего LocalModel объекта и настроить порог доверия оценки вы хотите требовать (см Оценивать вашу модель ):

Быстрый

let options = CustomImageLabelerOptions(localModel: localModel)
options.confidenceThreshold = NSNumber(value: 0.0)  // Evaluate your model in the Cloud console
                                                    // to determine an appropriate value.
let imageLabeler = ImageLabeler.imageLabeler(options)

Цель-C

CustomImageLabelerOptions *options =
    [[CustomImageLabelerOptions alloc] initWithLocalModel:localModel];
options.confidenceThreshold = @(0.0f);  // Evaluate your model in the Cloud console
                                        // to determine an appropriate value.
MLKImageLabeler *imageLabeler =
    [MLKImageLabeler imageLabelerWithOptions:options];

Если у вас есть удаленно размещенная модель, вам нужно будет убедиться, что она была загружена, прежде чем запускать ее. Вы можете проверить состояние задачи модели загрузки с использованием модели менеджера isModelDownloaded(remoteModel:) метода.

Хотя у вас есть только подтвердить это перед запуском этикетировочного, если у вас есть и удаленно размещаемые модели и локально комплектация модели, возможно , имеет смысл выполнять эту проверку при инстанцировании ImageLabeler : создать этикетировочный от удаленной модели , если это был загружен, а в противном случае - из локальной модели.

Быстрый

var options: CustomImageLabelerOptions
if (ModelManager.modelManager().isModelDownloaded(remoteModel)) {
  options = CustomImageLabelerOptions(remoteModel: remoteModel)
} else {
  options = CustomImageLabelerOptions(localModel: localModel)
}
options.confidenceThreshold = NSNumber(value: 0.0)  // Evaluate your model in the Firebase console
                                                    // to determine an appropriate value.
let imageLabeler = ImageLabeler.imageLabeler(options: options)

Цель-C

MLKCustomImageLabelerOptions *options;
if ([[MLKModelManager modelManager] isModelDownloaded:remoteModel]) {
  options = [[MLKCustomImageLabelerOptions alloc] initWithRemoteModel:remoteModel];
} else {
  options = [[MLKCustomImageLabelerOptions alloc] initWithLocalModel:localModel];
}
options.confidenceThreshold = @(0.0f);  // Evaluate your model in the Firebase console
                                        // to determine an appropriate value.
MLKImageLabeler *imageLabeler =
    [MLKImageLabeler imageLabelerWithOptions:options];

Если у вас есть только модель, размещенная на удалении, вам следует отключить связанные с моделью функции - например, выделение серым цветом или скрытие части пользовательского интерфейса - до тех пор, пока вы не подтвердите, что модель была загружена.

Вы можете получить статус загрузки модели, подключив наблюдателей к Центру уведомлений по умолчанию. Обязательно используйте слабую ссылку на self в блоке наблюдателя, так как загрузка может занять некоторое время, и объект происходящего может быть освобожден от времени загрузку заканчиваются. Например:

Быстрый

NotificationCenter.default.addObserver(
    forName: .mlkitMLModelDownloadDidSucceed,
    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: .mlkitMLModelDownloadDidFail,
    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]
    // ...
}

Цель-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];
            }];

2. Подготовьте входное изображение.

Создание VisionImage объекта с использованием UIImage или CMSampleBufferRef .

Если вы используете UIImage , выполните следующие действия:

  • Создать VisionImage объект с UIImage . Убедитесь в том , чтобы указать правильный .orientation .

    Быстрый

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

    Цель-C

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

Если вы используете CMSampleBufferRef , выполните следующие действия:

  • Указать ориентацию данных изображения , содержащихся в CMSampleBufferRef буфере.

    Чтобы получить ориентацию изображения:

    Быстрый

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

    Цель-C

    - (UIImageOrientation)
      imageOrientationFromDeviceOrientation:(UIDeviceOrientation)deviceOrientation
                             cameraPosition:(AVCaptureDevicePosition)cameraPosition {
      switch (deviceOrientation) {
        case UIDeviceOrientationPortrait:
          return position == AVCaptureDevicePositionFront ? UIImageOrientationLeftMirrored
                                                          : UIImageOrientationRight;
    
        case UIDeviceOrientationLandscapeLeft:
          return position == AVCaptureDevicePositionFront ? UIImageOrientationDownMirrored
                                                          : UIImageOrientationUp;
        case UIDeviceOrientationPortraitUpsideDown:
          return position == AVCaptureDevicePositionFront ? UIImageOrientationRightMirrored
                                                          : UIImageOrientationLeft;
        case UIDeviceOrientationLandscapeRight:
          return position == AVCaptureDevicePositionFront ? UIImageOrientationUpMirrored
                                                          : UIImageOrientationDown;
        case UIDeviceOrientationUnknown:
        case UIDeviceOrientationFaceUp:
        case UIDeviceOrientationFaceDown:
          return UIImageOrientationUp;
      }
    }
          
  • Создание VisionImage объекта с помощью CMSampleBufferRef объекта и ориентации:

    Быстрый

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

    Цель-C

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

3. Запустите средство создания этикеток для изображений.

Асинхронно:

Быстрый

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

Цель-C

[imageLabeler
    processImage:image
      completion:^(NSArray<MLKImageLabel *> *_Nullable labels,
                   NSError *_Nullable error) {
        if (label.count == 0) {
            // Handle the error.
            return;
        }
        // Show results.
     }];

Синхронно:

Быстрый

var labels: [ImageLabel]
do {
    labels = try imageLabeler.results(in: image)
} catch let error {
    // Handle the error.
    return
}
// Show results.

Цель-C

NSError *error;
NSArray<MLKImageLabel *> *labels =
    [imageLabeler resultsInImage:image error:&error];
// Show results or handle the error.

4. Получите информацию о помеченных объектах.

Если операция маркировки изображения успешно, она возвращает массив ImageLabel . Каждый ImageLabel представляет собой нечто , что метили в изображении. Вы можете получить текстовое описание каждой метки (если доступно в метаданных файла модели TensorFlow Lite), оценку достоверности и индекс. Например:

Быстрый

for label in labels {
  let labelText = label.text
  let confidence = label.confidence
  let index = label.index
}

Цель-C

for (MLKImageLabel *label in labels) {
  NSString *labelText = label.text;
  float confidence = label.confidence;
  NSInteger index = label.index;
}

Советы по повышению производительности в реальном времени

Если вы хотите маркировать изображения в приложении реального времени, следуйте этим рекомендациям для достижения наилучшей частоты кадров:

  • Дроссельные вызовы детектора. Если новый видеокадр становится доступным во время работы детектора, опустите кадр.
  • Если вы используете выход детектора для наложения графики на входное изображение, сначала получите результат, а затем визуализируйте изображение и наложение за один шаг. Таким образом вы визуализируете поверхность отображения только один раз для каждого входного кадра. См previewOverlayView и FIRDetectionOverlayView классов в примере приложении витрины для примера.