このページは Cloud Translation API によって翻訳されました。

Android でカスタムモデルを使用して画像にラベルを付ける
コレクションでコンテンツを整理必要に応じて、コンテンツの保存と分類を行います。

ML Kit を使用すると、画像内のエンティティを認識してラベルを付けることができます。この API は、幅広いカスタム画像分類モデルをサポートしています。恐れ入りますが、詳細については、ML Kit を使用したカスタムモデルをご覧ください。モデルの互換性要件、事前トレーニング済みモデルの入手先独自のモデルをトレーニングする方法を見ていきます

画像のラベル付けをカスタムモデルと統合するには、次の 2 つの方法があります。アプリの一部として統合するか、Terraform ワークフローの。バンドルされていないパイプラインを選択すると、小さくなります。詳しくは、以下の表をご覧ください。

	バンドル	バンドルされていません
ライブラリ名	`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）	ベータ版

カスタムモデルを統合するには、次の 2 つの方法があります。1 つはモデルをアプリのアセットフォルダに配置するか、動的にダウンロードします。使用できます。次の表は、これら 2 つのオプションを比較したものです。

バンドルされたモデル	ホストされているモデル
このモデルはアプリの APK の一部であり、サイズが増大します。	モデルは APK の一部ではありません。アップロードすることでホストされます。 Firebase ML。
Android デバイスがオフラインの場合でも、モデルをすぐに利用できます。	モデルはオンデマンドでダウンロードされる
Firebase プロジェクトは不要	Firebase プロジェクトが必要
モデルを更新するには、アプリを再公開する必要があります	アプリを再公開せずにモデルの更新を push する
A/B Testing が組み込まれていない	Firebase Remote Config で簡単に A/B テストを実施

試してみる

Vision クイックスタートアプリをご覧ください。をご覧ください。バンドルのモデルと、 automl クイックスタートアプリホストされるモデルの使用例。

始める前に

プロジェクトレベルの build.gradle ファイルに、次の内容を含めます。 Google の Maven リポジトリを buildscript と allprojects セクション。

ML Kit 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'
}

モデルをダウンロードする場合は、 Android プロジェクトに Firebase を追加するまだ実施していない場合は追加してくださいモデルをバンドルする場合は不要です。

1. モデルを読み込む

ローカルモデルソースを構成する

モデルをアプリにバンドルするには:

モデルファイル（通常は末尾が .tflite または .lite）をアプリの assets/ フォルダです。（先に事前にフォルダを作成し、 app/ フォルダを右クリックして 新規 >フォルダ >Assets フォルダを参照してください）。
次に、アプリの build.gradle ファイルに以下を追加して、 Gradle は、アプリのビルド時にモデルファイルを圧縮しません。
```
android {
    // ...
    aaptOptions {
        noCompress "tflite"
        // or noCompress "lite"
    }
}
```
モデルファイルはアプリパッケージに含まれ、ML Kit で使用可能未加工アセットとして扱われます

注: 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 オブジェクトを作成します。そのうちの 1 つです

以下のオプションを使用できます。

オプション
`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);
            }
        });

リモートでホストされるモデルのみがある場合は、モデル関連機能（たとえば UI の一部をグレー表示または非表示にする）をモデルがダウンロードされたことを確認しますそのためには、リスナーをアタッチしてこれをモデルマネージャーの 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() に変更します。

「 <ph type="x-smartling-placeholder"></ph> 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 インテントを使用してユーザーに選択を求めるギャラリーアプリから画像を作成できます

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 を作成するには: 作成するには、まず画像を計算してByteBufferByteArray 前述の 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

</ph> 注: CameraX API を使用する場合は、使用が終了したら必ず ImageProxy を閉じてください。たとえば、返された Task に OnCompleteListener を process メソッドを使用します。詳しくは、 <ph type="x-smartling-placeholder"></ph> 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、スロットル呼び出しを行います。新しい動画がフレームが使用可能になったら、そのフレームをドロップします。詳しくは、 <ph type="x-smartling-placeholder"></ph> VisionProcessorBase クラスをご覧ください。
CameraX API を使用する場合は、バックプレッシャー戦略がデフォルト値に <ph type="x-smartling-placeholder"></ph> ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST。これにより、分析のために一度に 1 つの画像のみが配信されるようになります。もしより多くの画像が生成された場合、自動的に破棄され、提供します。次の呼び出しによって分析中の画像を閉じたら、 ImageProxy.close() が呼び出されると、次に最新の画像が配信されます。
画像ラベラーの出力を使用してグラフィックをまず ML Kit から結果を取得してから、画像をレンダリングする 1 ステップでオーバーレイできますこれにより、ディスプレイサーフェスにレンダリングされます。入力フレームごとに 1 回だけです。詳しくは、 <ph type="x-smartling-placeholder"></ph> CameraSourcePreview および <ph type="x-smartling-placeholder"></ph> 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

リアルタイムのパフォーマンスを改善するためのヒント

Android でカスタムモデルを使用して画像にラベルを付ける
コレクションでコンテンツを整理必要に応じて、コンテンツの保存と分類を行います。

`media.Image` の使用

`ByteBuffer` または `ByteArray` の使用

`Bitmap` の使用