iOS용 텍스트 임베딩 가이드

텍스트 삽입기 태스크를 사용하면 텍스트 데이터의 숫자 표현을 만들어 시맨틱 의미를 포착할 수 있습니다. 이 안내에서는 iOS 앱에서 텍스트 임베딩을 사용하는 방법을 보여줍니다.

이 작업의 실제 동작을 확인하려면 웹 데모를 참고하세요. 이 작업의 기능, 모델, 구성 옵션에 대한 자세한 내용은 개요를 참조하세요.

코드 예

텍스트 삽입 도구의 예시 코드는 이 작업을 통합하는 iOS용 앱의 기본 구현을 제공합니다. 이 예에서는 두 텍스트 간의 시맨틱 유사성을 평가하며 실제 iOS 기기 또는 iOS 시뮬레이터가 필요합니다.

이 앱을 자체 iOS 앱의 시작점으로 사용하거나 기존 앱을 수정할 때 참고할 수 있습니다. GitHub에서 텍스트 삽입 도구의 예시 코드를 참고하세요.

코드 다운로드

다음 안내에서는 git 명령줄 도구를 사용하여 예시 코드의 로컬 사본을 만드는 방법을 보여줍니다.

예시 코드를 다운로드하려면 다음 안내를 따르세요.

  1. 다음 명령어를 사용하여 git 저장소를 클론합니다.

    git clone https://github.com/google-ai-edge/mediapipe-samples
    
  2. 원하는 경우 텍스트 삽입 도구 예시 앱의 파일만 포함되도록 스파스 체크아웃을 사용하도록 git 인스턴스를 구성합니다.

    cd mediapipe
    git sparse-checkout init --cone
    git sparse-checkout set examples/text_embedder/ios/
    

예시 코드의 로컬 버전을 만든 후 MediaPipe 작업 라이브러리를 설치하고 Xcode를 사용하여 프로젝트를 열고 앱을 실행하면 됩니다. 자세한 내용은 iOS 설정 가이드를 참고하세요.

주요 구성요소

다음 파일에는 텍스트 삽입 예제 애플리케이션의 중요한 코드가 포함되어 있습니다.

설정

이 섹션에서는 Text Embedder를 사용하도록 개발 환경과 코드 프로젝트를 설정하는 주요 단계를 설명합니다. 플랫폼 버전 요구사항을 포함하여 MediaPipe 작업을 사용하기 위한 개발 환경 설정에 대한 일반적인 정보는 iOS 설정 가이드를 참조하세요.

종속 항목

텍스트 삽입 도구는 CocoaPods를 사용하여 설치해야 하는 MediaPipeTasksText 라이브러리를 사용합니다. 이 라이브러리는 Swift 및 Objective-C 앱과 호환되며 언어별 추가 설정이 필요하지 않습니다.

macOS에 CocoaPods를 설치하는 방법은 CocoaPods 설치 가이드를 참고하세요. 앱에 필요한 pod로 Podfile를 만드는 방법에 관한 안내는 CocoaPods 사용을 참고하세요.

다음 코드를 사용하여 PodfileMediaPipeTasksText 모듈을 추가합니다.

target 'MyTextEmbedderApp' do
  use_frameworks!
  pod 'MediaPipeTasksText'
end

앱에 단위 테스트 타겟이 포함된 경우 Podfile 설정에 관한 자세한 내용은 iOS용 설정 가이드를 참고하세요.

모델

MediaPipe 텍스트 임베더 태스크에는 이 태스크와 호환되는 학습된 모델이 필요합니다. 텍스트 임베더에 사용할 수 있는 학습된 모델에 관한 자세한 내용은 작업 개요 모델 섹션을 참고하세요.

모델을 선택하고 다운로드한 후 Xcode를 사용하여 프로젝트 디렉터리에 추가합니다. Xcode 프로젝트에 파일을 추가하는 방법은 Xcode 프로젝트에서 파일 및 폴더 관리를 참조하세요.

BaseOptions.modelAssetPath 속성을 사용하여 앱 번들의 모델 경로를 지정합니다. 코드 예는 다음 섹션을 참고하세요.

할 일 만들기

이니셜라이저 중 하나를 호출하여 텍스트 삽입 도구 태스크를 만들 수 있습니다. TextEmbedder(options:) 이니셜라이저는 구성 옵션의 값을 허용합니다.

맞춤설정된 구성 옵션으로 초기화된 Text Embedder가 필요하지 않으면 TextEmbedder(modelPath:) 이니셜라이저를 사용하여 기본 옵션으로 텍스트 임베딩을 만들 수 있습니다. 구성 옵션에 관한 자세한 내용은 구성 개요를 참고하세요.

다음 코드는 이 작업을 빌드하고 구성하는 방법을 보여줍니다.

Swift

import MediaPipeTasksText

let modelPath = Bundle.main.path(forResource: "model",
                                      ofType: "tflite")

let options = TextEmbedderOptions()
options.baseOptions.modelAssetPath = modelPath
options.quantize = true

let textEmbedder = try TextEmbedder(options: options)

Objective-C

@import MediaPipeTasksText;

NSString *modelPath = [[NSBundle mainBundle] pathForResource:@"model"
                                                      ofType:@"tflite"];

MPPTextEmbedderOptions *options = [[MPPTextEmbedderOptions alloc] init];
options.baseOptions.modelAssetPath = modelPath;
options.quantize = YES;

MPPTextEmbedder *textEmbedder =
      [[MPPTextEmbedder alloc] initWithOptions:options error:nil];

구성 옵션

이 작업에는 iOS 앱을 위한 다음과 같은 구성 옵션이 있습니다.

옵션 이름 설명 값 범위 기본값
l2_normalize 반환된 특성 벡터를 L2 norm으로 정규화할지 여부입니다. 모델에 아직 네이티브 L2_NORMALIZATION TFLite 연산자가 포함되어 있지 않은 경우에만 이 옵션을 사용하세요. 대부분의 경우 이미 이 연산자가 포함되어 있으므로 이 옵션 없이 TFLite 추론을 통해 L2 정규화가 이루어집니다. Boolean False
quantize 반환된 임베딩을 스칼라 정규화를 통해 바이트로 정규화해야 하는지 여부입니다. 임베딩은 단위 노름이라고 암시적으로 가정되므로 모든 측정기준의 값은 [-1.0, 1.0] 범위에 포함됩니다. 그렇지 않은 경우 l2_normalize 옵션을 사용하세요. Boolean False

작업 실행

입력 텍스트를 삽입하고 임베딩 벡터를 가져오려면 TextEmbedderembed(text:) 메서드를 사용하면 됩니다.

Swift

let result = try textEmbedder.embed(text: text)

Objective-C

MPPTextEmbedderResult *result = [textEmbedder embedText:text
                                                  error:nil];

참고: 태스크는 텍스트에 대한 추론 실행을 완료할 때까지 현재 스레드를 차단합니다. 현재 스레드가 차단되지 않도록 하려면 iOS Dispatch 또는 NSOperation 프레임워크를 사용하여 백그라운드 스레드에서 처리를 실행합니다. 앱이 Swift를 사용하여 만들어진 경우 백그라운드 스레드 실행에 Swift 동시 실행을 사용할 수도 있습니다.

예시 코드에서 embed(text:) 메서드는 TextEmbedderService.swift 파일에서 호출됩니다.

결과 처리 및 표시

추론을 실행하면 텍스트 임베더 태스크는 입력 텍스트의 임베딩 목록(부동 소수점 또는 스칼라 양자화)이 포함된 TextEmbedderResult 객체를 반환합니다.

다음은 이 태스크의 출력 데이터 예시입니다.

TextEmbedderResult:
  Embedding #0 (sole embedding head):
    float_embedding: {0.2345f, 0.1234f, ..., 0.6789f}
    head_index: 0

TextEmbedder.cosineSimilarity 메서드를 사용하여 두 임베딩의 시맨틱 유사성을 비교할 수 있습니다.

Swift

let similarity = try TextEmbedder.cosineSimilarity(
  embedding1: result.embeddingResult.embeddings[0],
  embedding2: otherResult.embeddingResult.embeddings[0])
    

Objective-C

NSNumber *similarity = [MPPTextEmbedder
      cosineSimilarityBetweenEmbedding1:result.embeddingResult.embeddings[0]
                          andEmbedding2:otherResult.embeddingResult.embeddings[0]
                                  error:nil];
    

예시 코드에서 TextEmbedder.cosineSimilarity 메서드는 TextEmbedderService.swift 파일에서 호출됩니다.