Rotular imagens com um modelo treinado em AutoML no iOS

Depois de treinar seu próprio modelo usando o AutoML Vision Edge , você poderá usá-lo em seu aplicativo para rotular imagens.

Antes de você começar

  1. Se você ainda não adicionou o Firebase ao seu aplicativo, faça isso seguindo as etapas do guia de primeiros passos .
  2. Inclua as bibliotecas do ML Kit em seu Podfile:
    pod 'Firebase/MLVision', '6.25.0'
    pod 'Firebase/MLVisionAutoML', '6.25.0'
    
    Depois de instalar ou atualizar os pods do seu projeto, certifique-se de abrir seu projeto Xcode usando seu .xcworkspace .
  3. No seu aplicativo, importe o Firebase:
    import Firebase
    @import Firebase;

1. Carregue o modelo

O ML Kit executa seus modelos gerados pelo AutoML no dispositivo. No entanto, você pode configurar o kit de ML para carregar seu modelo remotamente do Firebase, do armazenamento local ou de ambos.

Ao hospedar o modelo no Firebase, você pode atualizá-lo sem lançar uma nova versão do aplicativo e pode usar a Configuração remota e o teste A/B para veicular dinamicamente diferentes modelos para diferentes conjuntos de usuários.

Se você optar por fornecer o modelo apenas hospedando-o no Firebase e não agrupá-lo ao seu aplicativo, poderá reduzir o tamanho inicial do download do seu aplicativo. Tenha em mente, porém, que se o modelo não estiver incluído no seu aplicativo, qualquer funcionalidade relacionada ao modelo não estará disponível até que seu aplicativo baixe o modelo pela primeira vez.

Ao agrupar seu modelo com seu aplicativo, você pode garantir que os recursos de ML do seu aplicativo ainda funcionem quando o modelo hospedado pelo Firebase não estiver disponível.

Configurar uma origem de modelo hospedado no Firebase

Para usar o modelo hospedado remotamente, crie um objeto AutoMLRemoteModel especificando o nome que você atribuiu ao modelo quando o publicou:

let remoteModel = AutoMLRemoteModel(
    name
: "your_remote_model"  // The name you assigned in the Firebase console.
)
FIRAutoMLRemoteModel *remoteModel = [[FIRAutoMLRemoteModel alloc]
    initWithName
:@"your_remote_model"];  // The name you assigned in the Firebase console.

Em seguida, inicie a tarefa de download do modelo, especificando as condições sob as quais deseja permitir o download. Se o modelo não estiver no dispositivo ou se uma versão mais recente do modelo estiver disponível, a tarefa fará o download assíncrono do modelo do Firebase:

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

let downloadProgress = ModelManager.modelManager().download(
  remoteModel
,
  conditions
: downloadConditions
)
FIRModelDownloadConditions *downloadConditions =
   
[[FIRModelDownloadConditions alloc] initWithAllowsCellularAccess:YES
                                         allowsBackgroundDownloading
:YES];

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

Muitos aplicativos iniciam a tarefa de download em seu código de inicialização, mas você pode fazer isso a qualquer momento antes de usar o modelo.

Configurar uma origem de modelo local

Para agrupar o modelo com seu aplicativo:

  1. Extraia o modelo e seus metadados do arquivo zip que você baixou do console do Firebase para uma pasta:
    your_model_directory
      |____dict.txt
      |____manifest.json
      |____model.tflite
    
    Todos os três arquivos devem estar na mesma pasta. Recomendamos que você use os arquivos conforme os baixou, sem modificação (incluindo os nomes dos arquivos).
  2. Copie a pasta para o seu projeto Xcode, tomando cuidado para selecionar Criar referências de pasta ao fazer isso. O arquivo de modelo e os metadados serão incluídos no pacote de aplicativos e disponibilizados para o ML Kit.
  3. Crie um objeto AutoMLLocalModel especificando o caminho para o arquivo de manifesto do modelo:
    guard let manifestPath = Bundle.main.path(
        forResource
    : "manifest",
        ofType
    : "json",
        inDirectory
    : "your_model_directory"
    ) else { return true }
    let localModel = AutoMLLocalModel(manifestPath: manifestPath)
    NSString *manifestPath = [NSBundle.mainBundle pathForResource:@"manifest"
                                                           ofType
    :@"json"
                                                      inDirectory
    :@"your_model_directory"];
    FIRAutoMLLocalModel *localModel = [[FIRAutoMLLocalModel alloc] initWithManifestPath:manifestPath];

Crie um rotulador de imagem a partir do seu modelo

Depois de configurar as fontes do modelo, crie um objeto VisionImageLabeler a partir de uma delas.

Se você tiver apenas um modelo empacotado localmente, basta criar um rotulador a partir do seu objeto AutoMLLocalModel e configurar o limite de pontuação de confiança que deseja exigir (consulte Avaliar seu modelo ):

let options = VisionOnDeviceAutoMLImageLabelerOptions(localModel: localModel)
options
.confidenceThreshold = 0  // Evaluate your model in the Firebase console
                                 // to determine an appropriate value.
let labeler = Vision.vision().onDeviceAutoMLImageLabeler(options: options)
FIRVisionOnDeviceAutoMLImageLabelerOptions *options =
   
[[FIRVisionOnDeviceAutoMLImageLabelerOptions alloc] initWithLocalModel:localModel];
options
.confidenceThreshold = 0;  // Evaluate your model in the Firebase console
                                 
// to determine an appropriate value.
FIRVisionImageLabeler *labeler =
   
[[FIRVision vision] onDeviceAutoMLImageLabelerWithOptions:options];

Se você tiver um modelo hospedado remotamente, deverá verificar se ele foi baixado antes de executá-lo. Você pode verificar o status da tarefa de download do modelo usando o método isModelDownloaded(remoteModel:) do gerenciador de modelo.

Embora você só precise confirmar isso antes de executar o rotulador, se você tiver um modelo hospedado remotamente e um modelo empacotado localmente, pode fazer sentido realizar esta verificação ao instanciar o VisionImageLabeler : crie um rotulador a partir do modelo remoto, se for foi baixado e do modelo local caso contrário.

var options: VisionOnDeviceAutoMLImageLabelerOptions?
if (ModelManager.modelManager().isModelDownloaded(remoteModel)) {
  options
= VisionOnDeviceAutoMLImageLabelerOptions(remoteModel: remoteModel)
} else {
  options
= VisionOnDeviceAutoMLImageLabelerOptions(localModel: localModel)
}
options
.confidenceThreshold = 0  // Evaluate your model in the Firebase console
                                 // to determine an appropriate value.
let labeler = Vision.vision().onDeviceAutoMLImageLabeler(options: options)
VisionOnDeviceAutoMLImageLabelerOptions *options;
if ([[FIRModelManager modelManager] isModelDownloaded:remoteModel]) {
  options
= [[FIRVisionOnDeviceAutoMLImageLabelerOptions alloc] initWithRemoteModel:remoteModel];
} else {
  options
= [[FIRVisionOnDeviceAutoMLImageLabelerOptions alloc] initWithLocalModel:localModel];
}
options
.confidenceThreshold = 0.0f;  // Evaluate your model in the Firebase console
                                     
// to determine an appropriate value.
FIRVisionImageLabeler *labeler = [[FIRVision vision] onDeviceAutoMLImageLabelerWithOptions:options];

Se você tiver apenas um modelo hospedado remotamente, desative a funcionalidade relacionada ao modelo (por exemplo, esmaecer ou ocultar parte da interface do usuário) até confirmar que o download do modelo foi feito.

Você pode obter o status de download do modelo anexando observadores ao Centro de Notificação padrão. Certifique-se de usar uma referência fraca a self no bloco observador, pois os downloads podem levar algum tempo e o objeto de origem pode ser liberado quando o download terminar. Por exemplo:

NotificationCenter.default.addObserver(
    forName
: .firebaseMLModelDownloadDidSucceed,
   
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
: .firebaseMLModelDownloadDidFail,
   
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]
   
// ...
}
__weak typeof(self) weakSelf = self;

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

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

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

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

2. Prepare a imagem de entrada

Então, para cada imagem que você deseja rotular, crie um objeto VisionImage usando uma das opções descritas nesta seção e passe-o para uma instância de VisionImageLabeler (descrita na próxima seção).

Crie um objeto VisionImage usando UIImage ou CMSampleBufferRef .

Para usar uma UIImage :

  1. Se necessário, gire a imagem para que sua propriedade imageOrientation seja .up .
  2. Crie um objeto VisionImage usando o UIImage girado corretamente. Não especifique nenhum metadado de rotação — o valor padrão, .topLeft , deve ser usado.
    let image = VisionImage(image: uiImage)
    FIRVisionImage *image = [[FIRVisionImage alloc] initWithImage:uiImage];

Para usar um CMSampleBufferRef :

  1. Crie um objeto VisionImageMetadata que especifique a orientação dos dados de imagem contidos no buffer CMSampleBufferRef .

    Para obter a orientação da imagem:

    func imageOrientation(
        deviceOrientation
    : UIDeviceOrientation,
        cameraPosition
    : AVCaptureDevice.Position
       
    ) -> VisionDetectorImageOrientation {
       
    switch deviceOrientation {
       
    case .portrait:
           
    return cameraPosition == .front ? .leftTop : .rightTop
       
    case .landscapeLeft:
           
    return cameraPosition == .front ? .bottomLeft : .topLeft
       
    case .portraitUpsideDown:
           
    return cameraPosition == .front ? .rightBottom : .leftBottom
       
    case .landscapeRight:
           
    return cameraPosition == .front ? .topRight : .bottomRight
       
    case .faceDown, .faceUp, .unknown:
           
    return .leftTop
       
    }
    }
    - (FIRVisionDetectorImageOrientation)
        imageOrientationFromDeviceOrientation
    :(UIDeviceOrientation)deviceOrientation
                               cameraPosition
    :(AVCaptureDevicePosition)cameraPosition {
     
    switch (deviceOrientation) {
       
    case UIDeviceOrientationPortrait:
         
    if (cameraPosition == AVCaptureDevicePositionFront) {
           
    return FIRVisionDetectorImageOrientationLeftTop;
         
    } else {
           
    return FIRVisionDetectorImageOrientationRightTop;
         
    }
       
    case UIDeviceOrientationLandscapeLeft:
         
    if (cameraPosition == AVCaptureDevicePositionFront) {
           
    return FIRVisionDetectorImageOrientationBottomLeft;
         
    } else {
           
    return FIRVisionDetectorImageOrientationTopLeft;
         
    }
       
    case UIDeviceOrientationPortraitUpsideDown:
         
    if (cameraPosition == AVCaptureDevicePositionFront) {
           
    return FIRVisionDetectorImageOrientationRightBottom;
         
    } else {
           
    return FIRVisionDetectorImageOrientationLeftBottom;
         
    }
       
    case UIDeviceOrientationLandscapeRight:
         
    if (cameraPosition == AVCaptureDevicePositionFront) {
           
    return FIRVisionDetectorImageOrientationTopRight;
         
    } else {
           
    return FIRVisionDetectorImageOrientationBottomRight;
         
    }
       
    default:
         
    return FIRVisionDetectorImageOrientationTopLeft;
     
    }
    }

    Em seguida, crie o objeto de metadados:

    let cameraPosition = AVCaptureDevice.Position.back  // Set to the capture device you used.
    let metadata
    = VisionImageMetadata()
    metadata
    .orientation = imageOrientation(
        deviceOrientation
    : UIDevice.current.orientation,
        cameraPosition
    : cameraPosition
    )
    FIRVisionImageMetadata *metadata = [[FIRVisionImageMetadata alloc] init];
    AVCaptureDevicePosition cameraPosition =
       
    AVCaptureDevicePositionBack;  // Set to the capture device you used.
    metadata
    .orientation =
       
    [self imageOrientationFromDeviceOrientation:UIDevice.currentDevice.orientation
                                     cameraPosition
    :cameraPosition];
  2. Crie um objeto VisionImage usando o objeto CMSampleBufferRef e os metadados de rotação:
    let image = VisionImage(buffer: sampleBuffer)
    image
    .metadata = metadata
    FIRVisionImage *image = [[FIRVisionImage alloc] initWithBuffer:sampleBuffer];
    image
    .metadata = metadata;

3. Execute o rotulador de imagens

Para rotular objetos em uma imagem, passe o objeto VisionImage para o método process() do VisionImageLabeler :

labeler.process(image) { labels, error in
    guard error
== nil, let labels = labels else { return }

   
// Task succeeded.
    // ...
}
[labeler
    processImage
:image
      completion
:^(NSArray<FIRVisionImageLabel *> *_Nullable labels, NSError *_Nullable error) {
       
if (error != nil || labels == nil) {
         
return;
       
}

       
// Task succeeded.
       
// ...
     
}];

Se a rotulagem da imagem for bem-sucedida, uma matriz de objetos VisionImageLabel será passada para o manipulador de conclusão. De cada objeto você pode obter informações sobre uma característica reconhecida na imagem.

Por exemplo:

for label in labels {
   
let labelText = label.text
   
let confidence = label.confidence
}
for (FIRVisionImageLabel *label in labels) {
 
NSString *labelText = label.text;
 
NSNumber *confidence = label.confidence;
}

Dicas para melhorar o desempenho em tempo real

  • Limite as chamadas para o detector. Se um novo quadro de vídeo ficar disponível enquanto o detector estiver em execução, elimine o quadro.
  • Se você estiver usando a saída do detector para sobrepor gráficos na imagem de entrada, primeiro obtenha o resultado do Kit de ML e, em seguida, renderize a imagem e a sobreposição em uma única etapa. Ao fazer isso, você renderiza na superfície de exibição apenas uma vez para cada quadro de entrada. Veja as classes previewOverlayView e FIRDetectionOverlayView no aplicativo de exemplo de demonstração para ver um exemplo.