iOS에서 커스텀 분류 모델을 사용하여 객체 감지, 추적, 분류

ML Kit를 사용하여 연속된 동영상 프레임에서 객체를 감지하고 추적할 수 있습니다.

이미지를 ML Kit에 전달하면 이미지에서 최대 5개의 객체와 이미지 내 각 객체의 위치가 감지됩니다. 동영상 스트림에서 감지된 객체에 부여된 고유 ID를 사용하면 프레임 간에 객체를 추적할 수 있습니다.

맞춤 이미지 분류 모델을 사용하여 감지된 객체를 분류할 수 있습니다. 모델 호환성 요구사항, 사전 학습된 모델을 찾을 수 있는 위치, 자체 모델을 학습시키는 방법에 관한 안내는 ML Kit을 사용한 맞춤 모델을 참고하세요.

커스텀 모델을 통합하는 방법에는 두 가지가 있습니다. 앱의 애셋 폴더에 모델을 저장하여 번들로 묶거나 Cloud Storage에서 동적으로 다운로드하는 것입니다. 다음 표에서는 두 옵션을 비교합니다.

번들 모델 호스팅된 모델
모델이 앱의 .ipa 파일에 포함되어 크기가 증가합니다. 모델이 앱의 .ipa 파일에 포함되지 않습니다. Cloud Storage에 업로드하여 호스팅됩니다. Firebase용 Cloud Storage를 사용하는 것이 좋습니다.
Android 기기가 오프라인 상태일 때도 모델을 즉시 사용할 수 있음 앱에는 필요에 따라 모델을 다운로드하는 코드가 포함되어야 합니다.
Firebase 프로젝트가 필요 없음 Firebase 프로젝트가 필요합니다 (Firebase용 Cloud Storage를 사용하는 경우).
모델을 업데이트하려면 앱을 다시 게시해야 합니다. 앱을 다시 게시하지 않고 모델 업데이트 푸시
기본 제공 A/B 테스트 없음 Firebase 원격 구성을 사용한 A/B 테스트

사용해 보기

시작하기 전에

  1. Podfile에 ML Kit 라이브러리를 포함합니다.

    pod 'GoogleMLKit/ObjectDetectionCustom', '8.0.0'
    
  2. 프로젝트의 pod를 설치하거나 업데이트한 후 .xcworkspace를 사용하여 Xcode 프로젝트를 엽니다. ML Kit는 Xcode 13.2.1 이상 버전에서 지원됩니다.

  3. Firebase용 Cloud Storage를 사용하여 모델을 다운로드하려면 iOS 프로젝트에 Firebase를 추가해야 합니다(아직 추가하지 않은 경우). 모델을 번들로 묶을 때는 이 작업이 필요하지 않습니다.

1. 모델 로드

로컬 모델 소스 구성

모델을 앱과 함께 번들로 묶으려면 다음 단계를 따르세요.

  1. 모델 파일 (일반적으로 .tflite 또는 .lite로 끝남)을 Xcode 프로젝트에 복사합니다. 이때 Copy bundle resources를 선택해야 합니다. 모델 파일이 App Bundle에 포함되며 ML Kit에서 사용할 수 있습니다.

  2. 모델 파일의 경로를 지정하여 LocalModel 객체를 만듭니다.

    Swift

    let localModel = LocalModel(path: localModelFilePath)

    Objective-C

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

원격으로 호스팅된 모델 소스 구성

원격으로 호스팅된 모델을 사용하려면 자체 앱 로직을 사용하여 모델 파일을 기기의 로컬 저장소에 다운로드한 다음 로컬 모델로 로드해야 합니다. Firebase용 Cloud Storage를 사용하여 모델을 호스팅하는 것이 좋습니다. 구현에 관한 자세한 내용은 Firebase ML에서 Cloud Storage로의 이전 가이드를 참고하세요.

2. 객체 감지기 구성

모델 소스를 구성한 후 CustomObjectDetectorOptions 객체를 사용하여 사용 사례에 대한 객체 감지기를 구성합니다. 다음 설정을 변경할 수 있습니다.

객체 감지기 설정
감지 모드 STREAM_MODE (기본값) | SINGLE_IMAGE_MODE

STREAM_MODE(기본값)에서는 객체 감지기가 짧은 지연 시간으로 실행되지만, 감지기를 처음 몇 번 호출할 때 경계 상자 또는 카테고리 라벨이 지정되지 않는 등 불완전한 결과가 나올 수 있습니다. 또한 STREAM_MODE에서는 감지기가 객체에 추적 ID를 할당하며, 이 ID를 사용하여 여러 프레임 간에 객체를 추적할 수 있습니다. 객체를 추적하려는 경우나 실시간 동영상 스트림 처리와 같이 짧은 지연 시간이 중요한 경우에 이 모드를 사용하세요.

SINGLE_IMAGE_MODE에서는 객체의 경계 상자가 결정된 후 객체 감지기가 결과를 반환합니다. 분류도 사용 설정하면 경계 상자와 카테고리 라벨이 모두 사용 가능해진 후에 결과를 반환합니다. 따라서 감지 지연 시간이 길어질 가능성이 있습니다. 또한 SINGLE_IMAGE_MODE에서는 추적 ID가 할당되지 않습니다. 지연 시간이 중요하지 않으며 부분적인 결과를 처리하지 않으려는 경우에 이 모드를 사용하세요.

여러 객체 감지 및 추적 false (기본값) | true

감지 및 추적 대상을 최대 5개의 객체로 할지 아니면 가장 명백한 객체 (기본값)로 할지 여부입니다.

객체 분류 false (기본값) | true

제공된 맞춤 분류기 모델을 사용하여 감지된 객체를 분류할지 여부입니다. 맞춤 분류 모델을 사용하려면 이 값을 true로 설정해야 합니다.

분류 신뢰도 기준

감지된 라벨의 최소 신뢰도 점수입니다. 설정하지 않으면 모델의 메타데이터에 지정된 분류기 기준이 사용됩니다. 모델에 메타데이터가 없거나 메타데이터에 분류자 임계값이 지정되어 있지 않으면 기본 임계값 0.0이 사용됩니다.

객체당 최대 라벨 수

감지기가 반환할 객체당 최대 라벨 수입니다. 설정하지 않으면 기본값 10이 사용됩니다.

로컬로 번들된 모델만 있다면 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;

원격 호스팅 모델이 있다면 실행 전에 모델이 다운로드되었는지 확인해야 합니다.

객체 감지기를 실행하기 전에만 이를 확인하면 되지만 원격으로 호스팅된 모델과 로컬로 번들로 제공된 모델이 모두 있는 경우 ObjectDetector를 인스턴스화할 때 이 검사를 실행하는 것이 좋습니다. 원격 모델이 다운로드된 경우 원격 모델에서 감지기를 만들고 그렇지 않은 경우 로컬 모델에서 감지기를 만드세요.

Swift

// Path where your download logic saves the model
let documentDirectory = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
let localModelURL = documentDirectory.appendingPathComponent("my_remote_model.tflite")

let model: LocalModel
if FileManager.default.fileExists(atPath: localModelURL.path) {
  // Use the downloaded model
  model = LocalModel(path: localModelURL.path)
} else {
  // Fall back to bundled model
  guard let bundledModelPath = Bundle.main.path(forResource: "model", ofType: "tflite") else { return }
  model = LocalModel(path: bundledModelPath)
}

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

Objective-C

NSString *documentsDirectory = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
NSString *localModelPath = [documentsDirectory stringByAppendingPathComponent:@"my_remote_model.tflite"];

MLKLocalModel *model;
if ([NSFileManager.defaultManager fileExistsAtPath:localModelPath]) {
  // Use the downloaded model
  model = [[MLKLocalModel alloc] initWithPath:localModelPath];
} else {
  // Fall back to bundled model
  NSString *bundledModelPath = [NSBundle.mainBundle pathForResource:@"model" ofType:@"tflite"];
  model = [[MLKLocalModel alloc] initWithPath:bundledModelPath];
}

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

원격 호스팅 모델만 있다면 모델 다운로드 여부가 확인될 때까지 모델 관련 기능 사용을 중지해야 합니다(예: UI 비활성화 또는 숨김).

Swift

let documentDirectory = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
let localModelURL = documentDirectory.appendingPathComponent("my_remote_model.tflite")
if FileManager.default.fileExists(atPath: localModelURL.path) {
  // Model is already cached, initialize immediately
  self.initializeDetector(with: localModelURL)
} else {
  // Model is not yet available, show loading UI and start download
  self.showLoadingUI()
  let storage = Storage.storage()
  let modelRef = storage.reference(forURL: "gs://YOUR_BUCKET/path/to/model.tflite")
  modelRef.write(toFile: localModelURL) { url, error in
    self.hideLoadingUI()
    if let error = error {
      // Handle download error
      self.showErrorUI()
    } else if let modelURL = url {
      // Download success, initialize detector
      self.initializeDetector(with: modelURL)
    }
  }
}

func initializeDetector(with modelURL: URL) {
  let localModel = LocalModel(path: modelURL.path)
  let options = CustomObjectDetectorOptions(localModel: localModel)
  options.detectorMode = .singleImage
  options.shouldEnableClassification = true
  options.shouldEnableMultipleObjects = true
  self.objectDetector = ObjectDetector.objectDetector(options: options)
  // Enable ML features in UI
  self.enableMLFeatures()
}

Objective-C

NSString *documentsDirectory = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
NSString *localModelPath = [documentsDirectory stringByAppendingPathComponent:@"my_remote_model.tflite"];
NSURL *localModelURL = [NSURL fileURLWithPath:localModelPath];

if ([NSFileManager.defaultManager fileExistsAtPath:localModelPath]) {
  // Model is already cached, initialize immediately
  [self initializeDetectorWithURL:localModelURL];
} else {
  // Model is not yet available, show loading UI and start download
  [self showLoadingUI];

  FIRStorage *storage = [FIRStorage storage];
  FIRStorageReference *modelRef = [storage referenceForURL:@"gs://YOUR_BUCKET/path/to/model.tflite"];

  [modelRef writeToFile:localModelURL
             completion:^(NSURL * _Nullable URL, NSError * _Nullable error) {
               [self hideLoadingUI];
               if (error != nil) {
                 // Handle download error
                 [self showErrorUI];
               } else {
                 // Download success, initialize detector
                 [self initializeDetectorWithURL:URL];
               }
             }];
}

- (void)initializeDetectorWithURL:(NSURL *)modelURL {
  MLKLocalModel *localModel = [[MLKLocalModel alloc] initWithPath:modelURL.path];
  MLKCustomObjectDetectorOptions *options = [[MLKCustomObjectDetectorOptions alloc] initWithLocalModel:localModel];
  options.detectorMode = MLKObjectDetectorModeSingleImage;
  options.shouldEnableClassification = YES;
  options.shouldEnableMultipleObjects = YES;
  self.objectDetector = [MLKObjectDetector objectDetectorWithOptions:options];

  // Enable ML features in UI
  [self enableMLFeatures];
}

객체 감지 및 추적 API는 다음과 같은 2가지 주요 사용 사례에 최적화되어 있습니다.

  • 카메라 뷰파인더에서 가장 뚜렷한 객체의 실시간 감지 및 추적
  • 정적 이미지에서 여러 객체를 감지합니다.

이러한 사용 사례에 대한 API를 구성하려면 다음을 실행합니다.

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. 입력 이미지 준비

UIImage 또는 CMSampleBuffer를 사용하여 VisionImage 객체를 만듭니다.

UIImage를 사용하는 경우 다음 단계를 따르세요.

  • UIImageVisionImage 객체를 만듭니다. 올바른 .orientation을 지정해야 합니다.

    Swift

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

    Objective-C

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

CMSampleBuffer를 사용하는 경우 다음 단계를 따르세요.

  • CMSampleBuffer에 포함된 이미지 데이터의 방향을 지정합니다.

    이미지 방향을 가져오는 방법은 다음과 같습니다.

    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;
      }
    }
          
  • CMSampleBuffer 객체와 방향을 사용하여 VisionImage 객체를 만듭니다.

    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. 객체 감지기 만들고 실행

  1. 새 객체 감지기를 만듭니다.

    Swift

    let objectDetector = ObjectDetector.objectDetector(options: options)

    Objective-C

    MLKObjectDetector *objectDetector = [MLKObjectDetector objectDetectorWithOptions:options];
  2. 그런 다음 감지기를 사용합니다.

    비동기식으로:

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

    동기식으로:

    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. 라벨이 지정된 객체 정보 가져오기

이미지 프로세서 호출이 성공하면 비동기 메서드를 호출했는지 아니면 동기 메서드를 호출했는지 여부에 따라 완료 핸들러에 Object의 목록이 전달되거나 목록이 반환됩니다.

Object에는 다음 속성이 포함됩니다.

frame 이미지에서 객체의 위치를 나타내는 CGRect입니다.
trackingID 여러 이미지 간에 객체를 식별하는 정수입니다. SINGLE_IMAGE_MODE에서는 `nil` 입니다.
labels
label.text 라벨의 텍스트 설명입니다. LiteRT 모델의 메타데이터에 라벨 설명이 포함된 경우에만 반환됩니다.
label.index 분류기에서 지원하는 모든 라벨 중 라벨의 색인입니다.
label.confidence 객체 분류의 신뢰값입니다.

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

우수한 사용자 환경 보장

최상의 사용자 환경을 위해 앱에서 다음 가이드라인을 따르세요.

  • 객체 감지 성공 여부는 객체의 시각적 복잡성에 따라 달라집니다. 시각적 특징 수가 적은 객체는 감지되려면 이미지의 더 많은 부분을 차지해야 할 수도 있습니다. 감지할 객체 종류에 효과적인 입력을 캡처할 수 있도록 돕는 안내를 사용자에게 제공해야 합니다.
  • 분류를 사용할 때 지원되는 카테고리로 확실하게 분류되지 않는 객체를 감지하려면 알 수 없는 객체에 대한 특별한 처리를 구현합니다.

ML Kit Material Design 쇼케이스 앱 및 Material Design의 머신러닝 기반 기능 패턴 모음도 참조하세요.

성능 개선

실시간 애플리케이션에서 객체 감지를 사용하려는 경우 최상의 프레임 속도를 얻으려면 다음 안내를 따르세요.

  • 실시간 애플리케이션에서 스트리밍 모드를 사용하는 경우 대부분의 기기에서 적절한 프레임 속도를 생성할 수 없으므로 여러 객체 감지를 사용하지 마세요.

  • 동영상 프레임을 처리하려면 감지기의 results(in:) 동기 API를 사용하세요. AVCaptureVideoDataOutputSampleBufferDelegate captureOutput(_, didOutput:from:) 함수에서 이 메서드를 호출하여 지정된 동영상 프레임에서 결과를 동기식으로 가져옵니다. AVCaptureVideoDataOutput alwaysDiscardsLateVideoFramestrue로 유지하여 감지기 호출을 제한합니다. 인식기가 실행 중일 때 새 동영상 프레임이 제공되면 삭제됩니다.
  • 인식기 출력을 사용해서 입력 이미지에서 그래픽을 오버레이하는 경우 먼저 ML Kit에서 결과를 가져온 후 이미지를 렌더링하고 단일 단계로 오버레이합니다. 이렇게 하면 처리된 입력 프레임별로 한 번만 디스플레이 표면에 렌더링됩니다. 예시는 ML Kit 빠른 시작 샘플의 updatePreviewOverlayViewWithLastFrame을 참고하세요.