详细了解我们在 I/O 大会上发布的 Google AI Edge

此页面由 Cloud Translation API 翻译。

适用于 Android 的图片嵌入指南

通过 MediaPipe Image Embedder 任务，您可以将图片数据转换为数字表示形式来完成与机器学习相关的图片处理任务，例如将相似度。以下说明介绍了如何使用 Android 应用的图片嵌入器。

如需详细了解功能、模型和配置选项部分，请参阅概览。

代码示例

MediaPipe Tasks 示例代码是图像嵌入器的简单实现 Android 版应用。该示例使用 Android 实体设备上的相机可以连续嵌入图片，还可以对存储的图片文件运行嵌入器。

您可以用该应用作为基础来开发自己的 Android 应用，也可以指代该应用对现有应用进行了修改。图片嵌入器示例代码托管在 GitHub

下载代码

以下说明介绍了如何创建示例的本地副本使用 git 命令行工具运行 git 代码库。

如需下载示例代码，请执行以下操作：

使用以下命令克隆 git 代码库：

git clone https://github.com/google-ai-edge/mediapipe-samples

（可选）配置您的 git 实例以使用稀疏检出，这样您只有图片嵌入器示例应用的文件：
```
cd mediapipe
git sparse-checkout init --cone
git sparse-checkout set examples/image_embedder/android
```

创建示例代码的本地版本后，您可以导入项目进入 Android Studio 并运行应用。有关说明，请参阅适用于 Android 设备。

关键组件

以下文件包含此图像嵌入器示例的关键代码应用：

ImageEmbedderHelper.kt：初始化图片嵌入器并处理模型和委托选择。
MainActivity.kt：实现应用并组建界面组件。

设置

本部分介绍了设置开发环境和以便使用 Image Embedder。有关如何设置用于使用 MediaPipe 任务（包括平台版本）的开发环境请参阅适用于 Android 的 Android 设备。

依赖项

图片嵌入器使用 com.google.mediapipe:tasks-vision 库。添加此项依赖项添加到 Android 应用开发项目的 build.gradle 文件中。使用以下代码导入所需的依赖项：

dependencies {
    ...
    implementation 'com.google.mediapipe:tasks-vision:latest.release'
}

型号

MediaPipe Image Embedder 任务需要一个与此训练兼容的模型，任务。如需详细了解适用于图片嵌入器的经过训练的模型，请参阅任务概览的“模型”部分。

选择并下载模型，然后将其存储在项目目录中：

<dev-project-root>/src/main/assets

在 ModelAssetPath 参数中指定模型的路径。在示例代码在 setupImageEmbedder() 函数中定义， ImageEmbedderHelper.kt 文件：

使用 BaseOptions.Builder.setModelAssetPath() 方法指定路径模型所用的指标。下一部分的代码示例将引用此方法部分。

创建任务

您可以使用 createFromOptions 函数创建任务。通过 createFromOptions 函数接受配置选项来设置嵌入器选项。如需详细了解配置选项，请参阅配置选项概览。

图片嵌入器任务支持 3 种输入数据类型：静态图片、视频文件、和直播视频流您需要指定与输入数据类型。选择与输入数据类型，了解如何创建任务并运行推理。

映像

ImageEmbedderOptions options =
  ImageEmbedderOptions.builder()
    .setBaseOptions(
      BaseOptions.builder().setModelAssetPath("model.tflite").build())
    .setQuantize(true)
    .setRunningMode(RunningMode.IMAGE)
    .build();
imageEmbedder = ImageEmbedder.createFromOptions(context, options);

视频

ImageEmbedderOptions options =
  ImageEmbedderOptions.builder()
    .setBaseOptions(
      BaseOptions.builder().setModelAssetPath("model.tflite").build())
    .setQuantize(true)
    .setRunningMode(RunningMode.VIDEO)
    .build();
imageEmbedder = ImageEmbedder.createFromOptions(context, options);

直播

ImageEmbedderOptions options =
  ImageEmbedderOptions.builder()
    .setBaseOptions(
      BaseOptions.builder().setModelAssetPath("model.tflite").build())
    .setQuantize(true)
    .setRunningMode(RunningMode.LIVE_STREAM)
    .setResultListener((result, inputImage) -> {
         // Process the embedding result here.
    })
    .build();
imageEmbedder = ImageEmbedder.createFromOptions(context, options);

示例代码实现可让用户在处理模式。这种方法使任务创建代码更加复杂，可能适合您的用例。您可以在 setupImageEmbedder() 函数， ImageEmbedderHelper.kt 文件。

配置选项

此任务具有以下适用于 Android 应用的配置选项：

选项名称	说明	值范围	默认值
`runningMode`	设置任务的运行模式。有三个模式： IMAGE：单图输入的模式。 VIDEO：视频已解码帧的模式。 LIVE_STREAM：输入流媒体直播模式例如来自相机的数据。在此模式下，resultListener 必须为调用以设置监听器以接收结果异步执行。	{`IMAGE, VIDEO, LIVE_STREAM`}	`IMAGE`
`l2_normalize`	是否使用 L2 范数对返回的特征向量进行归一化。仅当模型尚未包含原生 L2_NORMALIZATION TFLite 操作大多数情况下已经如此因此，L2 归一化通过 TFLite 推理实现，无需。	`Boolean`	`False`
`quantize`	是否应通过标量量化。嵌套被隐式假定为单位范数，因此任何维度的值都必须在 [-1.0, 1.0] 范围内。使用则使用 l2_normalize 选项。	`Boolean`	`False`
`resultListener`	设置结果监听器以接收嵌入结果当图片嵌入器位于直播视频流中时异步加载模式。仅在跑步模式设为“`LIVE_STREAM`”时才能使用	不适用	未设置
`errorListener`	设置一个可选的错误监听器。	不适用	未设置

准备数据

图片嵌入器支持图片、视频文件和直播视频。任务处理数据输入预处理，包括调整大小、旋转和值标准化。

您需要将输入图片或帧转换为 com.google.mediapipe.framework.image.MPImage 对象，然后再将其传递给图片嵌入器任务。

映像

import com.google.mediapipe.framework.image.BitmapImageBuilder;
import com.google.mediapipe.framework.image.MPImage;

// Load an image on the user’s device as a Bitmap object using BitmapFactory.

// Convert an Android’s Bitmap object to a MediaPipe’s Image object.
Image mpImage = new BitmapImageBuilder(bitmap).build();

视频

import com.google.mediapipe.framework.image.BitmapImageBuilder;
import com.google.mediapipe.framework.image.MPImage;

// Load a video file on the user's device using MediaMetadataRetriever

// From the video’s metadata, load the METADATA_KEY_DURATION and
// METADATA_KEY_VIDEO_FRAME_COUNT value. You’ll need them
// to calculate the timestamp of each frame later.

// Loop through the video and load each frame as a Bitmap object.

// Convert the Android’s Bitmap object to a MediaPipe’s Image object.
Image mpImage = new BitmapImageBuilder(frame).build();

直播

import com.google.mediapipe.framework.image.MediaImageBuilder;
import com.google.mediapipe.framework.image.MPImage;

// Create a CameraX’s ImageAnalysis to continuously receive frames
// from the device’s camera. Configure it to output frames in RGBA_8888
// format to match with what is required by the model.

// For each Android’s ImageProxy object received from the ImageAnalysis,
// extract the encapsulated Android’s Image object and convert it to
// a MediaPipe’s Image object.
android.media.Image mediaImage = imageProxy.getImage()
Image mpImage = new MediaImageBuilder(mediaImage).build();

在示例代码中，数据准备在 ImageEmbedderHelper.kt 文件。

运行任务

您可以调用与跑步模式对应的 embed 函数来触发推理。Image Embedder API 为输入返回嵌入向量图片或框架。

映像

ImageEmbedderResult embedderResult = imageEmbedder.embed(image);

视频

// Calculate the timestamp in milliseconds of the current frame.
long frame_timestamp_ms = 1000 * video_duration * frame_index / frame_count;

// Run inference on the frame.
ImageEmbedderResult embedderResult =
    imageEmbedder.embedForVideo(image, frameTimestampMs);

直播

// Run inference on the frame. The embedding results will be available
// via the `resultListener` provided in the `ImageEmbedderOptions` when
// the image embedder was created.
imageEmbedder.embedAsync(image, frameTimestampMs);

请注意以下几点：

在视频模式或直播模式下投放广告时，您还必须为 Image Embedder 任务提供输入帧的时间戳。
在图片模式或视频模式下运行时，图片嵌入器任务将阻塞当前线程，直到它处理完输入图像，或者帧。为避免阻塞当前线程，请在后台线程。
在直播模式下运行时，图片嵌入器任务不会阻止当前线程，但会立即返回。它将调用其结果并在每次处理完一个监听器后将带有检测结果的监听器输入帧。如果在加载图片嵌入器时调用了 embedAsync 函数，任务正忙于处理另一个帧，则该任务会忽略新的输入帧。

在示例代码中，embed 函数在 ImageEmbedderHelper.kt 文件。

处理和显示结果

运行推理时，Image Embedder 任务会返回 ImageEmbedderResult 该对象包含一系列嵌入（浮点或标量量化）。

以下示例展示了此任务的输出数据：

ImageEmbedderResult:
  Embedding #0 (sole embedding head):
    float_embedding: {0.0, 0.0, ..., 0.0, 1.0, 0.0, 0.0, 2.0}
    head_index: 0

此结果是通过嵌入以下图片获得的：

您可以使用 ImageEmbedder.cosineSimilarity 函数。有关示例。

// Compute cosine similarity.
double similarity = ImageEmbedder.cosineSimilarity(
  result.embeddingResult().embeddings().get(0),
  otherResult.embeddingResult().embeddings().get(0));