# UDOP ## 概要 UDOPモデルは、Zineng Tang、Ziyi Yang、Guoxin Wang、Yuwei Fang、Yang Liu、Chenguang Zhu、Michael Zeng、Cha Zhang、Mohit Bansal による [Unifying Vision, Text, and Layout for Universal Document Processing](https://huggingface.co/papers/2212.02623) で提案されました。UDOPは、文書画像の分類、文書の解析、文書ビジュアル質問応答などのドキュメントAIタスクのために、[T5](t5) に基づくエンコーダーデコーダー型Transformerアーキテクチャを採用しています。 論文の抄録は以下の通りです。 Universal Document Processing (UDOP) を提案します。UDOP は、文書理解や生成を含む多様なタスク形式を統合した、テキスト、画像、レイアウトのモダリティを統合した基盤となる Document AI モデルです。UDOP は、テキストコンテンツと文書画像の間の空間的相関を利用し、画像、テキスト、レイアウトのモダリティを単一の均一な表現でモデル化します。新しい Vision-Text-Layout Transformer を用いることで、UDOP は事前学習とマルチドメインのダウンストリームタスクを、プロンプトベースのシーケンス生成スキームに統合します。UDOP は、革新的な自己教師あり目的関数を用いた大規模なラベルなし文書コーパスと、多様なラベル付きデータを用いて事前学習されています。また、UDOP はマスクド画像再構成を通じて、テキストとレイアウトのモダリティから文書画像を生成するよう学習します。私たちの知る限り、これは Document AI の分野において、1 つのモデルが同時に高品質なニューラル文書編集とコンテンツのカスタマイズを実現した初の事例です。私たちの手法は、金融レポート、学術論文、ウェブサイトなどの多様なデータドメインにおいて、文書理解や QA などの 9 つの Document AI タスクで SOTA を達成しています。UDOP は、Document Understanding Benchmark (DUE) のリーダーボードで 1 位を獲得しています。* drawing UDOPアーキテクチャ。元の論文から引用。 ## 使用のコツ - *input_ids*に加えて、[UdopForConditionalGeneration](/docs/transformers/main/ja/model_doc/udop#transformers.UdopForConditionalGeneration)は、入力トークンのバウンディングボックス（つまり2D座標）である入力`bbox`も期待します。これらは、Googleの[Tesseract](https://github.com/tesseract-ocr/tesseract)のような外部OCRエンジン（[Pythonラッパー](https://pypi.org/project/pytesseract/)が利用可能）を使用して取得できます。各バウンディングボックスは(x0, y0, x1, y1)の形式である必要があり、(x0, y0)はバウンディングボックスの左上隅の位置、(x1, y1)は右下隅の位置を表します。なお、バウンディングボックスを0〜1000のスケールに正規化する必要があります。正規化には、以下の関数を使用できます。 ```python def normalize_bbox(bbox, width, height): return [ int(1000 * (bbox[0] / width)), int(1000 * (bbox[1] / height)), int(1000 * (bbox[2] / width)), int(1000 * (bbox[3] / height)), ] ``` ここでは、`width` と `height` は、トークンが出現する元のドキュメントの幅と高さに相当します。これらは、例えば Python Image Library (PIL) ライブラリを使用して、次のように取得できます。 ```python from PIL import Image # Document can be a png, jpg, etc. PDFs must be converted to images. image = Image.open(name_of_your_document).convert("RGB") width, height = image.size ``` [UdopProcessor](/docs/transformers/main/ja/model_doc/udop#transformers.UdopProcessor) を使用すると、モデル用の画像とテキストの準備をすべて行えます。デフォルトでは、このクラスは Tesseract エンジンを使用して、指定されたドキュメントから単語とボックス（座標）のリストを抽出します。その機能は [LayoutLMv3Processor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3Processor) と同等であり、独自の OCR エンジンを使用する場合は `apply_ocr=False` を、デフォルトの OCR エンジンを使用する場合は `apply_ocr=True` を渡すことができます。すべての使用可能なユースケースについては、[LayoutLMv2 の使用ガイド](layoutlmv2#usage-layoutlmv2processor)を参照してください（`UdopProcessor` の機能は同一です）。 - 独自のOCRエンジンを使用する場合、推奨されるのは、いわゆるラインセグメントをサポートするAzureの[Read API](https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/how-to/call-read-api)です。セグメント位置埋め込みの使用により、パフォーマンスが向上する傾向があります。 - 推論時には、ドキュメント画像を指定してテキストを自己回帰的に生成するために、`generate`メソッドの使用を推奨します。 - The model has been pre-trained on both self-supervised and supervised objectives. One can use the various task prefixes (prompts) used during pre-training to test out the out-of-the-box capabilities. For instance, the model can be prompted with "Question answering. What is the date?", as "Question answering." is the task prefix used during pre-training for DocVQA. Refer to the [paper](https://huggingface.co/papers/2212.02623) (table 1) for all task prefixes. - [UdopEncoderModel](/docs/transformers/main/ja/model_doc/udop#transformers.UdopEncoderModel)もファインチューニングできます。これはUDOPのエンコーダーのみで構成される部分であり、LayoutLMv3のようなTransformerエンコーダーと見なすことができます。判別タスクでは、その上に線形分類器を追加し、ラベル付きデータセットでファインチューニングするだけです。 このモデルは [nielsr](https://huggingface.co/nielsr) によって提供されました。元のコードは [こちら](https://github.com/microsoft/UDOP) で確認できます。 ## リソース UDOPの入門を支援するための、Hugging Face公式およびコミュニティ（🌎で示されています）のリソースのリストです。ここにリソースを掲載していただくことに興味がある場合は、Pull Requestをオープンしていただければ、レビューいたします。リソースは、既存のリソースと重複するのではなく、新しいことを示すものであることが望ましいです。 - UDOPに関するデモノートブックは[こちら](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/UDOP)で確認でき、その方法を示しています UDOPのカスタムデータセットでのファインチューニングおよび推論を行う方法です。🌎 - [ドキュメント質問応答タスクガイド](../tasks/document_question_answering) ## UdopConfig[[transformers.UdopConfig]] #### transformers.UdopConfig[[transformers.UdopConfig]] ```python transformers.UdopConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, is_encoder_decoder: bool = True, vocab_size: int = 33201, d_model: int = 1024, d_kv: int = 64, d_ff: int = 4096, num_layers: int = 24, num_decoder_layers: int | None = None, num_heads: int = 16, relative_attention_num_buckets: int = 32, relative_attention_max_distance: int = 128, relative_bias_args: list[dict] | None = None, dropout_rate: float | int = 0.1, layer_norm_epsilon: float = 1e-06, initializer_factor: float = 1.0, feed_forward_proj: str = 'relu', use_cache: bool = True, pad_token_id: int | None = 0, eos_token_id: int | list[int] | None = 1, max_2d_position_embeddings: int = 1024, image_size: int | list[int] | tuple[int, int] = 224, patch_size: int | list[int] | tuple[int, int] = 16, num_channels: int = 3, is_decoder: bool = False, add_cross_attention: bool = False, tie_word_embeddings: bool = True) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/configuration_udop.py#L24) **パラメータ:** is_encoder_decoder (`bool`、*任意*、デフォルトは`True`) : モデルがエンコーダー/デコーダーとして使用されるかどうかを示します。 vocab_size (`int`、*任意*、デフォルトは`33201`) : モデルの語彙サイズ。`input_ids`で表現できるトークンの種類数を定義します。 d_model (`int`、*任意*、デフォルトは`1024`) : エンコーダ層とプーラー層のサイズ。 d_kv (`int`、*任意*、デフォルトは`64`) : アテンションヘッドごとのキー、クエリ、バリューの射影サイズ。射影層の`inner_dim`は`num_heads * d_kv`として定義されます。 d_ff (`int`、*任意*、デフォルトは`4096`) : MLP 表現の次元数。 num_layers (`int`、*optional*、デフォルトは `24`) : Transformer デコーダーの隠れ層の数。 num_decoder_layers (`int`, *optional*) : Transformerデコーダーの隠れ層の数。設定されていない場合は、`num_layers`と同じ値が使用されます。 num_heads (`int`、*任意*、デフォルトは`16`) : Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。 relative_attention_num_buckets (`int`、*optional*、デフォルトは 32) : 各アテンション層で使用するバケット数。 relative_attention_max_distance (`int`、*optional*、デフォルトは 128) : バケット分離における、長いシーケンスの最大距離。 relative_bias_args (`list[dict]`、*任意*、デフォルトは`[{'type' : '1d'}, {'type': 'horizontal'}, {'type': 'vertical'}]`): 相対バイアス層の引数を含む辞書のリスト。 dropout_rate (`Union[float, int]`、*任意*、デフォルトは`0.1`) : すべての dropout 層の比率。 layer_norm_epsilon (`float`、*任意*、デフォルトは`1e-06`) : Layer Normalization 層で使用する epsilon です。 initializer_factor (`float`、*任意*、デフォルトは`1.0`) : すべての重み行列を初期化する係数です（1に保つ必要があります。初期化テスト用に内部で使用されます）。 feed_forward_proj (`string`、*任意*、デフォルトは`"relu"`) : 使用するフィードフォワード層の種類。`"relu"`または`"gated-gelu"`のいずれかである必要があります。Udopv1.1は`"gated-gelu"`フィードフォワード投影を使用します。元のUdopは`"relu"`を使用します。 use_cache (`bool`、*任意*、デフォルトは `True`) : モデルが最後のキー/バリューアテンションを返すかどうか（すべてのモデルで利用されるわけではありません）。`config.is_decoder=True` の場合、またはモデルがデコーダー専用の生成モデルである場合にのみ関連します。 pad_token_id (`int`, *任意*, デフォルトは `0`) : 語彙内でパディングに使用されるトークン ID。 eos_token_id (`Union[int, list[int]]`、*任意*、デフォルトは `1`) : 語彙内でストリーム終了に使用されるトークン ID。 max_2d_position_embeddings (`int`、*optional*、デフォルトは 1024) : 相対位置エンコーディングにおける絶対位置埋め込みの最大値です。 image_size (`Union[int, list[int], tuple[int, int]]`、*任意*、デフォルトは`224`) : 各画像のサイズ（解像度）。 patch_size (`Union[int, list[int], tuple[int, int]]`、*任意*、デフォルトは`16`) : 各パッチのサイズ（解像度）。 num_channels (`int`、*任意*、デフォルトは`3`) : 入力チャネル数。 is_decoder (`bool`, *任意*, デフォルトは `False`) : モデルがデコーダーとして使用されるかどうかを指定します。`False` の場合、モデルはエンコーダーとして使用されます。 add_cross_attention (`bool`、*任意*、デフォルトは`False`) : モデルにクロスアテンション層を追加するかどうか。 tie_word_embeddings (`bool`、*任意*、デフォルトは`True`) : モデルの`tied_weights_keys`マッピングに従って重み埋め込みを共有するかどうか。 これは UdopModel の設定を保存するための設定クラスです。指定された引数に基づいて Udop モデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[microsoft/udop-large](https://huggingface.co/microsoft/udop-large) と同様の設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 ## UdopTokenizer[[transformers.UdopTokenizer]] #### transformers.UdopTokenizer[[transformers.UdopTokenizer]] ```python transformers.UdopTokenizer(vocab: str | list[tuple[str, float]] | None = None, eos_token = '', sep_token = '', unk_token = '', pad_token = '', sep_token_box = [1000, 1000, 1000, 1000], pad_token_box = [0, 0, 0, 0], pad_token_label = -100, only_label_first_subword = True, extra_special_tokens = None, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/tokenization_udop.py#L139) **パラメータ:** eos_token (`str`、*任意*、デフォルトは`""`) : シーケンスの終了トークン。特殊トークンを使用してシーケンスを構築する場合は、シーケンスの終了に使用されるトークンではありません。使用されるトークンは`sep_token`です。 sep_token (`str`、*任意*、デフォルトは `""`) : 区切りトークンです。複数のシーケンスからシーケンスを構築する際に使用されます。例えば、シーケンス分類では2つのシーケンス、質問応答ではテキストと質問です。また、特殊トークンを用いて構築されたシーケンスの最後のトークンとしても使用されます。 unk_token (`str`、*任意*、デフォルトは `""`) : 不明トークン。語彙に存在しないトークンは ID に変換できず、代わりにこのトークンが設定されます。 pad_token (`str`、*任意*、デフォルトは `""`) : パディングに使用されるトークンです。長さの異なるシーケンスをバッチ処理する場合などに使用します。 sep_token_box (`list[int]`、*任意*、デフォルトは`[1000, 1000, 1000, 1000]`) : 特殊トークン [SEP] に使用するバウンディングボックス。 pad_token_box (`list[int]`、*任意*、デフォルトは `[0, 0, 0, 0]`) : 特殊トークン [PAD] に使用するバウンディングボックス。 pad_token_label (`int`、*任意*、デフォルトは -100) : パディングトークンに使用するラベルです。デフォルトは -100 で、これは PyTorch の CrossEntropyLoss の `ignore_index` です。 only_label_first_subword (`bool`、*任意*、デフォルトは `True`) : ワードラベルが提供されている場合、最初のサブワードのみをラベル付けするかどうか。 extra_special_tokens (`list[str]`、*任意*、デフォルトは `["NOTUSED", "NOTUSED"]`) : トークナイザーで使用される追加の特殊トークン。 HuggingFaceの*tokenizers*ライブラリをベースにした「高速な」UDOPトークナイザーを構築します。[LayoutXLMTokenizer](/docs/transformers/main/ja/model_doc/layoutxlm#transformers.LayoutXLMTokenizer)および[T5Tokenizer](/docs/transformers/main/ja/model_doc/t5#transformers.T5Tokenizer)を参考にしています。[BPE](https://huggingface.co/docs/tokenizers/python/latest/components.html?highlight=BPE#models)に基づいています。 このトークナイザーは、[TokenizersBackend](/docs/transformers/main/ja/main_classes/tokenizer#transformers.TokenizersBackend) を継承しており、主要なメソッドの大部分がそこに含まれています。これらのメソッドに関する詳細については、このスーパークラスを参照してください。 #### build_inputs_with_special_tokens[[transformers.UdopTokenizer.build_inputs_with_special_tokens]] ```python build_inputs_with_special_tokens(token_ids_0: list, token_ids_1: list[int] | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/tokenization_udop.py#L972) **パラメータ:** token_ids_0 (`list[int]`) : 特殊トークンが追加されるIDのリスト。 token_ids_1 (`list[int]`, *任意*) : シーケンスペア用の任意の第2のIDリスト。 **戻り値:** `list[int]` 適切な特殊トークンを含む[入力 ID](../glossary#input-ids)のリスト。 シーケンス分類タスクにおいて、シーケンスまたはシーケンスのペアからモデルの入力を構築するために、特殊トークンを追加して連結します。XLM-RoBERTa のシーケンスは、次の形式を持ちます: - 単一シーケンス: ` X ` - シーケンスのペア: ` A B ` #### get_special_tokens_mask[[transformers.UdopTokenizer.get_special_tokens_mask]] ```python get_special_tokens_mask(token_ids_0: list[int], token_ids_1: list[int] | None = None, already_has_special_tokens: bool = False) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/tokenization_utils_base.py#L1338) **パラメータ:** token_ids_0 : (すでにフォーマット済みの可能性がある) シーケンスの ID のリスト。 token_ids_1 `already_has_special_tokens=True` の場合は使用されません。その場合は None でなければなりません。 already_has_special_tokens : シーケンスがすでに特殊トークンでフォーマットされているかどうか。 **戻り値:** 範囲 [0, 1] 内の整数のリスト 特殊トークンには1、シーケンストークンには0を指定します。 特殊トークンが追加されていないトークンリストからシーケンスIDを取得します。 高速なトークナイザーでは、データコラテーターは`already_has_special_tokens=True`を指定してこの関数を呼び出し、すでに整形済みのシーケンスに対してマスクを構築します。その場合、`all_special_ids`への所属を確認することによってマスクを計算します。 #### create_token_type_ids_from_sequences[[transformers.UdopTokenizer.create_token_type_ids_from_sequences]] ```python create_token_type_ids_from_sequences(token_ids_0: list, token_ids_1: list[int] | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/tokenization_udop.py#L997) **パラメータ:** token_ids_0 (`list[int]`) : ID のリスト。 token_ids_1 (`list[int]`, *任意*) : シーケンスペア用の任意の第2のIDリスト。 **戻り値:** `list[int]` ゼロのリスト。 シーケンスペア分類タスクで使用するために、渡された2つのシーケンスからマスクを作成します。XLM-RoBERTaはトークンタイプIDを使用しないため、ゼロのリストが返されます。 #### save_vocabulary[[transformers.UdopTokenizer.save_vocabulary]] ```python save_vocabulary(save_directory: str, filename_prefix: str | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/tokenization_udop.py#L1021) トークナイザの語彙ファイルを保存します。TokenizersBackendの場合、tokenizer.jsonファイルはベースクラスによって保存されます。このメソッドは、tokenizer.jsonのみを使用するため、空のタプルを返します。 ## UdopProcessor[[transformers.UdopProcessor]] #### transformers.UdopProcessor[[transformers.UdopProcessor]] ```python transformers.UdopProcessor(image_processor, tokenizer) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/processing_udop.py#L53) **パラメータ:** image_processor (`LayoutLMv3ImageProcessor`) : 画像プロセッサは必須の入力です。 tokenizer (`UdopTokenizer`) : トークナイザーは必須の入力です。 UdopProcessorを構築します。画像プロセッサとトークナイザーを単一のプロセッサにラップします。 [UdopProcessor](/docs/transformers/main/ja/model_doc/udop#transformers.UdopProcessor) は、[LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) と [UdopTokenizer](/docs/transformers/main/ja/model_doc/udop#transformers.UdopTokenizer) のすべての機能を提供します。詳細については、[~LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) および [~UdopTokenizer](/docs/transformers/main/ja/model_doc/udop#transformers.UdopTokenizer) を参照してください。 #### __call__[[transformers.UdopProcessor.__call__]] ```python __call__(images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], NoneType] = None, text: str | list[str] | list[list[str]] = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/processing_udop.py#L72) **パラメータ:** images (`Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list[PIL.Image.Image], list[numpy.ndarray], list[torch.Tensor]]`, *任意*) : 前処理を行う画像。ピクセル値が 0 から 255 の範囲にある単一の画像またはバッチの画像を想定しています。ピクセル値が 0 から 1 の範囲にある画像を渡す場合は、`do_rescale=False` を設定してください。 text (`Union[str, list[str], list[list[str]]]`、*任意*) : エンコード対象のシーケンスまたはシーケンスのバッチです。各シーケンスは文字列、または文字列のリスト（プレトークナイズ済み文字列）であることができます。プレトークナイズ済み入力を渡す場合は、バッチ入力との曖昧さを避けるために `is_split_into_words=True` を設定してください。 return_tensors (`str` または [TensorType](/docs/transformers/main/ja/internal/file_utils#transformers.TensorType)、*optional*) : 設定されている場合、特定のフレームワークのテンソルを返します。受け入れ可能な値は以下の通りです: - `'pt'`: PyTorch の `torch.Tensor` オブジェクトを返します。 - `'np'`: NumPy の `np.ndarray` オブジェクトを返します。 - ****kwargs** ([ProcessingKwargs](/docs/transformers/main/ja/main_classes/processors#transformers.ProcessingKwargs), *optional*) : 各モダリティ（テキスト、画像、動画、音声）の追加処理オプション。モデル固有のパラメータは上記にリストされています。サポートされている引数の完全なリストについては、TypedDict クラスを参照してください。 **戻り値:** `~image_processing_base.BatchFeature` - **data** (`dict`) -- __call__ メソッドによって返されるリスト/配列/テンソルの辞書（'pixel_values' など）。 - **tensor_type** (`Union[None, str, TensorType]`、*省略可*) -- 初期化時に PyTorch/Numpy の Tensor 内の整数リストを変換するために、ここで tensor_type を指定できます。 ## UdopModel[[transformers.UdopModel]] #### transformers.UdopModel[[transformers.UdopModel]] ```python transformers.UdopModel(config: UdopConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/modeling_udop.py#L1251) **パラメータ:** config ([UdopConfig](/docs/transformers/main/ja/model_doc/udop#transformers.UdopConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 特定のヘッドを付加せず、生の隠れ状態を出力する素の Udop Model。 このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。 このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。 #### forward[[transformers.UdopModel.forward]] ```python forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, bbox: dict[str, typing.Any] | None = None, pixel_values: typing.Optional[torch.Tensor] = None, visual_bbox: dict[str, typing.Any] | None = None, decoder_input_ids: typing.Optional[torch.Tensor] = None, decoder_attention_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, encoder_outputs: typing.Optional[torch.Tensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, decoder_inputs_embeds: typing.Optional[torch.Tensor] = None, use_cache: bool | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/modeling_udop.py#L1287) **パラメータ:** input_ids (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : 語彙における入力シーケンスのトークンインデックスです。デフォルトでは、パディングは無視されます。インデックスは [AutoTokenizer](/docs/transformers/main/ja/model_doc/auto#transformers.AutoTokenizer) を使用して取得できます。詳細については、[PreTrainedTokenizer.encode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) および [PreTrainedTokenizer.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) を参照してください。 [入力IDとは何ですか？](../glossary#input-ids) attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) bbox (`torch.LongTensor`、shape `({0}, 4)`、*optional*) : 各入力シーケンスのトークンのバウンディングボックス。`[0, config.max_2d_position_embeddings-1]` の範囲で選択されます。各バウンディングボックスは (x0, y0, x1, y1) 形式の正規化された値であるべきで、(x0, y0) はバウンディングボックスの左上隅の位置に対応し、(x1, y1) は右下隅の位置を表します。なお、`sequence_length = token_sequence_length + patch_sequence_length + 1` であり、`1` は [CLS] トークン用のものです。`patch_sequence_length` については `pixel_values` を参照してください。 pixel_values (`torch.Tensor`、形状 `(batch_size, num_channels, image_size, image_size)`、*任意*) : 入力画像に対応するテンソルです。ピクセル値は [LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) を使用して取得できます。詳細については [LayoutLMv3ImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[UdopProcessor](/docs/transformers/main/ja/model_doc/udop#transformers.UdopProcessor) は画像の処理に [LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) を使用します）。 visual_bbox (`torch.LongTensor`、形状 `(batch_size, patch_sequence_length, 4)`、*任意*) : 画像内の各パッチのバウンディングボックス。指定されない場合、モデル内でバウンディングボックスが作成されます。 decoder_input_ids (`torch.LongTensor`、shape `(batch_size, target_sequence_length)`、*任意*) : 語彙におけるデコーダー入力シーケンスのトークンインデックスです。インデックスは [AutoTokenizer](/docs/transformers/main/ja/model_doc/auto#transformers.AutoTokenizer) を使用して取得できます。詳細については、[PreTrainedTokenizer.encode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) および [PreTrainedTokenizer.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) を参照してください。[デコーダー入力 ID とは何か？](../glossary#decoder-input-ids) T5 は、`decoder_input_ids` の生成の開始トークンとして `pad_token_id` を使用します。`past_key_values` を使用する場合、任意で最後の `decoder_input_ids` だけを入力すれば十分です（`past_key_values` を参照）。事前学習のために `decoder_input_ids` を準備する方法については、[T5 Training](./t5#training) をご覧ください。 decoder_attention_mask (`torch.BoolTensor`、shape `(batch_size, target_sequence_length)`、*任意*) : デフォルトの動作: `decoder_input_ids`内のpadトークンを無視するテンソルを生成します。デフォルトでは、causal maskも使用されます。 inputs_embeds (`torch.Tensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 encoder_outputs (`torch.Tensor`, *任意*) : (`last_hidden_state`, *任意*: `hidden_states`, *任意*: `attentions`) のタプル。`last_hidden_state` は形状 `(batch_size, sequence_length, hidden_size)` を持ち、エンコーダーの最終層の出力における隠れ状態のシーケンスです。*任意*デコーダーのクロスアテンションで使用されます。 past_key_values (`~cache_utils.Cache`, *任意*) : 逐次デコードを高速化するために使用できる、事前計算された hidden-states（self-attention ブロックおよび cross-attention ブロック内の key と value）です。通常、`use_cache=True` または `config.use_cache=True` の場合、モデルがデコードの以前の段階で返した `past_key_values` で構成されます。入力として許可されるのは [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) インスタンスのみです。[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。`past_key_values` が渡されない場合、デフォルトで [DynamicCache](/docs/transformers/main/ja/internal/generation_utils#transformers.DynamicCache) が初期化されます。モデルは、入力として与えられたのと同じキャッシュ形式を出力します。`past_key_values` を使用する場合は、すべての `input_ids`（形状 `(batch_size, sequence_length)`）の代わりに、このモデルに過去の key value 状態が与えられていない未処理の `input_ids`（形状 `(batch_size, unprocessed_length)`）のみを入力する必要があります。 decoder_inputs_embeds (`torch.Tensor`、shape `(batch_size, target_sequence_length, hidden_size)`、*任意*) : `decoder_input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。`past_key_values` を使用する場合、`decoder_inputs_embeds` の最後の部分のみを入力すればよい場合があります（`past_key_values` を参照）。`decoder_input_ids` のインデックスを関連するベクトルに変換する方法を、モデル内部の埋め込みルックアップ行列よりも細かく制御したい場合に便利です。 `decoder_input_ids` と `decoder_inputs_embeds` の両方が設定されていない場合、`decoder_inputs_embeds` は `inputs_embeds` の値を採ります。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 **戻り値:** [Seq2SeqModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqModelOutput) または `tuple(torch.FloatTensor)` 設定（[UdopConfig](/docs/transformers/main/ja/model_doc/udop#transformers.UdopConfig)）や入力に応じて、さまざまな要素で構成される [Seq2SeqModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqModelOutput) または `torch.FloatTensor` のタプル（`return_dict=False` が渡された場合、または `config.return_dict=False` の場合）。 [UdopModel](/docs/transformers/main/ja/model_doc/udop#transformers.UdopModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`) -- モデルのデコーダーの最終層の出力における、隠れ状態のシーケンス。 `past_key_values`が使用されている場合、出力されるのは、形状`(batch_size, 1, hidden_size)`のシーケンスの最後の隠れ状態のみです。 - **past_key_values** (`EncoderDecoderCache`、*任意*、`use_cache=True` が渡された場合または `config.use_cache=True` の場合に返されます) -- [EncoderDecoderCache](/docs/transformers/main/ja/internal/generation_utils#transformers.EncoderDecoderCache) のインスタンスです。詳細については、[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。 逐次デコーディングを高速化するために使用できる（`past_key_values` 入力参照）、事前計算済みの隠れ状態（自己アテンションブロックおよびクロスアテンションブロックのキーとバリュー）が含まれます。 - **decoder_hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返される) -- `torch.FloatTensor` のタプル（モデルに埋め込み層がある場合はその出力用 + 各層の出力用）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力におけるデコーダーのHidden-states、および任意の初期埋め込み出力。 - **decoder_attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 自己アテンションヘッドにおける加重平均を計算するために使用される、アテンションのsoftmax後のデコーダーのアテンション重み。 - **cross_attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。 クロスアテンション層のアテンション重みは、アテンションのsoftmax適用後に計算され、クロスアテンションヘッドにおける加重平均の計算に使用されます。 - **encoder_last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*optional*) -- モデルのエンコーダーの最終層の出力における、隠れ状態のシーケンス。 - **encoder_hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力におけるエンコーダーのHidden-states、および任意の初期埋め込み出力。 - **encoder_attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。 アテンションのsoftmaxを適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。 例: ```python >>> from transformers import AutoProcessor, AutoModel >>> from datasets import load_dataset >>> import torch >>> # load model and processor >>> # in this case, we already have performed OCR ourselves >>> # so we initialize the processor with `apply_ocr=False` >>> processor = AutoProcessor.from_pretrained("microsoft/udop-large", apply_ocr=False) >>> model = AutoModel.from_pretrained("microsoft/udop-large") >>> # load an example image, along with the words and coordinates >>> # which were extracted using an OCR engine >>> dataset = load_dataset("nielsr/funsd-layoutlmv3", split="train") >>> example = dataset[0] >>> image = example["image"] >>> words = example["tokens"] >>> boxes = example["bboxes"] >>> inputs = processor(image, words, boxes=boxes, return_tensors="pt") >>> decoder_input_ids = torch.tensor([[model.config.decoder_start_token_id]]) >>> # forward pass >>> outputs = model(**inputs, decoder_input_ids=decoder_input_ids) >>> last_hidden_states = outputs.last_hidden_state >>> list(last_hidden_states.shape) [1, 1, 1024] ``` ## UdopForConditionalGeneration[[transformers.UdopForConditionalGeneration]] #### transformers.UdopForConditionalGeneration[[transformers.UdopForConditionalGeneration]] ```python transformers.UdopForConditionalGeneration(config: UdopConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/modeling_udop.py#L1405) **パラメータ:** config ([UdopConfig](/docs/transformers/main/ja/model_doc/udop#transformers.UdopConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 UDOPエンコーダー・デコーダーTransformerの上部に言語モデリングヘッドを備え、ドキュメント画像と任意のプロンプトを指定することでテキストを生成できるようにします。 このクラスは[T5ForConditionalGeneration](/docs/transformers/main/ja/model_doc/t5#transformers.T5ForConditionalGeneration)をベースとしており、画像およびレイアウト（2D）データに対応するように拡張されています。 このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。 このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。 #### forward[[transformers.UdopForConditionalGeneration.forward]] ```python forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, bbox: dict[str, typing.Any] | None = None, pixel_values: typing.Optional[torch.Tensor] = None, visual_bbox: dict[str, typing.Any] | None = None, decoder_input_ids: typing.Optional[torch.Tensor] = None, decoder_attention_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, encoder_outputs: typing.Optional[torch.Tensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, decoder_inputs_embeds: typing.Optional[torch.Tensor] = None, use_cache: bool | None = None, labels: typing.Optional[torch.Tensor] = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/modeling_udop.py#L1447) **パラメータ:** input_ids (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : 語彙における入力シーケンスのトークンインデックスです。デフォルトでは、パディングは無視されます。インデックスは [AutoTokenizer](/docs/transformers/main/ja/model_doc/auto#transformers.AutoTokenizer) を使用して取得できます。詳細については、[PreTrainedTokenizer.encode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) および [PreTrainedTokenizer.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) を参照してください。 [入力IDとは何ですか？](../glossary#input-ids) attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) bbox (`torch.LongTensor`、shape `({0}, 4)`、*optional*) : 各入力シーケンスのトークンのバウンディングボックス。`[0, config.max_2d_position_embeddings-1]` の範囲で選択されます。各バウンディングボックスは (x0, y0, x1, y1) 形式の正規化された値であるべきで、(x0, y0) はバウンディングボックスの左上隅の位置に対応し、(x1, y1) は右下隅の位置を表します。なお、`sequence_length = token_sequence_length + patch_sequence_length + 1` であり、`1` は [CLS] トークン用のものです。`patch_sequence_length` については `pixel_values` を参照してください。 pixel_values (`torch.Tensor`、形状 `(batch_size, num_channels, image_size, image_size)`、*任意*) : 入力画像に対応するテンソルです。ピクセル値は [LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) を使用して取得できます。詳細については [LayoutLMv3ImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[UdopProcessor](/docs/transformers/main/ja/model_doc/udop#transformers.UdopProcessor) は画像の処理に [LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) を使用します）。 visual_bbox (`torch.LongTensor`、形状 `(batch_size, patch_sequence_length, 4)`、*任意*) : 画像内の各パッチのバウンディングボックス。指定されない場合、モデル内でバウンディングボックスが作成されます。 decoder_input_ids (`torch.LongTensor`、shape `(batch_size, target_sequence_length)`、*任意*) : 語彙におけるデコーダー入力シーケンスのトークンインデックスです。インデックスは [AutoTokenizer](/docs/transformers/main/ja/model_doc/auto#transformers.AutoTokenizer) を使用して取得できます。詳細については、[PreTrainedTokenizer.encode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) および [PreTrainedTokenizer.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) を参照してください。[デコーダー入力 ID とは何か？](../glossary#decoder-input-ids) T5 は、`decoder_input_ids` の生成の開始トークンとして `pad_token_id` を使用します。`past_key_values` を使用する場合、任意で最後の `decoder_input_ids` だけを入力すれば十分です（`past_key_values` を参照）。事前学習のために `decoder_input_ids` を準備する方法については、[T5 Training](./t5#training) をご覧ください。 decoder_attention_mask (`torch.BoolTensor`、shape `(batch_size, target_sequence_length)`、*任意*) : デフォルトの動作: `decoder_input_ids`内のpadトークンを無視するテンソルを生成します。デフォルトでは、causal maskも使用されます。 inputs_embeds (`torch.Tensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 encoder_outputs (`torch.Tensor`, *任意*) : (`last_hidden_state`, *任意*: `hidden_states`, *任意*: `attentions`) のタプル。`last_hidden_state` は形状 `(batch_size, sequence_length, hidden_size)` を持ち、エンコーダーの最終層の出力における隠れ状態のシーケンスです。*任意*デコーダーのクロスアテンションで使用されます。 past_key_values (`~cache_utils.Cache`, *任意*) : 逐次デコードを高速化するために使用できる、事前計算された hidden-states（self-attention ブロックおよび cross-attention ブロック内の key と value）です。通常、`use_cache=True` または `config.use_cache=True` の場合、モデルがデコードの以前の段階で返した `past_key_values` で構成されます。入力として許可されるのは [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) インスタンスのみです。[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。`past_key_values` が渡されない場合、デフォルトで [DynamicCache](/docs/transformers/main/ja/internal/generation_utils#transformers.DynamicCache) が初期化されます。モデルは、入力として与えられたのと同じキャッシュ形式を出力します。`past_key_values` を使用する場合は、すべての `input_ids`（形状 `(batch_size, sequence_length)`）の代わりに、このモデルに過去の key value 状態が与えられていない未処理の `input_ids`（形状 `(batch_size, unprocessed_length)`）のみを入力する必要があります。 decoder_inputs_embeds (`torch.Tensor`、shape `(batch_size, target_sequence_length, hidden_size)`、*任意*) : `decoder_input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。`past_key_values` を使用する場合、`decoder_inputs_embeds` の最後の部分のみを入力すればよい場合があります（`past_key_values` を参照）。`decoder_input_ids` のインデックスを関連するベクトルに変換する方法を、モデル内部の埋め込みルックアップ行列よりも細かく制御したい場合に便利です。 `decoder_input_ids` と `decoder_inputs_embeds` の両方が設定されていない場合、`decoder_inputs_embeds` は `inputs_embeds` の値を採ります。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 labels (`torch.LongTensor`、形状 `(batch_size,)`、*任意*) : 言語モデリング損失の計算に使用するラベル。インデックスは `[-100, 0, ..., config.vocab_size - 1]` の範囲である必要があります。`-100` に設定されたすべてのラベルは無視（マスク）され、損失は `[0, ..., config.vocab_size]` 内のラベルに対してのみ計算されます。 **戻り値:** [Seq2SeqLMOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput) または `tuple(torch.FloatTensor)` 設定（[UdopConfig](/docs/transformers/main/ja/model_doc/udop#transformers.UdopConfig)）や入力に応じて、さまざまな要素で構成される、[Seq2SeqLMOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput) または `torch.FloatTensor` のタプル（`return_dict=False` が渡された場合、または `config.return_dict=False` の場合）。 [UdopForConditionalGeneration](/docs/transformers/main/ja/model_doc/udop#transformers.UdopForConditionalGeneration)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **loss** (`torch.FloatTensor`、shape `(1,)`、*optional*、`labels` が指定された場合に返されます) -- 言語モデリングの損失。 - **logits** (`torch.FloatTensor`、shape `(batch_size, sequence_length, config.vocab_size)`) -- 言語モデリングヘッドの予測スコア（SoftMax 適用前の各語彙トークンのスコア）。 - **past_key_values** (`EncoderDecoderCache`、*任意*、`use_cache=True` が渡された場合または `config.use_cache=True` の場合に返されます) -- [EncoderDecoderCache](/docs/transformers/main/ja/internal/generation_utils#transformers.EncoderDecoderCache) のインスタンスです。詳細については、[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。 逐次デコーディングを高速化するために使用できる（`past_key_values` 入力参照）、事前計算済みの隠れ状態（自己アテンションブロックおよびクロスアテンションブロックのキーとバリュー）が含まれます。 - **decoder_hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返される) -- `torch.FloatTensor` のタプル（モデルに埋め込み層がある場合はその出力用 + 各層の出力用）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力および初期埋め込み出力における、デコーダーの隠れ状態。 - **decoder_attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 自己アテンションヘッドにおける加重平均を計算するために使用される、アテンションのsoftmax後のデコーダーのアテンション重み。 - **cross_attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。 クロスアテンション層のアテンション重みは、アテンションのsoftmax適用後に計算され、クロスアテンションヘッドにおける加重平均の計算に使用されます。 - **encoder_last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*optional*) -- モデルのエンコーダーの最終層の出力における、隠れ状態のシーケンス。 - **encoder_hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力および初期埋め込み出力におけるエンコーダーの隠れ状態。 - **encoder_attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。 アテンションのsoftmaxを適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。 例: ```python >>> from transformers import AutoProcessor, UdopForConditionalGeneration >>> from datasets import load_dataset >>> # load model and processor >>> # in this case, we already have performed OCR ourselves >>> # so we initialize the processor with `apply_ocr=False` >>> processor = AutoProcessor.from_pretrained("microsoft/udop-large", apply_ocr=False) >>> model = UdopForConditionalGeneration.from_pretrained("microsoft/udop-large") >>> # load an example image, along with the words and coordinates >>> # which were extracted using an OCR engine >>> dataset = load_dataset("nielsr/funsd-layoutlmv3", split="train") >>> example = dataset[0] >>> image = example["image"] >>> words = example["tokens"] >>> boxes = example["bboxes"] >>> # one can use the various task prefixes (prompts) used during pre-training >>> # e.g. the task prefix for DocVQA is "Question answering. " >>> question = "Question answering. What is the date on the form?" >>> encoding = processor(image, question, text_pair=words, boxes=boxes, return_tensors="pt") >>> # autoregressive generation >>> predicted_ids = model.generate(**encoding) >>> print(processor.batch_decode(predicted_ids, skip_special_tokens=True)[0]) 9/30/92 ``` ## UdopEncoderModel[[transformers.UdopEncoderModel]] #### transformers.UdopEncoderModel[[transformers.UdopEncoderModel]] ```python transformers.UdopEncoderModel(config: UdopConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/modeling_udop.py#L1579) **パラメータ:** config ([UdopConfig](/docs/transformers/main/ja/model_doc/udop#transformers.UdopConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 特定のヘッドを付加せず、生の隠れ状態を出力する素の Udop Model。 このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。 このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。 #### forward[[transformers.UdopEncoderModel.forward]] ```python forward(input_ids: typing.Optional[torch.Tensor] = None, bbox: dict[str, typing.Any] | None = None, attention_mask: typing.Optional[torch.Tensor] = None, pixel_values: typing.Optional[torch.Tensor] = None, visual_bbox: dict[str, typing.Any] | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/udop/modeling_udop.py#L1610) **パラメータ:** input_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`) : 語彙における入力シーケンスのトークンインデックスです。T5 は相対位置埋め込みを持つモデルであるため、入力の右側と左側の両方にパディングを適用できます。インデックスは [AutoTokenizer](/docs/transformers/main/ja/model_doc/auto#transformers.AutoTokenizer) を使用して取得できます。詳細については、[PreTrainedTokenizer.encode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) および [PreTrainedTokenizer.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) を参照してください。事前学習のために `input_ids` を準備する方法については、[T5 Training](./t5#training) をご覧ください。 bbox (`torch.LongTensor`、shape `({0}, 4)`、*optional*) : 各入力シーケンスのトークンのバウンディングボックス。`[0, config.max_2d_position_embeddings-1]` の範囲で選択されます。各バウンディングボックスは (x0, y0, x1, y1) 形式の正規化された値であるべきで、(x0, y0) はバウンディングボックスの左上隅の位置に対応し、(x1, y1) は右下隅の位置を表します。なお、`sequence_length = token_sequence_length + patch_sequence_length + 1` であり、`1` は [CLS] トークン用のものです。`patch_sequence_length` については `pixel_values` を参照してください。 attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) pixel_values (`torch.Tensor`、形状 `(batch_size, num_channels, image_size, image_size)`、*任意*) : 入力画像に対応するテンソルです。ピクセル値は [LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) を使用して取得できます。詳細については [LayoutLMv3ImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[UdopProcessor](/docs/transformers/main/ja/model_doc/udop#transformers.UdopProcessor) は画像の処理に [LayoutLMv3ImageProcessor](/docs/transformers/main/ja/model_doc/layoutlmv3#transformers.LayoutLMv3ImageProcessor) を使用します）。 visual_bbox (`torch.LongTensor`、形状 `(batch_size, patch_sequence_length, 4)`、*任意*) : 画像内の各パッチのバウンディングボックス。指定されない場合、モデル内でバウンディングボックスが作成されます。 inputs_embeds (`torch.Tensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 **戻り値:** `BaseModelOutputWithAttentionMask` または `tuple(torch.FloatTensor)` `BaseModelOutputWithAttentionMask`または`torch.FloatTensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。[UdopConfig](/docs/transformers/main/ja/model_doc/udop#transformers.UdopConfig)および入力に応じて、さまざまな要素で構成されます。 [UdopEncoderModel](/docs/transformers/main/ja/model_doc/udop#transformers.UdopEncoderModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`) -- モデルの最終層の出力における hidden-state のシーケンスです。`past_key_values` を使用する場合、shape `(batch_size, 1, hidden_size)` のシーケンスの最後の hidden-state のみが出力されます。 - **attention_mask** (`torch.FloatTensor`、形状 `(batch_size, sequence_length)`、*任意*) -- モデルのフォワードパスにおいて、パディングトークンのインデックスに対するアテンションを回避するために使用されるアテンションマスク。`[0, 1]` から選択されるマスクの値: - **マスクされていない**トークンに対して1 - **マスク**されたトークンに対しては 0 です。 - **past_key_values** (`Cache`、*任意*、`use_cache=True` が渡された場合または `config.use_cache=True` の場合に返されます) -- [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) のインスタンスです。詳細については、[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。 自己アテンションブロック（および `config.is_encoder_decoder=True` の場合、クロスカレンションブロック）の事前計算済みヒドゥンステート（キーとバリュー）を保持します。これらは逐次デコーディングを高速化するために使用できます（`past_key_values` 入力参照）。 - **hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合、または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（モデルに埋め込み層がある場合はその出力用 1 つ、各層の出力用 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。各層の出力におけるモデルの隠れ状態と、任意の初期埋め込み出力です。 - **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合、または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。アテンションの softmax 後のアテンション重みで、セルフアテンションヘッドにおける加重平均の計算に使用されます。 - **cross_attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` と `config.add_cross_attention=True` が渡された場合、または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。アテンションの softmax 適用後の、デコーダーのクロスアテンションレイヤーのアテンション重み。クロスアテンションヘッドにおける加重平均の計算に使用されます。 例: ```python >>> from transformers import AutoProcessor, UdopEncoderModel >>> from huggingface_hub import hf_hub_download >>> from datasets import load_dataset >>> # load model and processor >>> # in this case, we already have performed OCR ourselves >>> # so we initialize the processor with `apply_ocr=False` >>> processor = AutoProcessor.from_pretrained("microsoft/udop-large", apply_ocr=False) >>> model = UdopEncoderModel.from_pretrained("microsoft/udop-large") >>> # load an example image, along with the words and coordinates >>> # which were extracted using an OCR engine >>> dataset = load_dataset("nielsr/funsd-layoutlmv3", split="train") >>> example = dataset[0] >>> image = example["image"] >>> words = example["tokens"] >>> boxes = example["bboxes"] >>> encoding = processor(image, words, boxes=boxes, return_tensors="pt") >>> outputs = model(**encoding) >>> last_hidden_states = outputs.last_hidden_state ```