テキスト分類モデルのトレーニング (GeoAI ツール)

サマリー

単一または複数ラベルのテキスト分類モデルをトレーニングして、非構造テキストに定義済みのカテゴリーまたはラベルを割り当てます。

使用法

このツールを使用するには、ディープラーニングフレームワークがインストールされている必要があります。 ArcGIS Pro のディープラーニングフレームワークを使用するようにコンピューターを設定するには、ArcGIS 用のディープラーニングフレームワークのインストールをご参照ください。

このツールは、既存のトレーニング済みモデルの微調整にも使用できます。
GPU を使用してこのツールを実行するには、プロセッサータイプ環境を GPU に設定します。複数の GPU が存在する場合は、代わりに GPU ID 環境を指定します。
入力は、トレーニングデータを含むテーブルまたはフィーチャクラスで、入力テキストを含むテキストフィールドとターゲットクラスラベルを含むラベルフィールドがあります。
このツールは、テキスト分類モデルのトレーニングに Transformer ベースのバックボーンを使用し、Mistral LLM を使用したプロンプト付きコンテキスト内学習をサポートしています。 Mistral バックボーンをインストールするには、「ArcGIS Mistral バックボーン」をご参照ください。
このツールの実行要件および発生する可能性のある問題の詳細については、「ディープラーニングに関するよくあるご質問 (FAQ)」をご参照ください。

ラベル	説明	データタイプ
入力テーブル	モデルの入力テキストを含むテキストフィールドと、ターゲットクラスラベルを含むラベルフィールドのある、フィーチャクラスまたはテーブル。	Feature Layer; Table View
テキストフィールド	モデルによって分類されるテキストを含む、入力フィーチャクラスまたはテーブル内のテキストフィールド。	Field
ラベルフィールド	モデルのトレーニングのためのターゲットクラスラベルを含む、入力フィーチャクラスまたはテーブル内のテキストフィールド。複数ラベルのテキスト分類の場合は、複数のテキストフィールドを指定します。	Field
出力モデル	トレーニング済みモデルが格納される出力フォルダーの場所。	Folder
事前トレーニング済みモデルファイル (オプション)	新しいモデルの微調整に使用される事前トレーニング済みモデル。入力には、Esri モデル定義ファイル (.emd) か、ディープラーニングパッケージファイル (.dlpk) を指定できます。類似したクラスを持つ事前トレーニング済みモデルは、新しいモデルに合わせて微調整することができます。事前トレーニング済みモデルは、新しいモデルのトレーニングに使用される同じモデルタイプおよびバックボーンモデルでトレーニングされている必要があります。	File
最大エポック (オプション)	モデルをトレーニングする場合の対象となるエポックの最大数。最大エポック値を 1 に設定すると、データセットがニューラルネットワークによって 1 回渡されます。デフォルト値は 5 です。	Long
モデルバックボーン (オプション)	モデルのエンコーダーとして機能し、固定長のベクトル形式で入力テキストのフィーチャ表現を抽出する、事前構成済みのニューラルネットワークを指定します。これらのベクトルは、モデルの分類ヘッドへの入力として渡されます。 bert-base-cased—モデルは BERT ニューラルネットワークを使用してトレーニングされます。 BERT は Masked Language Modeling 目的関数と Next Sentence Prediction を使用して事前トレーニングされます。 roberta-base—モデルは RoBERTa ニューラルネットワークを使用してトレーニングされます。 RoBERTa は、BERT の主要なハイパーパラメーターを変更し、小さいバッチと高い学習率により、目的の事前トレーニングと Next Sentence のトレーニングを回避します。 albert-base-v1—モデルは ALBERT ニューラルネットワークを使用してトレーニングされます。 ALBERT は、文章の一貫性 (intersentence coherence) のモデリングに焦点を当てた自己監視損失を使用しており、BERT より優れたスケーラビリティが得られます。 xlnet-base-cased—モデルは XLNet ニューラルネットワークを使用してトレーニングされます。 XLNet は、一般化された自己回帰事前トレーニング方法です。これにより、因数分解順序のすべての順列で予想される確率を最大化することで双方向のコンテキストを学習でき、BERT の欠点が克服されます。 xlm-roberta-base—モデルは XLM-RoBERTa ニューラルネットワークを使用してトレーニングされます。 XLM-RoBERTa は、100 の異なる言語でトレーニングされた多言語モデルです。一部の XLM 多言語モデルとは異なり、使用されている言語を理解して入力 ID から正しい言語を識別するための言語テンソルを必要としません。 distilroberta-base—モデルは DistilRoBERTa ニューラルネットワークを使用してトレーニングされます。 DistilRoBERTa は、OpenAI の WebText データセットの複製である OpenWebTextCorpus にのみ基づく roberta-base ニューラルネットワークの管理下で事前トレーニングされた英語モデルです。 distilbert-base-cased—モデルは DistilBERT ニューラルネットワークを使用してトレーニングされます。 DistilBERT は、より小さい汎用言語表現モデルです。 mistral—このモデルは、Mistral 大規模言語モデル (LLM) を使用して作成されます。 Mistral は、Sliding Window Attention、Grouped Query Attention、Byte-fallback BPE トークナイザーを使用するデコーダーオンリーなトランスフォーマーです。 Mistral バックボーンをインストールするには、「ArcGIS Mistral バックボーン」をご参照ください。	String
バッチサイズ (オプション)	1 回に処理されるトレーニングサンプルの数。デフォルト値は 2 です。バッチサイズを増やすと、ツールのパフォーマンスが向上します。ただし、バッチサイズの増加に伴って、使用されるメモリー量も多くなります。メモリー不足エラーが発生した場合は、より小さなバッチサイズを使用してください。	Double
モデル引数 (オプション)	モデルの初期化に使用される追加の引数。サポートされるモデル引数は `Sequence Length` です。これは、モデルのトレーニングにおいて考慮されるトレーニングデータの最大シーケンス長を設定するために使用されます。値テーブル列: Name—The name of the function argument. Value—The value of the function argument.	Value Table
学習率 (オプション)	トレーニング処理の際に調整されるモデルウェイトの量を示すステップサイズ。値を指定しない場合、最適な学習率が自動的に適用されます。	Double
検証率 (オプション)	モデルの検証に使用するトレーニングサンプルの割合。デフォルト値は、Transformer ベースのモデルバックボーンの場合は 10、Mistral バックボーンの場合は 50 です。	Double
モデルが改善を見込めなくなった時点で停止 (オプション)	モデルの改善がなくなった時点でモデルのトレーニングを停止するか、最大エポックパラメーター値に達するまでトレーニングを続行するかを指定します。オン—最大エポックパラメーター値にかかわらず、モデルの改善がなくなった時点でモデルのトレーニングを停止します。これがデフォルトです。オフ—最大エポックパラメーター値に到達するまで、モデルのトレーニングが続行されます。	Boolean
モデルバックボーンをトレーニング可能にする (オプション)	事前トレーニング済みモデルのバックボーン層が固定されるかどうかを指定します。これにより、加重とバイアスが本来の設計どおりになります。オン—バックボーン層は固定されず、トレーニングサンプルに合わせて `model_backbone` パラメーター値のウェイトとバイアスを変更できます。この処理には時間がかかりますが、通常は優れた結果が得られます。これがデフォルトです。オフ—バックボーン層は固定され、`model_backbone` パラメーター値の事前定義済みウェイトとバイアスはトレーニング中に変更されません。	Boolean
HTML タグの削除 (オプション)	HTML タグを入力テキストから削除するかどうかを指定します。オン—入力テキストの HTML タグが削除されます。これがデフォルトです。オフ—入力テキストの HTML タグは削除されません。	Boolean
URL の削除 (オプション)	URL を入力テキストから削除するかどうかを指定します。オン—入力テキストの URL が削除されます。これがデフォルトです。オフ—入力テキストの URL は削除されません。	Boolean
プロンプト (prompt) (オプション)	予測した出力を生成するために、大規模言語モデル (LLM) に与えられる特定の入力または手順。デフォルト値は、指定テキストの指定クラスへの分類です。分類用に新しいラベルを作成しないでください。	String

arcpy.geoai.TrainTextClassificationModel(in_table, text_field, label_field, out_model, {pretrained_model_file}, {max_epochs}, {model_backbone}, {batch_size}, {model_arguments}, {learning_rate}, {validation_percentage}, {stop_training}, {make_trainable}, {remove_html_tags}, {remove_urls}, {prompt})

名前	説明	データタイプ
in_table	モデルの入力テキストを含むテキストフィールドと、ターゲットクラスラベルを含むラベルフィールドのある、フィーチャクラスまたはテーブル。	Feature Layer; Table View
text_field	モデルによって分類されるテキストを含む、入力フィーチャクラスまたはテーブル内のテキストフィールド。	Field
label_field [label_field,...]	モデルのトレーニングのためのターゲットクラスラベルを含む、入力フィーチャクラスまたはテーブル内のテキストフィールド。複数ラベルのテキスト分類の場合は、複数のテキストフィールドを指定します。	Field
out_model	トレーニング済みモデルが格納される出力フォルダーの場所。	Folder
pretrained_model_file (オプション)	新しいモデルの微調整に使用される事前トレーニング済みモデル。入力には、Esri モデル定義ファイル (.emd) か、ディープラーニングパッケージファイル (.dlpk) を指定できます。類似したクラスを持つ事前トレーニング済みモデルは、新しいモデルに合わせて微調整することができます。事前トレーニング済みモデルは、新しいモデルのトレーニングに使用される同じモデルタイプおよびバックボーンモデルでトレーニングされている必要があります。	File
max_epochs (オプション)	モデルをトレーニングする場合の対象となるエポックの最大数。最大エポック値を 1 に設定すると、データセットがニューラルネットワークによって 1 回渡されます。デフォルト値は 5 です。	Long
model_backbone (オプション)	モデルのエンコーダーとして機能し、固定長のベクトル形式で入力テキストのフィーチャ表現を抽出する、事前構成済みのニューラルネットワークを指定します。これらのベクトルは、モデルの分類ヘッドへの入力として渡されます。 `bert-base-cased`—モデルは BERT ニューラルネットワークを使用してトレーニングされます。 BERT は Masked Language Modeling 目的関数と Next Sentence Prediction を使用して事前トレーニングされます。 `roberta-base`—モデルは RoBERTa ニューラルネットワークを使用してトレーニングされます。 RoBERTa は、BERT の主要なハイパーパラメーターを変更し、小さいバッチと高い学習率により、目的の事前トレーニングと Next Sentence のトレーニングを回避します。 `albert-base-v1`—モデルは ALBERT ニューラルネットワークを使用してトレーニングされます。 ALBERT は、文章の一貫性 (intersentence coherence) のモデリングに焦点を当てた自己監視損失を使用しており、BERT より優れたスケーラビリティが得られます。 `xlnet-base-cased`—モデルは XLNet ニューラルネットワークを使用してトレーニングされます。 XLNet は、一般化された自己回帰事前トレーニング方法です。これにより、因数分解順序のすべての順列で予想される確率を最大化することで双方向のコンテキストを学習でき、BERT の欠点が克服されます。 `xlm-roberta-base`—モデルは XLM-RoBERTa ニューラルネットワークを使用してトレーニングされます。 XLM-RoBERTa は、100 の異なる言語でトレーニングされた多言語モデルです。一部の XLM 多言語モデルとは異なり、使用されている言語を理解して入力 ID から正しい言語を識別するための言語テンソルを必要としません。 `distilroberta-base`—モデルは DistilRoBERTa ニューラルネットワークを使用してトレーニングされます。 DistilRoBERTa は、OpenAI の WebText データセットの複製である OpenWebTextCorpus にのみ基づく roberta-base ニューラルネットワークの管理下で事前トレーニングされた英語モデルです。 `distilbert-base-cased`—モデルは DistilBERT ニューラルネットワークを使用してトレーニングされます。 DistilBERT は、より小さい汎用言語表現モデルです。 `mistral`—このモデルは、Mistral 大規模言語モデル (LLM) を使用して作成されます。 Mistral は、Sliding Window Attention、Grouped Query Attention、Byte-fallback BPE トークナイザーを使用するデコーダーオンリーなトランスフォーマーです。 Mistral バックボーンをインストールするには、「ArcGIS Mistral バックボーン」をご参照ください。	String
batch_size (オプション)	1 回に処理されるトレーニングサンプルの数。デフォルト値は 2 です。バッチサイズを増やすと、ツールのパフォーマンスが向上します。ただし、バッチサイズの増加に伴って、使用されるメモリー量も多くなります。メモリー不足エラーが発生した場合は、より小さなバッチサイズを使用してください。	Double
model_arguments [model_arguments,...] (オプション)	モデルの初期化に使用される追加の引数。サポートされるモデル引数は `Sequence Length` です。これは、モデルのトレーニングにおいて考慮されるトレーニングデータの最大シーケンス長を設定するために使用されます。値テーブル列: `Name`—The name of the function argument. `Value`—The value of the function argument.	Value Table
learning_rate (オプション)	トレーニング処理の際に調整されるモデルウェイトの量を示すステップサイズ。値を指定しない場合、最適な学習率が自動的に適用されます。	Double
validation_percentage (オプション)	モデルの検証に使用するトレーニングサンプルの割合。デフォルト値は、Transformer ベースのモデルバックボーンの場合は 10、Mistral バックボーンの場合は 50 です。	Double
stop_training (オプション)	モデルの改善がなくなった時点でモデルのトレーニングを停止するか、`max_epochs` パラメーター値に達するまでトレーニングを続行するかを指定します。 `STOP_TRAINING`—`max_epochs` パラメーター値にかかわらず、モデルの改善がなくなった時点でモデルのトレーニングを停止します。これがデフォルトです。 `CONTINUE_TRAINING`—`max_epochs` パラメーター値に到達するまで、モデルのトレーニングは続行します。	Boolean
make_trainable (オプション)	事前トレーニング済みモデルのバックボーン層が固定されるかどうかを指定します。これにより、加重とバイアスが本来の設計どおりになります。 `TRAIN_MODEL_BACKBONE`—バックボーン層は固定されず、トレーニングサンプルに合わせて `model_backbone` パラメーター値のウェイトとバイアスを変更できます。この処理には時間がかかりますが、通常は優れた結果が得られます。これがデフォルトです。 `FREEZE_MODEL_BACKBONE`—バックボーン層は固定され、`model_backbone` パラメーター値の事前定義済みウェイトとバイアスはトレーニング中に変更されません。	Boolean
remove_html_tags (オプション)	HTML タグを入力テキストから削除するかどうかを指定します。 `REMOVE_HTML_TAGS`—入力テキストの HTML タグが削除されます。これがデフォルトです。 `DO_NOT_REMOVE_HTML_TAGS`—入力テキストの HTML タグは削除されません。	Boolean
remove_urls (オプション)	URL を入力テキストから削除するかどうかを指定します。 `REMOVE_URLS`—入力テキストの URL が削除されます。これがデフォルトです。 `DO_NOT_REMOVE_URLS`—入力テキストの URL は削除されません。	Boolean
prompt (オプション)	予測した出力を生成するために、大規模言語モデル (LLM) に与えられる特定の入力または手順。デフォルト値は、指定テキストの指定クラスへの分類です。分類用に新しいラベルを作成しないでください。	String

コードのサンプル

TrainTextClassificationModel の例 (スタンドアロンスクリプト)

次の例は、TrainTextClassificationModel 関数を使用する方法を示しています。

# Name: TrainTextClassification.py
# Description: Train a text classifier model to classify text in different
#              classes.
#
# Requirements: ArcGIS Pro Advanced license

# Import system modules
import arcpy

arcpy.env.workspace = "C:/textanalysisexamples/data"

# Set local variables
in_table = "training_data_textclassifier.csv"
out_folder = "c:\\textclassifier"

# Run Train Text Classification Model
arcpy.geoai.TrainTextClassificationModel(
    in_table, out_folder, max_epochs=2, text_field="Address",
    label_field="Country", batch_size=16)

環境

プロセッサータイプ, GPU ID

ライセンス情報

Basic: いいえ
Standard: いいえ
Advanced: はい

テキスト分類モデルのトレーニング (GeoAI ツール)

サマリー

使用法

パラメーター

環境

ライセンス情報

関連トピック