自然言語分類器の統合

Task Library のNLClassifier API は、入力テキストをさまざまなカテゴリに分類し、ほとんどのテキスト分類モデルを処理できる多用途で構成可能な API です。

NLClassifier API の主な機能

  • 単一の文字列を入力として受け取り、その文字列で分類を実行し、分類の結果として <Label、Score> のペアを出力します。

  • 入力テキストの正規表現トークン化（オプション）。

  • さまざまな分類モデルに適応するように構成可能。

サポートされている NLClassifier モデル

次のモデルは、NLClassifier API との互換性が保証されています。

Java で推論を実行する

Android アプリケーションでNLClassifierを使用する方法の例については、テキスト分類リファレンスアプリを参照してください。

ステップ 1: Gradle の依存関係とその他の設定をインポートする

.tfliteモデルファイルを、モデルが実行される Android モジュールのアセットディレクトリにコピーします。ファイルを圧縮しないように指定し、TensorFlow Lite ライブラリをモジュールのbuild.gradleファイルに追加します。

android {
    // Other settings

    // Specify tflite file should not be compressed for the app apk
    aaptOptions {
        noCompress "tflite"
    }

}

dependencies {
    // Other dependencies

    // Import the Task Vision Library dependency (NNAPI is included)
    implementation 'org.tensorflow:tensorflow-lite-task-text:0.4.4'
    // Import the GPU delegate plugin Library for GPU inference
    implementation 'org.tensorflow:tensorflow-lite-gpu-delegate-plugin:0.4.4'
}

注意: Android Gradle プラグインのバージョン 4.1 以降、.tflite はデフォルトで noCompress リストに追加され、上記の aaptOptions は不要になりました。

ステップ 2: API を使用して推論を実行する

// Initialization, use NLClassifierOptions to configure input and output tensors
NLClassifierOptions options =
    NLClassifierOptions.builder()
        .setBaseOptions(BaseOptions.builder().useGpu().build())
        .setInputTensorName(INPUT_TENSOR_NAME)
        .setOutputScoreTensorName(OUTPUT_SCORE_TENSOR_NAME)
        .build();
NLClassifier classifier =
    NLClassifier.createFromFileAndOptions(context, modelFile, options);

// Run inference
List<Category> results = classifier.classify(input);

NLClassifierを構成するその他のオプションについては、ソースコード をご覧ください。

Swift で推論を実行する

ステップ 1: CocoaPods をインポートする

Podfile に TensorFlowLiteTaskText ポッドを追加します

target 'MySwiftAppWithTaskAPI' do
  use_frameworks!
  pod 'TensorFlowLiteTaskText', '~> 0.4.4'
end

ステップ 2: API を使用して推論を実行する

// Initialization
var modelOptions:TFLNLClassifierOptions = TFLNLClassifierOptions()
modelOptions.inputTensorName = inputTensorName
modelOptions.outputScoreTensorName = outputScoreTensorName
let nlClassifier = TFLNLClassifier.nlClassifier(
      modelPath: modelPath,
      options: modelOptions)

// Run inference
let categories = nlClassifier.classify(text: input)

詳細についてはソースコードをご覧ください。

C++ で推論を実行する

// Initialization
NLClassifierOptions options;
options.mutable_base_options()->mutable_model_file()->set_file_name(model_path);
std::unique_ptr<NLClassifier> classifier = NLClassifier::CreateFromOptions(options).value();

// Run inference with your input, `input_text`.
std::vector<core::Category> categories = classifier->Classify(input_text);

詳細についてはソースコードをご覧ください。

Python で推論を実行する

ステップ 1: pip パッケージをインストールする

pip install tflite-support

ステップ 2: モデルを使用する

# Imports
from tflite_support.task import text

# Initialization
classifier = text.NLClassifier.create_from_file(model_path)

# Run inference
text_classification_result = classifier.classify(text)

NLClassifier を構成するその他のオプションについては、ソースコードをご覧ください。

結果の例

これは、映画レビューモデルの分類結果の例です。

入力：時間の無駄。

出力：

category[0]: 'Negative' : '0.81313'
category[1]: 'Positive' : '0.18687'

独自のモデルとテストデータを使用して、シンプルな NLClassifier 用 CLI デモツールをお試しください。

モデルの互換性要件

ユースケースに応じて、NLClassifier API は、TFLite モデルメタデータの有無に関係なく、TFLite モデルを読み込めます。TensorFlow Lite Metadata Writer API を使用して自然言語分類器のメタデータを作成する例をご覧ください。

互換性のあるモデルは、次の要件を満たす必要があります。

  • 入力テンソル：(kTfLiteString/kTfLiteInt32)

    • モデルの入力は、kTfLiteString テンソル生入力文字列または生入力文字列の正規表現トークン化インデックス用の kTfLiteInt32 テンソルのいずれかである必要があります。
    • 入力型が kTfLiteString の場合、モデルにメタデータは必要ありません。
    • 入力型が kTfLiteInt32 の場合、RegexTokenizer を入力テンソルのメタデータに設定する必要があります。

  • 出力スコアテンソル：(kTfLiteUInt8/kTfLiteInt8/kTfLiteInt16/kTfLiteFloat32/kTfLiteFloat64)

    • 分類された各カテゴリのスコアの必須出力テンソル。

    • 型が Int 型のいずれかである場合は、対応するプラットフォームに倍精度/浮動小数点数で非量子化します。

    • カテゴリラベルの出力テンソルの対応するメタデータにオプションの関連ファイルを含めることができます。ファイルは 1 行に 1 つのラベルを持つプレーンテキストファイルである必要があり、ラベルの数はモデル出力としてカテゴリの数と一致する必要があります。サンプルラベルファイルをご覧ください。

  • 出力ラベルテンソル：(kTfLiteString/kTfLiteInt32)

    • 各カテゴリのラベルのオプションの出力テンソルは、出力スコアテンソルと同じ長さである必要があります。このテンソルが存在しない場合、API はクラス名としてスコアインデックスを使用します。

    • 関連するラベルファイルが出力スコアテンソルのメタデータに存在する場合は無視されます。