迁移到 iOS

前提条件

在开始迁移代码之前,请确保满足以下要求:

  • 机器学习套件支持 Xcode 13.2.1 或更高版本。
  • 机器学习套件支持 iOS 10 或更高版本。
  • 机器学习套件不支持 32 位架构(i386 和 armv7)。机器学习套件确实支持 64 位架构(x86_64 和 arm64)。
  • 机器学习套件库仅以 CocoaPods 的形式提供。您无法混合使用框架和 CocoaPods,因此要使用此库,您需要先进行迁移以使用 CocoaPods。

更新 CocoaPods

更新应用的 Podfile 中机器学习套件 iOS CocoaPods 的依赖项:

API原 pod 名称新 pod 名称
条形码扫描 Firebase/MLVision
Firebase/MLVisionBarcodeModel
GoogleMLKit/条形码扫描
人脸检测 Firebase/MLVision
Firebase/MLVisionFaceModel
GoogleMLKit/人脸检测
图像标签 Firebase/MLVision
Firebase/MLVisionLabelModel
GoogleMLKit/ImageLabeling
对象检测和跟踪 Firebase/MLVisionObjectDetection GoogleMLKit/对象检测
文字识别 Firebase/MLVision
Firebase/MLVisionTextModel
GoogleMLKit/文本识别
AutoML 图片标签(捆绑模型) Firebase/MLVisionAutoML GoogleMLKit/ImageLabelingCustom
AutoML 图片标签(从 Firebase 下载模型) Firebase/MLVisionAutoML GoogleMLKit/ImageLabelingCustom
GoogleMLKit/LinkFirebase
语言 ID Firebase/MLNaturalLanguage
Firebase/MLNLLanguageID
Google 机器学习套件/语言 ID
智能回复 Firebase/MLNaturalLanguage
Firebase/MLNLSmartReply
GoogleMLKit/智能回复
翻译 Firebase/MLNaturalLanguage
Firebase/MLNLTranslation
Google 机器学习套件/翻译

更新类、枚举和类型的名称

一般来说,需要按如下方式重命名类、枚举和类型:

  • Swift:从类名称和枚举中移除 Vision 前缀
  • Objective-C:将 FIRVisionFIR 类名称和枚举前缀都替换为 MLK

对于某些类名称和类型,此通用规则不适用:

Swift

旧类或类型新类或类型
AutoMLLocalModel 本地模型
AutoMLRemoteModel CustomRemoteModel 类
VisionBarcodeDetectionCallback BarcodeScanningCallback
VisionBarcodeDetector 条形码扫描器
VisionBarcodeDetector 选项 BarcodeScanner 选项
VisionImage VisionImage(未更改)
VisionPoint VisionPoint(未更改)
VisionOnDeviceAutoMLImageLabelerOptions CustomImageLabelerOptions
VisionOnDeviceImageLabelerOptions ImageLabelerOptions

Objective-C

旧类或类型新类或类型
FIRAutoMLLocalModel 模型 MLKLocalModel
FIRAutoMLRemoteModel 模型 MLKCustomRemoteModel
FIRVisionBarcodeDetectionCallback MLKBarcodeScanningCallback
FIRVisionBarcodeDetector MLKBarcodeScanner
FIRVisionBarcodeDetector 选项 MLKBarcodeScanner 选项
FIRVisionImage 版 MLKVisionImage
FIRVisionOnDeviceAutoMLImageLabelerOptions MLKCustomImageLabelerOptions
FIRVisionOnDeviceImageLabelerOptions MLKImageLabelerOptions
FIRVisionPoint MLKVisionPoint

Objective-C

更新方法名称

根据这些规则更新方法名称:

  • 网域入口点类(VisionNaturalLanguage)已不存在。它们已被特定于任务的类取代。 将对各个工厂方法的调用替换为对各个检测器的工厂方法的直接调用。

  • 移除了 VisionImageMetadata 类以及 VisionDetectorImageOrientation 枚举。使用 VisionImageorientation 属性指定图片的显示方向。

  • 用于获取新 TextRecognizer 实例的 onDeviceTextRecognizer 方法已重命名为 textRecognizer

  • 从文本识别结果类(包括 TextElementTextLineTextBlock)中移除了 confidence 属性。

  • 用于获取新的 ImageLabeler 实例的 onDeviceImageLabeleronDeviceImageLabeler(options:) 方法已合并并重命名为 imageLabeler(options:)

  • 移除了用于获取新的 ObjectDetector 实例的 objectDetector 方法。请改用 objectDetector(options:)

  • type 属性已从 ImageLabeler 中移除,entityID 属性已从图片标签结果类 ImageLabel 中移除。

  • 条形码扫描 API detect(in _:, completion:) 已重命名为 process(_:, completion:),以与其他视觉 API 保持一致。

  • Natural Language API 现在使用术语“语言标记”(如 BCP-47 标准所定义),而非“语言代码”。

  • TranslateLanguage 现在使用可读名称(例如 .english)作为其常量,而不是语言标记(例如 .en)。

以下是新旧 Swift 方法的一些示例:

旧优惠

let options = VisionOnDeviceImageLabelerOptions()
options.confidenceThreshold = 0.75
let labeler = Vision.vision().onDeviceImageLabeler(options: options)

let detector = Vision.vision().faceDetector(options: options)

let localModel = AutoMLLocalModel(manifestPath: "automl/manifest.json")
let options = VisionOnDeviceAutoMLImageLabelerOptions(localModel: localModel)
options.confidenceThreshold = 0.75
let labeler = vision.onDeviceAutoMLImageLabeler(options: options)

let detector = Vision.vision().objectDetector()
    

新建

let options = ImageLabelerOptions()
options.confidenceThreshold = NSNumber(value:0.75)
let labeler = ImageLabeler.imageLabeler(options: options)

let detector = FaceDetector.faceDetector(options: options)

let localModel = LocalModel(manifestPath: "automl/manifest.json")
let options = CustomImageLabelerOptions(localModel: localModel)
options.confidenceThreshold = NSNumber(value:0.75)
let labeler = ImageLabeler.imageLabeler(options: options)

let detector = ObjectDetector.objectDetector(options: ObjectDetectorOptions())
    

以下是新旧 Objective-C 方法的一些示例:

旧优惠

FIRVisionOnDeviceImageLabelerOptions *options = 
    [[FIRVisionOnDeviceImageLabelerOptions alloc] init];
options.confidenceThreshold = 0.75;
FIRVisionImageLabeler *labeler = 
    [[FIRVision vision] onDeviceImageLabelerWithOptions:options];

FIRVisionFaceDetector *detector =
    [[FIRVision vision] faceDetectorWithOptions: options];

FIRAutoMLLocalModel *localModel =
    [[FIRAutoMLLocalModel alloc] initWithManifestPath:@"automl/manifest.json"];
FIRVisionOnDeviceAutoMLImageLabelerOptions *options =
    [[FIRVisionOnDeviceAutoMLImageLabelerOptions alloc]
        initWithLocalModel: localModel];
options.confidenceThreshold = 0.75
FIRVisionImageLabeler *labeler =
    [[FIRVision vision] onDeviceAutoMLImageLabelerWithOptions:options];

FIRVisionObjectDetector *detector =
    [[FIRVision vision] objectDetector];
    

新建

MLKImageLabelerOptions *options =
    [[MLKImageLabelerOptions alloc] init];
options.confidenceThreshold = @(0.75);
MLKImageLabeler *labeler =
    [MLKImageLabeler imageLabelerWithOptions:options];

MLKFaceDetector *detector =
    [MLKFaceDetector faceDetectorWithOptions:options];

MLKLocalModel *localModel =
    [[MLKLocalModel alloc]
        initWithManifestPath:@"automl/manifest.json"];
MLKCustomImageLabelerOptions *options =
    [[MLKCustomImageLabelerOptions alloc] initWithLocalModel:localModel];
options.confidenceThreshold = @(0.75)
MLKImageLabeler *labeler =
    [MLKImageLabeler imageLabelerWithOptions:options];

MLKObjectDetectorOptions *options = [[MLKObjectDetectorOptions alloc] init];
MLKObjectDetector *detector = [MLKObjectDetector objectDetectorWithOptions:options];
    

API 特定更改

对象检测和跟踪

如果您的应用使用对象分类,请注意新的 SDK 更改了返回所检测到的对象的分类类别的方式。

VisionObject 对象中的 VisionObjectCategory 会在 ObjectLabel 对象中返回 text,而不是整数。所有可能的字符串类别都包含在 DetectedObjectLabel 枚举中。

请注意,.unknown 类别已被移除。当分类对象的置信度较低时,分类器根本不会返回任何标签。

以下是新旧 Swift 代码的示例:

旧优惠

if (object.classificationCategory == .food) {
    ...
}

新建

if let label = object.labels.first {
  if (label.text == DetectedObjectLabel.food.rawValue) {
    ...
  }
}
// or
if let label = object.labels.first {
  if (label.index == DetectedObjectLabelIndex.food.rawValue) {
    ...
  }
}

以下是新旧 Objective-C 代码示例:

旧优惠

if (object.classificationCategory == FIRVisionObjectCategoryFood) {
    ...
}

新建

if ([object.labels[0].text isEqualToString:MLKDetectedObjectLabelFood]) {
  ...
}
// or
if ([object.labels[0].index == MLKDetectedObjectLabelIndexFood]) {
  ...
}

移除 Firebase 依赖项(可选)

此步骤仅在满足以下条件时适用:

  • Firebase ML Kit 是您使用的唯一 Firebase 组件
  • 您仅使用设备端 API
  • 不使用模型传送

在这种情况下,您可以在迁移后移除 Firebase 依赖项。 请按照以下步骤操作:

  • 从应用的目录和 Xcode 项目中删除 GoogleService-Info.plist 文件,以移除 Firebase 配置文件。
  • 从 Podfile 中移除所有 Firebase CocoaPods。
  • 从您的代码中移除所有 FirebaseApp 初始化,例如 FirebaseApp.configure()
  • 根据 Firebase 支持网站上的说明,在 Firebase 控制台中删除您的 Firebase 应用。

获取帮助

如果您遇到任何问题,请访问我们的社区页面,我们概述了可以与我们联系的渠道。