NLClassifier

パブリック クラスNLClassifier

自然言語分類タスク用の分類子 API は、文字列をさまざまなクラスに分類します。

API は、次の入出力テンソルを持つ TFLite モデルを想定しています。

  • 入力テンソル (kTfLiteString)
    • モデルの入力。文字列を受け入れます。
  • 出力スコア テンソル (kTfLiteUInt8/kTfLiteInt8/kTfLiteInt16/kTfLiteFloat32/kTfLiteFloat64/kTfLiteBool)
    • 各クラスのスコアを出力します。型が Int 型の場合は逆量子化し、Bool 型の場合は値をそれぞれ 0.0 と 1.0 に変換します。
    • ラベルのメタデータにオプションの関連ファイルを含めることができます。ファイルは 1 行に 1 つのラベルを含むプレーン テキスト ファイルである必要があり、ラベルの数はモデルが出力するカテゴリの数と一致する必要があります。出力ラベル テンソル: オプション (kTfLiteString) - 各クラスの出力クラス名は、スコアと同じ長さである必要があります。このテンソルが存在しない場合、API はスコア インデックスをクラス名として使用します。 - 出力スコア テンソルに関連付けられたラベル ファイルが既にある場合は無視されます。
  • オプションの出力ラベル テンソル (kTfLiteString/kTfLiteInt32)
    • 各クラスの出力クラス名は、スコアと同じ長さである必要があります。このテンソルが存在しない場合、API はスコア インデックスをクラス名として使用します。
    • 出力スコア テンソルに関連するラベル ファイルが既に存在する場合、無視されます。

デフォルトでは、API はNLClassifier.NLClassifierOptionsのデフォルト設定で入力/出力テンソルを検索しようとします。テンソル名はテンソル インデックスよりも優先されます。このオプションは、さまざまな TFLite モデルに合わせて構成できます。

ネストされたクラス

クラスNLClassifier.NLClassifierOptionsモデルの入力テンソルと出力テンソルを識別するオプション。

パブリックメソッド

一覧<カテゴリ>
分類(文字列テキスト)
文字列入力に対して分類を実行し、分類されたCategoryを返します。
静的NLClassifier
createFromBufferAndOptions ( ByteBuffer modelBuffer、 NLClassifier.NLClassifierOptionsオプション)
モデルByteBufferおよびNLClassifier.NLClassifierOptionsを使用してNLClassifierを作成します。
静的NLClassifier
createFromFile (コンテキスト context、文字列モデルパス)
デフォルトのNLClassifier.NLClassifierOptionsからNLClassifierを作成します。
静的NLClassifier
createFromFile (ファイルモデルファイル)
デフォルトのNLClassifier.NLClassifierOptionsからNLClassifierを作成します。
静的NLClassifier
createFromFileAndOptions (ファイルモデルファイル、 NLClassifier.NLClassifierOptionsオプション)
NLClassifier.NLClassifierOptionsからNLClassifierを作成します。
静的NLClassifier
createFromFileAndOptions (コンテキスト コンテキスト、文字列モデルパス、 NLClassifier.NLClassifierOptionsオプション)
NLClassifier.NLClassifierOptionsからNLClassifierを作成します。

継承されたメソッド

パブリックメソッド

public List <カテゴリ>分類(文字列テキスト)

文字列入力に対して分類を実行し、分類されたCategoryを返します。

パラメーター
文章モデルにテキストを入力する
戻り値
  • カテゴリ結果のリスト

public static NLClassifier createFromBufferAndOptions ( ByteBuffer modelBuffer、 NLClassifier.NLClassifierOptionsオプション)

モデルByteBufferおよびNLClassifier.NLClassifierOptionsを使用してNLClassifierを作成します。

パラメーター
モデルバッファ分類モデルの直接ByteBufferまたはMappedByteBuffer
オプションモデルの構成
戻り値
投げる
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合
IllegalArgumentExceptionモデル バッファーが直接ByteBufferまたはMappedByteBufferではない場合

public static NLClassifier createFromFile (コンテキスト context, String modelPath)

デフォルトのNLClassifier.NLClassifierOptionsからNLClassifierを作成します。

パラメーター
コンテクストAndroid コンテキスト
モデルパスアセットディレクトリを基準とした分類モデルへのパス
戻り値
投げる
IO例外モデルファイルのロードに失敗した場合
IllegalArgumentException引数が無効な場合
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合

public static NLClassifier createFromFile ( File modelFile)

デフォルトのNLClassifier.NLClassifierOptionsからNLClassifierを作成します。

パラメーター
モデルファイル分類モデルFileインスタンス
戻り値
投げる
IO例外モデルファイルのロードに失敗した場合
IllegalArgumentException引数が無効な場合
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合

public static NLClassifier createFromFileAndOptions (ファイルmodelFile、 NLClassifier.NLClassifierOptionsオプション)

NLClassifier.NLClassifierOptionsからNLClassifierを作成します。

パラメーター
モデルファイル分類モデルFileインスタンス
オプションモデルの構成
戻り値
投げる
IO例外モデルファイルのロードに失敗した場合
IllegalArgumentException引数が無効な場合
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合

public static NLClassifier createFromFileAndOptions (コンテキスト コンテキスト、文字列モデルパス、 NLClassifier.NLClassifierOptionsオプション)

NLClassifier.NLClassifierOptionsからNLClassifierを作成します。

パラメーター
コンテクストAndroid コンテキスト
モデルパスアセットディレクトリを基準とした分類モデルへのパス
オプションモデルの設定。
戻り値
投げる
IO例外モデルファイルのロードに失敗した場合
IllegalArgumentException引数が無効な場合
IllegalStateException内部エラーがある場合
ランタイム例外他に特定されていないエラーがある場合