此页面由 Cloud Translation API 翻译。

使用自定义模型给图片加标签 (Android)

您可以使用机器学习套件识别图片中的实体并添加标签。此 API 支持各种自定义图片分类模型。请如需获得以下指导，请参阅使用机器学习套件的自定义模型模型兼容性要求、在哪里可以找到预训练模型，以及如何训练自己的模型。

您可以通过以下两种方式将图片标签与自定义模型集成：将流水线视为应用的一部分，或者使用依赖于。如果您选择未捆绑流水线，您的应用将更小。请参阅下表了解详情。

	捆绑	不分类显示
库名称	`com.google.mlkit:image-labeling-custom`	`com.google.android.gms:play-services-mlkit-image-labeling-custom`
实现	流水线在构建时静态关联到您的应用。	流水线通过 Google Play 服务动态下载。
应用大小	大小增加约 3.8 MB。	大小增加约 200 KB。
初始化时间	流水线立即可用。	可能必须等到流水线下载完毕后才能首次使用。
API 生命周期阶段	正式版 (GA)	Beta 版

集成自定义模型的方法有两种：将资源放入应用的资源文件夹中，或者动态下载资源。下表对这两个选项进行了比较。

捆绑模型	托管的模型
该模型是应用 APK 的一部分，这会增加其大小。	该模型不是 APK 的一部分。它通过上传到 Firebase 机器学习。
即使 Android 设备处于离线状态，模型也可立即使用	按需下载模型
无需 Firebase 项目	需要 Firebase 项目
您必须重新发布应用才能更新模型	无需重新发布应用即可推送模型更新
没有内置 A/B 测试	使用 Firebase Remote Config 轻松进行 A/B 测试

试试看

查看视觉快速入门应用有关捆绑模型和 AutoML 快速入门应用托管模型的使用示例

准备工作

在项目级 build.gradle 文件中，请务必包含 buildscript 和 Google 的 Maven 制品库 allprojects 个版块。

将 Android 版机器学习套件库的依赖项添加到模块的应用级 Gradle 文件，通常为 app/build.gradle。从下列选项中选择一项以下依赖项：

如需将流水线与您的应用捆绑，请执行以下操作：

dependencies {
  // ...
  // Use this dependency to bundle the pipeline with your app
  implementation 'com.google.mlkit:image-labeling-custom:17.0.3'
}

如需在 Google Play 服务中使用流水线，请执行以下操作：

dependencies {
  // ...
  // Use this dependency to use the dynamically downloaded pipeline in Google Play Services
  implementation 'com.google.android.gms:play-services-mlkit-image-labeling-custom:16.0.0-beta5'
}

如果您选择在 Google Play 服务中使用流水线，可以执行以下操作：将您的应用配置为在发生以下事件后，自动将流水线下载到设备：用户从 Play 商店安装您的应用。为此，请添加以下内容添加到应用的 AndroidManifest.xml 文件中：
```
<application ...>
    ...
    <meta-data
        android:name="com.google.mlkit.vision.DEPENDENCIES"
        android:value="custom_ica" />
    
</application>
```
您还可以明确检查流水线可用性，并请求通过 Google Play 服务 ModuleInstallClient API。

如果您不启用安装时流水线下载或请求明确下载，流水线就会下载完成。您提出的请求在下载完成之前未产生任何结果。

如果要动态下载linkFirebase 模型：

如需从 Firebase 动态下载模型，请添加 linkFirebase 依赖项：

dependencies {
  // ...
  // Image labeling feature with model downloaded from Firebase
  implementation 'com.google.mlkit:image-labeling-custom:17.0.3'
  // Or use the dynamically downloaded pipeline in Google Play Services
  // implementation 'com.google.android.gms:play-services-mlkit-image-labeling-custom:16.0.0-beta5'
  implementation 'com.google.mlkit:linkfirebase:17.0.0'
}

如果您想下载模型，请确保将 Firebase 添加到您的 Android 项目，（如果您尚未这样做）。捆绑模型时不需要这样做。

1. 加载模型

配置本地模型来源

如需将模型与您的应用捆绑在一起，请执行以下操作：

将模型文件（通常以 .tflite 或 .lite 结尾）复制到应用的 assets/ 文件夹。（您可能需要先创建文件夹，右键点击 app/ 文件夹，然后点击 新建 >文件夹 >Assets 文件夹。）
然后，将以下内容添加到应用的 build.gradle 文件中，以确保 Gradle 在构建应用时不会压缩模型文件：
```
android {
    // ...
    aaptOptions {
        noCompress "tflite"
        // or noCompress "lite"
    }
}
```
模型文件将包含在应用软件包中，并提供给机器学习套件使用原始资源

注意：从 Android Gradle 插件 4.1 版开始，.tflite 将已默认添加到 noCompress 列表，而不再需要上述操作。

创建 LocalModel 对象，指定模型文件的路径：

Kotlin

val localModel = LocalModel.Builder()
        .setAssetFilePath("model.tflite")
        // or .setAbsoluteFilePath(absolute file path to model file)
        // or .setUri(URI to model file)
        .build()

Java

LocalModel localModel =
    new LocalModel.Builder()
        .setAssetFilePath("model.tflite")
        // or .setAbsoluteFilePath(absolute file path to model file)
        // or .setUri(URI to model file)
        .build();

配置 Firebase 托管的模型来源

如需使用远程托管的模型，请通过以下方法创建一个 RemoteModel 对象： FirebaseModelSource，指定您在创建模型时发布时间：

Kotlin

// Specify the name you assigned in the Firebase console.
val remoteModel =
    CustomRemoteModel
        .Builder(FirebaseModelSource.Builder("your_model_name").build())
        .build()

Java

// Specify the name you assigned in the Firebase console.
CustomRemoteModel remoteModel =
    new CustomRemoteModel
        .Builder(new FirebaseModelSource.Builder("your_model_name").build())
        .build();

然后，启动模型下载任务，指定来允许下载如果该设备上没有该型号，或者版本较新的模型可用时，任务会异步下载模型：

Kotlin

val downloadConditions = DownloadConditions.Builder()
    .requireWifi()
    .build()
RemoteModelManager.getInstance().download(remoteModel, downloadConditions)
    .addOnSuccessListener {
        // Success.
    }

Java

DownloadConditions downloadConditions = new DownloadConditions.Builder()
        .requireWifi()
        .build();
RemoteModelManager.getInstance().download(remoteModel, downloadConditions)
        .addOnSuccessListener(new OnSuccessListener() {
            @Override
            public void onSuccess(@NonNull Task task) {
                // Success.
            }
        });

许多应用会通过其初始化代码启动下载任务，但可以在需要使用该模型之前随时执行此操作。

配置图片标记器

配置模型来源后，根据ImageLabeler 其中之一。

提供的选项如下：

选项
`confidenceThreshold`	已检测到的标签的最低置信度分数。如果未设置，任何系统将使用模型元数据指定的分类器阈值。如果模型不包含任何元数据或元数据不包含则默认阈值为 0.0，。
`maxResultCount`	要返回的标签数上限。如果未设置，则系统将使用默认值将使用 10。

如果您只有本地捆绑的模型，只需根据 LocalModel 对象：

Kotlin

val customImageLabelerOptions = CustomImageLabelerOptions.Builder(localModel)
    .setConfidenceThreshold(0.5f)
    .setMaxResultCount(5)
    .build()
val labeler = ImageLabeling.getClient(customImageLabelerOptions)

Java

CustomImageLabelerOptions customImageLabelerOptions =
        new CustomImageLabelerOptions.Builder(localModel)
            .setConfidenceThreshold(0.5f)
            .setMaxResultCount(5)
            .build();
ImageLabeler labeler = ImageLabeling.getClient(customImageLabelerOptions);

如果您有远程托管的模型，则必须检查该模型下载应用您可以检查模型下载的状态使用模型管理器的 isModelDownloaded() 方法完成任务。

虽然您只需在运行标签添加者之前确认这一点，同时具有远程托管的模型和本地捆绑的模型，在实例化图片标记器时执行这项检查：从远程模型添加标签（如果已下载），模型。

Kotlin

RemoteModelManager.getInstance().isModelDownloaded(remoteModel)
    .addOnSuccessListener { isDownloaded ->
    val optionsBuilder =
        if (isDownloaded) {
            CustomImageLabelerOptions.Builder(remoteModel)
        } else {
            CustomImageLabelerOptions.Builder(localModel)
        }
    val options = optionsBuilder
                  .setConfidenceThreshold(0.5f)
                  .setMaxResultCount(5)
                  .build()
    val labeler = ImageLabeling.getClient(options)
}

Java

RemoteModelManager.getInstance().isModelDownloaded(remoteModel)
        .addOnSuccessListener(new OnSuccessListener() {
            @Override
            public void onSuccess(Boolean isDownloaded) {
                CustomImageLabelerOptions.Builder optionsBuilder;
                if (isDownloaded) {
                    optionsBuilder = new CustomImageLabelerOptions.Builder(remoteModel);
                } else {
                    optionsBuilder = new CustomImageLabelerOptions.Builder(localModel);
                }
                CustomImageLabelerOptions options = optionsBuilder
                    .setConfidenceThreshold(0.5f)
                    .setMaxResultCount(5)
                    .build();
                ImageLabeler labeler = ImageLabeling.getClient(options);
            }
        });

如果您只有远程托管的模型，则应停用与模型相关的部分功能（如灰显或隐藏界面的某一部分），您可以确认模型已下载。为此，你可以将一个监听器附加到添加到模型管理器的 download() 方法：

Kotlin

RemoteModelManager.getInstance().download(remoteModel, conditions)
    .addOnSuccessListener {
        // Download complete. Depending on your app, you could enable the ML
        // feature, or switch from the local model to the remote model, etc.
    }

Java

RemoteModelManager.getInstance().download(remoteModel, conditions)
        .addOnSuccessListener(new OnSuccessListener() {
            @Override
            public void onSuccess(Void v) {
              // Download complete. Depending on your app, you could enable
              // the ML feature, or switch from the local model to the remote
              // model, etc.
            }
        });

2. 准备输入图片

然后，为要加标签的每张图片创建一个 InputImage 对象。使用 Bitmap 时，图片标记器的运行速度最快或者，如果您使用 Camera2 API，则会创建 YUV_420_888 media.Image，它们是。

您可以创建 InputImage 对象，下文对每种方法进行了说明。

使用 `media.Image`

如需创建 InputImage，请执行以下操作：对象（例如从 media.Image 对象中捕获图片时）请传递 media.Image 对象和图片的旋转为 InputImage.fromMediaImage()。

如果您使用 CameraX 库、OnImageCapturedListener 和 ImageAnalysis.Analyzer 类计算旋转角度值。

Kotlin

private class YourImageAnalyzer : ImageAnalysis.Analyzer {

    override fun analyze(imageProxy: ImageProxy) {
        val mediaImage = imageProxy.image
        if (mediaImage != null) {
            val image = InputImage.fromMediaImage(mediaImage, imageProxy.imageInfo.rotationDegrees)
            // Pass image to an ML Kit Vision API
            // ...
        }
    }
}

Java

private class YourAnalyzer implements ImageAnalysis.Analyzer {

    @Override
    public void analyze(ImageProxy imageProxy) {
        Image mediaImage = imageProxy.getImage();
        if (mediaImage != null) {
          InputImage image =
                InputImage.fromMediaImage(mediaImage, imageProxy.getImageInfo().getRotationDegrees());
          // Pass image to an ML Kit Vision API
          // ...
        }
    }
}

如果您不使用可提供图片旋转角度的相机库，可以根据设备的旋转角度和镜头方向来计算设备传感器：

Kotlin

private val ORIENTATIONS = SparseIntArray()

init {
    ORIENTATIONS.append(Surface.ROTATION_0, 0)
    ORIENTATIONS.append(Surface.ROTATION_90, 90)
    ORIENTATIONS.append(Surface.ROTATION_180, 180)
    ORIENTATIONS.append(Surface.ROTATION_270, 270)
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
@Throws(CameraAccessException::class)
private fun getRotationCompensation(cameraId: String, activity: Activity, isFrontFacing: Boolean): Int {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    val deviceRotation = activity.windowManager.defaultDisplay.rotation
    var rotationCompensation = ORIENTATIONS.get(deviceRotation)

    // Get the device's sensor orientation.
    val cameraManager = activity.getSystemService(CAMERA_SERVICE) as CameraManager
    val sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION)!!

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360
    }
    return rotationCompensation
}MLKitVisionImage.kt

Java

private static final SparseIntArray ORIENTATIONS = new SparseIntArray();
static {
    ORIENTATIONS.append(Surface.ROTATION_0, 0);
    ORIENTATIONS.append(Surface.ROTATION_90, 90);
    ORIENTATIONS.append(Surface.ROTATION_180, 180);
    ORIENTATIONS.append(Surface.ROTATION_270, 270);
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
private int getRotationCompensation(String cameraId, Activity activity, boolean isFrontFacing)
        throws CameraAccessException {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    int deviceRotation = activity.getWindowManager().getDefaultDisplay().getRotation();
    int rotationCompensation = ORIENTATIONS.get(deviceRotation);

    // Get the device's sensor orientation.
    CameraManager cameraManager = (CameraManager) activity.getSystemService(CAMERA_SERVICE);
    int sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION);

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360;
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360;
    }
    return rotationCompensation;
}

然后，传递 media.Image 对象和将旋转角度值设为 InputImage.fromMediaImage()：

Kotlin

val image = InputImage.fromMediaImage(mediaImage, rotation)MLKitVisionImage.kt

Java

InputImage image = InputImage.fromMediaImage(mediaImage, rotation);

使用文件 URI

如需创建 InputImage，请执行以下操作：对象时，请将应用上下文和文件 URI 传递给 InputImage.fromFilePath()。在需要满足特定条件时使用 ACTION_GET_CONTENT intent 提示用户进行选择从图库应用中获取图片

Kotlin

val image: InputImage
try {
    image = InputImage.fromFilePath(context, uri)
} catch (e: IOException) {
    e.printStackTrace()
}MLKitVisionImage.kt

Java

InputImage image;
try {
    image = InputImage.fromFilePath(context, uri);
} catch (IOException e) {
    e.printStackTrace();
}

使用 `ByteBuffer` 或 `ByteArray`

如需创建 InputImage，请执行以下操作：对象ByteBuffer或ByteArray时，首先计算图像旋转角度。media.Image 然后，创建带有缓冲区或数组的 InputImage 对象以及图片的高度、宽度、颜色编码格式和旋转角度：

Kotlin

val image = InputImage.fromByteBuffer(
        byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)MLKitVisionImage.kt
// Or:
val image = InputImage.fromByteArray(
        byteArray,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromByteBuffer(byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);MLKitVisionImage.java
// Or:
InputImage image = InputImage.fromByteArray(
        byteArray,
        /* image width */480,
        /* image height */360,
        rotation,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);MLKitVisionImage.java

使用 `Bitmap`

如需创建 InputImage，请执行以下操作：对象时，请进行以下声明：Bitmap

Kotlin

val image = InputImage.fromBitmap(bitmap, 0)MLKitVisionImage.kt

Java

InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);MLKitVisionImage.java

图片由 Bitmap 对象和旋转角度表示。

3. 运行图片标记器

如需给图片中的对象加标签，请将 image 对象传递给 ImageLabeler 的 process() 方法。

Kotlin

labeler.process(image)
        .addOnSuccessListener { labels ->
            // Task completed successfully
            // ...
        }
        .addOnFailureListener { e ->
            // Task failed with an exception
            // ...
        }ImageLabelingActivity.kt

Java

labeler.process(image)
        .addOnSuccessListener(new OnSuccessListener<List<ImageLabel>>() {
            @Override
            public void onSuccess(List<ImageLabel> labels) {
                // Task completed successfully
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Task failed with an exception
                // ...
            }
        });ImageLabelingActivity.java

注意：如果您使用的是 CameraX API，请确保在用完 ImageProxy 后将其关闭，例如，将 OnCompleteListener 添加到从Task process 方法。请参阅 VisionProcessorBase 类。

4. 获取已加标签的实体的相关信息

如果为图片加标签操作成功，系统会显示 ImageLabel 列表对象传递给成功监听器。每个 ImageLabel 对象代表图片中加了标签的某个事物。您可以获取每个标签的文本说明（如果在 TensorFlow Lite 模型文件的元数据中提供）、置信度分数和索引。例如：

Kotlin

for (label in labels) {
    val text = label.text
    val confidence = label.confidence
    val index = label.index
}ImageLabelingActivity.kt

Java

for (ImageLabel label : labels) {
    String text = label.getText();
    float confidence = label.getConfidence();
    int index = label.getIndex();
}ImageLabelingActivity.java

提高实时性能的相关提示

如果要在实时应用中给图片加标签，请按照这些说明操作实现最佳帧速率的准则：

如果您使用 Camera 或 camera2 API、限制对图片标记器的调用。如果新视频当图片标记器运行时，如果有帧可用，请丢弃该帧。请参阅 VisionProcessorBase 类。
如果您使用 CameraX API，确保 Backpressure 策略设置为默认值 ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST。这可保证一次仅传送一张图片进行分析。如果有更多图片在分析器繁忙时生成，它们会被自动丢弃，不会排队等待。通过调用 ImageProxy.close()，将传递下一张图片。
如果您使用图像标记器的输出在输入图片，首先从机器学习套件获取结果，和叠加层。这会渲染到每个输入帧只执行一次。请参阅 CameraSourcePreview和 GraphicOverlay 类。
如果您使用 Camera2 API，请以 ImageFormat.YUV_420_888 格式。如果您使用的是旧版 Camera API，请使用 ImageFormat.NV21 格式。

使用自定义模型给图片加标签 (Android)

试试看

准备工作

1. 加载模型

配置本地模型来源

Kotlin

Java

配置 Firebase 托管的模型来源

Kotlin

Java

Kotlin

Java

配置图片标记器

Kotlin

Java

Kotlin

Java

Kotlin

Java

2. 准备输入图片

使用 media.Image

Kotlin

Java

Kotlin

Java

Kotlin

Java

使用文件 URI

Kotlin

Java

使用 ByteBuffer 或 ByteArray

Kotlin

Java

使用 Bitmap

Kotlin

Java

3. 运行图片标记器

Kotlin

Java

4. 获取已加标签的实体的相关信息

Kotlin

Java

提高实时性能的相关提示

使用 `media.Image`

使用 `ByteBuffer` 或 `ByteArray`

使用 `Bitmap`