# UnlimitedOcr ## 概要 UnlimitedOcrモデルは、Baidu Inc.のYouyang Yin、Huanhuan Liu、Qunyi Xie、Chaorun Liu、Shiqi Yang、Shaohua Wang、Zhanlong Liu、Hao Zou、Jinyue Chen、Shu Wei、Jingjing Wu、Mingxin Huang、Zhen Wu、Guibin Wang、Tengyu Du、およびLei Jiaによって、[Unlimited OCR Works](https://huggingface.co/papers/2606.23050)で提案されました。 これは、標準的なコンテキスト長が32,768トークンである、単一の3Bパラメータモデルです。 論文の抄録は以下の通りです。 *最近、DeepSeek OCRに代表されるエンドツーエンドのOCRモデルが再びOCRを注目の的としています。広く受け入れられている見解として、デコーダに大規模言語モデル（LLM）を用いることで、モデルが言語の事前分布を活用でき、OCRの性能が向上するとされています。しかし、そのデメリットも明らかです。出力シーケンスが長くなるにつれて、蓄積されるKVキャッシュがメモリ消費量を増大させ、生成が徐々に遅くなります。これは、長期間のコピータスクにおいて効率の低下を見せない人間とは対照的です。本技術レポートでは、人間の解析作業記憶を模倣するように設計されたモデル、Unlimited OCRを提案します。DeepSeek OCRをベースラインとし、デコーダ内のすべてのアテンション層を、我々が提案するReference Sliding Window Attention（R-SWA）に置き換えました。これにより、アテンションの計算コストを削減しつつ、デコーディング全体を通じてKVキャッシュを一定に保つことができます。DeepSeek OCRのエンコーダの高い圧縮率と、我々の一定KVキャッシュ設計を組み合わせることで、Unlimited OCRは標準的な最大長32Kの下で、数十ページに及ぶ文書を単一のフォワードパスで書き起こすことができます。さらに重要なのは、R-SWAが汎用的な解析アテンション機構であるという点です。OCR以外にも、ASRや翻訳などのタスクにも同様に適用できます。コードとモデルの重みは http://github.com/baidu/Unlimited-OCR で公開されています。* Unlimited-OCRは2つの推論設定をサポートしています。デフォルトの"gundam"モードは、高解像度ドキュメントに対して動的クロッピングを伴う640x640のタイルを使用し、"base"モードは標準解像度の入力に対して単一の1024x1024のグローバルビューを使用します。baseモードを有効にするには、プロセッサーで`crop_to_patches=False`を設定するか、[apply_chat_template()](/docs/transformers/main/ja/main_classes/processors#transformers.ProcessorMixin.apply_chat_template)を使用する場合は`processor_kwargs`経由で渡してください。 ビジョンタワーは、[DeepSeek-OCR-2](./deepseek_ocr2)の2段階アプローチに従っています。SAM ViT-BエンコーダーがCLIP ViTエンコーダーに接続されます。DeepSeek-OCR-2とは異なり、CLIP特徴量はSAM特徴量とさらに連結され、最終的な画像トークンが生成されます。Unlimited-OCRでは、DeepSeek-OCR-2の学習可能なパッチクエリも省略されています。 テキストモデルは、DeepSeek-OCR-2にReference Sliding Window Attention (R-SWA)を追加したものと同一です。R-SWAは生成されたトークンにのみ適用されます。画像およびプロンプトのトークンはデコーディング全体を通じて完全に可視状態を維持されるため、長い文書でも以前のページからのコンテキストが失われることはありません。 このモデルは[guarin](https://huggingface.co/guarin)によって提供されました。元のコードは[こちら](https://github.com/baidu/Unlimited-OCR)で確認できます。 > [!TIP] > 元の実装では、モデルを [torch.autocast](https://pytorch.org/docs/stable/amp.html#torch.autocast) を使用して bfloat16 で実行します。出力を再現するには、forward と generate の呼び出しを autocast コンテキストでラップしてください。 > > ```python > with torch.autocast(device_type=model.device.type, dtype=torch.bfloat16): > output = model.generate(**inputs) > ``` ```python from transformers import AutoProcessor, AutoModelForImageTextToText model = AutoModelForImageTextToText.from_pretrained("baidu/Unlimited-OCR", device_map="auto") processor = AutoProcessor.from_pretrained("baidu/Unlimited-OCR") image = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg" messages = [ { "role": "user", "content": [{"type": "image", "url": image}, {"type": "text", "text": "document parsing."}], } ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt" ).to(model.device, model.dtype) output = model.generate(**inputs, max_new_tokens=512) processor.decode(output[0, inputs["input_ids"].shape[1]:], skip_special_tokens=True) # image [383, 87, 497, 171]\ntext [333, 201, 558, 230]R&D QUALITY IMPROVEMENT\nSUGGESTION/SOLUTION FORM... # All bounding boxes are in (x1, y1, x2, y2) format with coordinates normalized to [0, 999] ``` ### バッチ処理 バッチ処理を行う場合は、メッセージのリストを渡します。画像のサイズが異なる場合は、プロセッサに対して`padding=True`を設定してください。 ```python from transformers import AutoProcessor, AutoModelForImageTextToText model = AutoModelForImageTextToText.from_pretrained("baidu/Unlimited-OCR", device_map="auto") processor = AutoProcessor.from_pretrained("baidu/Unlimited-OCR") image1 = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg" image2 = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_receipt.jpeg" messages = [ [ { "role": "user", "content": [{"type": "image", "url": image}, {"type": "text", "text": "document parsing."}], } ] for image in [image1, image2] ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", processor_kwargs={"padding": True}, ).to(model.device, model.dtype) output = model.generate(**inputs) processor.decode(output[0, inputs["input_ids"].shape[1]:], skip_special_tokens=True) # image [383, 87, 497, 171]\ntext [333, 201, 558, 230]R&D QUALITY IMPROVEMENT\nSUGGESTION/SOLUTION FORM... # All bounding boxes are in (x1, y1, x2, y2) format with coordinates normalized to [0, 999] ``` ### 領域検出 `skip_special_tokens=False` を設定すると、すべての検出結果と領域タイプが `<|det|>...<|/det|>` マーカーで囲まれます。これにより、出力のさらなる後処理が可能になります。例えば、検出されたバウンディングボックスを画像にプロットする場合などに便利です。各検出結果は、座標が `[0, 999]` の範囲に正規化された状態で、`<|det|>region_type [x1, y1, x2, y2]<|/det|>text...` の形式で囲まれます。`return_detections=True` を設定すると、すべての検出結果が `{"region_type": region_type, "box": [x1, y1, x2, y2], "text": "..."}` として解析された辞書のリストが追加で返されます。 ```python from transformers import AutoProcessor, AutoModelForImageTextToText model = AutoModelForImageTextToText.from_pretrained("baidu/Unlimited-OCR", device_map="auto") processor = AutoProcessor.from_pretrained("baidu/Unlimited-OCR") image = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg" messages = [ { "role": "user", "content": [{"type": "image", "url": image}, {"type": "text", "text": "document parsing."}], } ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt" ).to(model.device, model.dtype) output = model.generate(**inputs) decoded, detections = processor.decode(output[0, inputs["input_ids"].shape[1]:], skip_special_tokens=False, return_detections=True) # <|det|>image [383, 87, 497, 171]<|/det|>\n<|det|>text [333, 201, 558, 230]<|/det|>R&D QUALITY IMPROVEMENT\nSUGGESTION/SOLUTION FORM... # Visualization import random import matplotlib.pyplot as plt import matplotlib.patches as patches from transformers.image_utils import load_image image = load_image("https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg") width, height = image.size figure, axis = plt.subplots(figsize=(10, 12)) axis.imshow(image) for detection in detections: region_type = detection["region_type"] x1, y1, x2, y2 = detection["box"] x1, y1, x2, y2 = int(x1) / 999 * width, int(y1) / 999 * height, int(x2) / 999 * width, int(y2) / 999 * height color = (random.random(), random.random(), random.random()) rectangle = patches.Rectangle((x1, y1), x2 - x1, y2 - y1, linewidth=1.5, edgecolor=color, facecolor="none") axis.add_patch(rectangle) axis.text(x1, y1, region_type, color="white", fontsize=8, backgroundcolor=color, verticalalignment="top") axis.axis("off") plt.show() ``` マルチページ文書は、すべてのページ画像をまとめて渡すことで、単一のフォワードパスで一括して解析できます。メッセージにページごとに1つの画像ブロックを追加し、モデルがすべてのページを連続した文書として処理するようにしてください。 ```python from transformers import AutoProcessor, AutoModelForImageTextToText model = AutoModelForImageTextToText.from_pretrained("baidu/Unlimited-OCR", device_map="auto") processor = AutoProcessor.from_pretrained("baidu/Unlimited-OCR") page1 = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg" page2 = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_receipt.jpeg" messages = [ { "role": "user", "content": [{"type": "image", "url": page} for page in [page1, page2]] + [{"type": "text", "text": "Multi page parsing."}], } ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", processor_kwargs={"crop_to_patches": False}, ).to(model.device, model.dtype) output = model.generate( **inputs, no_repeat_ngram_window_size=1024, # default: 128, larger window size recommended for long documents ) processor.decode(output[0, inputs["input_ids"].shape[1]:], skip_special_tokens=True) # image [382, 87, 489, 174]\ntitle [333, 201, 556, 230]R&D QUALITY IMPROVEMENT\nSUGGESTION/SCLUTION FORM... # All bounding boxes are in (x1, y1, x2, y2) format with coordinates normalized to [0, 999] ``` ## UnlimitedOcrConfig[[transformers.UnlimitedOcrConfig]] #### transformers.UnlimitedOcrConfig[[transformers.UnlimitedOcrConfig]] ```python transformers.UnlimitedOcrConfig(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, is_encoder_decoder: bool = False, 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, vision_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, text_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, image_token_id: int = 128815, tie_word_embeddings: bool = False) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/configuration_unlimited_ocr.py#L262) **パラメータ:** vision_config (`dict` または `UnlimitedOcrVisionConfig`、*任意*) : ビジョンエンコーダーの設定。デフォルトは `UnlimitedOcrVisionConfig()` です。 text_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`, *任意*) : テキストバックボーンの config オブジェクトまたは辞書。 image_token_id (`int`、*任意*、デフォルトは`128815`) : 入力画像のプレースホルダーとして使用される画像トークンのインデックス。 tie_word_embeddings (`bool`, *任意*, デフォルトは `False`) : モデルの `tied_weights_keys` マッピングに従って重み埋め込みを共有するかどうか。 これはUnlimitedOcrModelの設定を保存するための設定クラスです。指定された引数に基づいてUnlimited Ocrモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[baidu/Unlimited-OCR](https://huggingface.co/baidu/Unlimited-OCR)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 例: ```python >>> from transformers import UnlimitedOcrConfig, UnlimitedOcrModel >>> configuration = UnlimitedOcrConfig() >>> model = UnlimitedOcrModel(configuration) >>> configuration = model.config ``` ## UnlimitedOcrTextConfig[[transformers.UnlimitedOcrTextConfig]] #### transformers.UnlimitedOcrTextConfig[[transformers.UnlimitedOcrTextConfig]] ```python transformers.UnlimitedOcrTextConfig(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, is_encoder_decoder: bool = False, 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, vocab_size: int = 129280, hidden_size: int = 1280, intermediate_size: int = 6848, num_hidden_layers: int = 12, num_attention_heads: int = 10, num_key_value_heads: int | None = 10, hidden_act: str = 'silu', max_position_embeddings: int = 32768, initializer_range: float = 0.02, rms_norm_eps: float = 1e-06, use_cache: bool = True, pad_token_id: int | None = None, bos_token_id: int | None = 0, eos_token_id: int | list[int] | None = 1, pretraining_tp: int | None = 1, tie_word_embeddings: bool = False, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, attention_bias: bool = False, attention_dropout: float | None = 0.0, mlp_bias: bool = False, head_dim: int | None = None, n_group: int | None = 1, n_routed_experts: int = 64, output_router_logits: bool = False, n_shared_experts: int = 2, routed_scaling_factor: float = 1.0, topk_group: int | None = 1, topk_method: str | None = 'greedy', num_experts_per_tok: int | None = 6, moe_intermediate_size: int = 896, mlp_layer_types: list[str] | None = None, layer_types: list[str] | None = None, sliding_window: int | None = 128) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/configuration_unlimited_ocr.py#L141) **パラメータ:** vocab_size (`int`、*任意*、デフォルトは`129280`) : モデルの語彙サイズ。`input_ids`で表現できるトークンの種類数を定義します。 hidden_size (`int`、*任意*、デフォルトは`1280`) : 隠れ表現の次元数。 intermediate_size (`int`、*任意*、デフォルトは`6848`) : MLP 表現の次元数。 num_hidden_layers (`int`, *任意*, デフォルトは `12`) : Transformer デコーダーの隠れ層の数。 num_attention_heads (`int`、*optional*、デフォルトは`10`) : Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。 num_key_value_heads (`int`, *optional*, デフォルトは `10`) : Grouped Query Attention を実装するために使用する key_value ヘッドの数です。`num_key_value_heads=num_attention_heads` の場合、モデルは Multi Head Attention (MHA) を使用し、`num_key_value_heads=1` の場合は Multi Query Attention (MQA) を使用し、それ以外の場合は GQA が使用されます。マルチヘッドのチェックポイントを GQA のチェックポイントに変換する際は、各グループの key ヘッドと value ヘッドは、そのグループ内の元のすべてのヘッドを平均プーリングして構築する必要があります。詳細については、[この論文](https://huggingface.co/papers/2305.13245)を参照してください。指定されていない場合、デフォルトで `num_attention_heads` になります。 hidden_act (`str`、*任意*、デフォルトは`silu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"`など。 max_position_embeddings (`int`、*任意*、デフォルトは`32768`) : このモデルが使用される可能性のある最大シーケンス長です。 initializer_range (`float`、*任意*、デフォルトは`0.02`) : すべての重み行列を初期化するためのtruncated_normal_initializerの標準偏差です。 rms_norm_eps (`float`、*任意*、デフォルトは`1e-06`) : rms 正規化レイヤーで使用する epsilon。 use_cache (`bool`、*任意*、デフォルトは `True`) : モデルが最後のキー/バリューアテンションを返すかどうか（すべてのモデルで利用されるわけではありません）。`config.is_decoder=True` の場合、またはモデルがデコーダー専用の生成モデルである場合にのみ関連します。 pad_token_id (`int`, *任意*) : 語彙内でパディングに使用されるトークンID。 bos_token_id (`int`, *optional*, デフォルトは `0`) : 語彙内でストリームの開始に使用されるトークン ID。 eos_token_id (`Union[int, list[int]]`、*任意*、デフォルトは `1`) : 語彙内でストリーム終了に使用されるトークン ID。 pretraining_tp (`int`、*任意*、デフォルトは `1`) : 実験的な機能です。事前学習中に使用される Tensor parallelism のランクです。詳細については、[このドキュメント](https://huggingface.co/docs/transformers/main/perf_train_gpu_many#tensor-parallelism)を参照してください。この値は、事前学習の結果を正確に再現するために必要です。[この issue](https://github.com/pytorch/pytorch/issues/76232)を参照してください。 tie_word_embeddings (`bool`, *任意*, デフォルトは `False`) : モデルの `tied_weights_keys` マッピングに従って重み埋め込みを共有するかどうか。 rope_parameters (`Union[~modeling_rope_utils.RopeParameters, dict]`, *optional*) : RoPE 埋め込みの設定パラメータを含む辞書です。この辞書には `rope_theta` の値が含まれていなければならず、より長い `max_position_embeddings` で RoPE を使用する場合、スケーリングに使用されるパラメータが任意で含まれます。 attention_bias (`bool`、*任意*、デフォルトは`False`) : セルフアテンションにおけるクエリ、キー、バリュー、出力の投影層でバイアスを使用するかどうか。 attention_dropout (`float`、*任意*、デフォルトは`0.0`) : 注意確率のドロップアウト率です。 mlp_bias (`bool`, *任意*, デフォルトは `False`) : MLP 層の up_proj、down_proj、gate_proj 層でバイアスを使用するかどうか。 head_dim (`int`, *optional*) : アテンションヘッドの次元です。None の場合、hidden_size // num_attention_heads がデフォルトとして使用されます。 n_group (`int`, *optional*) : グループ化された top-k エキスパートルーティングのグループ数。 n_routed_experts (`int`、*任意*、デフォルトは`64`) : ルーティング対象のエクスパート数。 output_router_logits (`bool`, *任意*, デフォルトは `False`) : モデルがルーターのロジスティック値を返すかどうかを指定します。これを有効にすると、モデルはロードバランシングロスやルーターのzロスを含む補助ロスの出力も可能になります。 n_shared_experts (`int`、*任意*、デフォルトは`2`) : 共有エキスパートの数。 routed_scaling_factor (`float`、*任意*、デフォルトは`1.0`) : スケーリング係数またはルーティングされたエキスパート。 topk_group (`int`, *任意*, デフォルトは `1`) : トークンごとに選択されるグループの数（各トークンについて、選択されるエキスパートが `topk_group` 個のグループの範囲内にのみ存在することを保証します）。 topk_method (`str`、*任意*、デフォルトは `"greedy"`) : MoE レイヤーでトップkのエキスパートを選択する方法。 num_experts_per_tok (`int`、*任意*、デフォルトは`6`) : 各トークンをルーティングするエキスパートの数です。これは、トークン選択ルーティングにおけるtop-kの値です。 moe_intermediate_size (`int`, *optional*, デフォルトは `896`) : ルーティングされたエキスパートのMLPの中間サイズ。 mlp_layer_types (`list[str]`、*任意*) : 各デコーダ層の MLP 型（`"dense"` または `"sparse"`）。例: `["dense", "sparse", "sparse", ...]`。 layer_types (`list[str]`, *任意*) : 各デコーダー層のAttentionタイプ。デフォルトでは、すべての層で`"reference_sliding_attention"`が使用されます。 sliding_window (`int`、*optional*、デフォルトは`128`) : 参照スライディングウィンドウアテンションのスライディングウィンドウサイズ。設定した場合、各トークンは直前の`sliding_window`およびすべての画像トークンとプロンプトトークンにアテンションを行います。 これはUnlimitedOcrModelの設定を保存するための設定クラスです。指定された引数に基づいてUnlimited Ocrモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[baidu/Unlimited-OCR](https://huggingface.co/baidu/Unlimited-OCR)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 例: ```python >>> from transformers import UnlimitedOcrTextConfig, UnlimitedOcrTextModel >>> configuration = UnlimitedOcrTextConfig() >>> model = UnlimitedOcrTextModel(configuration) >>> configuration = model.config ``` ## UnlimitedOcrVisionConfig[[transformers.UnlimitedOcrVisionConfig]] #### transformers.UnlimitedOcrVisionConfig[[transformers.UnlimitedOcrVisionConfig]] ```python transformers.UnlimitedOcrVisionConfig(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, is_encoder_decoder: bool = False, 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, sam_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, encoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/configuration_unlimited_ocr.py#L112) **パラメータ:** sam_config (`dict` または `UnlimitedOcrSamVisionConfig`、*任意*) : SAM ビジョンエンコーダーの設定です。デフォルトは `UnlimitedOcrSamVisionConfig()` です。 encoder_config (`dict` または `UnlimitedOcrVisionEncoderConfig`、*optional*) : ビジョンエンコーダーの設定。デフォルトは `UnlimitedOcrVisionEncoderConfig()` です。 これはUnlimitedOcrModelの設定を保存するための設定クラスです。指定された引数に基づいてUnlimited Ocrモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[baidu/Unlimited-OCR](https://huggingface.co/baidu/Unlimited-OCR)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 例: ```python >>> from transformers import UnlimitedOcrVisionConfig, UnlimitedOcrVisionModel >>> configuration = UnlimitedOcrVisionConfig() >>> model = UnlimitedOcrVisionModel(configuration) >>> configuration = model.config ``` ## UnlimitedOcrVisionEncoderConfig[[transformers.UnlimitedOcrVisionEncoderConfig]] #### transformers.UnlimitedOcrVisionEncoderConfig[[transformers.UnlimitedOcrVisionEncoderConfig]] ```python transformers.UnlimitedOcrVisionEncoderConfig(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, is_encoder_decoder: bool = False, 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, hidden_size: int = 1024, intermediate_size: int = 4096, num_hidden_layers: int = 24, num_attention_heads: int = 16, num_channels: int = 3, image_size: int | list[int] | tuple[int, int] | None = 224, patch_size: int | list[int] | tuple[int, int] | None = 14, hidden_act: str = 'quick_gelu', layer_norm_eps: float = 1e-05, attention_dropout: int | float | None = 0.0, initializer_range: float = 0.02, initializer_factor: float = 1.0) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/configuration_unlimited_ocr.py#L74) **パラメータ:** hidden_size (`int`、*任意*、デフォルトは`1024`) : 隠れ表現の次元数。 intermediate_size (`int`、*任意*、デフォルトは`4096`) : MLP 表現の次元数。 num_hidden_layers (`int`、*optional*、デフォルトは `24`) : Transformer デコーダーの隠れ層の数。 num_attention_heads (`int`、*任意*、デフォルトは`16`) : Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。 num_channels (`int`、*任意*、デフォルトは`3`) : 入力チャネル数。 image_size (`Union[int, list[int], tuple[int, int]]`、*任意*、デフォルトは`224`) : 各画像のサイズ（解像度）。 patch_size (`Union[int, list[int], tuple[int, int]]`、*任意*、デフォルトは`14`) : 各パッチのサイズ（解像度）。 hidden_act (`str`、*任意*、デフォルトは `quick_gelu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"` など。 layer_norm_eps (`float`、*任意*、デフォルトは`1e-05`) : Layer Normalization 層で使用する epsilon。 attention_dropout (`Union[int, float]`、*任意*、デフォルトは`0.0`) : 注意確率のドロップアウト率。 initializer_range (`float`、*任意*、デフォルトは`0.02`) : すべての重み行列を初期化するためのtruncated_normal_initializerの標準偏差です。 initializer_factor (`float`、*任意*、デフォルトは`1.0`) : すべての重み行列を初期化する係数です（1に保つ必要があります。初期化テスト用に内部で使用されます）。 これはUnlimitedOcrModelの設定を保存するための設定クラスです。指定された引数に基づいてUnlimited Ocrモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[baidu/Unlimited-OCR](https://huggingface.co/baidu/Unlimited-OCR)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 例: ```python >>> from transformers import UnlimitedOcrVisionEncoderConfig, UnlimitedOcrVisionEncoder >>> configuration = UnlimitedOcrVisionEncoderConfig() >>> model = UnlimitedOcrVisionEncoder(configuration) >>> configuration = model.config ``` ## UnlimitedOcrSamVisionConfig[[transformers.UnlimitedOcrSamVisionConfig]] #### transformers.UnlimitedOcrSamVisionConfig[[transformers.UnlimitedOcrSamVisionConfig]] ```python transformers.UnlimitedOcrSamVisionConfig(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, is_encoder_decoder: bool = False, 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, hidden_size: int = 768, output_channels: int = 256, num_hidden_layers: int = 12, num_attention_heads: int = 12, num_channels: int = 3, image_size: int | list[int] | tuple[int, int] = 1024, patch_size: int | list[int] | tuple[int, int] = 16, hidden_act: str = 'gelu', layer_norm_eps: float = 1e-06, attention_dropout: float | int = 0.0, initializer_range: float = 1e-10, qkv_bias: bool = True, use_abs_pos: bool = True, use_rel_pos: bool = True, window_size: int = 14, global_attn_indexes: list[int] | tuple[int, ...] = (2, 5, 8, 11), mlp_dim: int = 3072, downsample_channels: list[int] | tuple[int, ...] = (512, 1024)) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/configuration_unlimited_ocr.py#L29) **パラメータ:** hidden_size (`int`、*任意*、デフォルトは`768`) : 隠れ表現の次元数。 output_channels (`int`、*任意*、デフォルトは 256) : Patch Encoder の出力チャネルの次元数。 num_hidden_layers (`int`, *任意*, デフォルトは `12`) : Transformer デコーダーの隠れ層の数。 num_attention_heads (`int`、*任意*、デフォルトは `12`) : Transformer デコーダーの各アテンション層におけるアテンションヘッドの数。 num_channels (`int`、*任意*、デフォルトは`3`) : 入力チャネル数。 image_size (`Union[int, list[int], tuple[int, int]]`、*任意*、デフォルトは`1024`) : 各画像のサイズ（解像度）。 patch_size (`Union[int, list[int], tuple[int, int]]`、*任意*、デフォルトは`16`) : 各パッチのサイズ（解像度）。 hidden_act (`str`、*任意*、デフォルトは`gelu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"`など。 layer_norm_eps (`float`、*任意*、デフォルトは`1e-06`) : Layer Normalization 層で使用する epsilon です。 attention_dropout (`Union[float, int]`、*任意*、デフォルトは`0.0`) : 注意確率のドロップアウト率。 initializer_range (`float`、*任意*、デフォルトは `1e-10`) : 全重み行列の初期化に使用される truncated_normal_initializer の標準偏差です。 qkv_bias (`bool`, *任意*, デフォルトは `True`) : クエリ、キー、バリューにバイアスを追加するかどうか。 use_abs_pos (`bool`、*任意*、デフォルトは`True`) : 絶対位置埋め込みを使用するかどうか。 use_rel_pos (`bool`、*任意*、デフォルトは`True`) : 相対位置埋め込みを使用するかどうか。 window_size (`int`, *optional*, デフォルトは 14) : 相対位置のウィンドウサイズ。 global_attn_indexes (`list[int]`、*任意*、デフォルトは`[2, 5, 8, 11]`) : グローバルアテンションレイヤーのインデックスです。 mlp_dim (`int`、*optional*、デフォルトは 3072) : Transformer エンコーダーにおける MLP レイヤーの次元数。 downsample_channels (`list[int]`、*optional*、デフォルトは`(512, 1024)`) : マルチスケールダウンサンプリングネック層のチャネル次元です。 これはUnlimitedOcrModelの設定を保存するための設定クラスです。指定された引数に基づいてUnlimited Ocrモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[baidu/Unlimited-OCR](https://huggingface.co/baidu/Unlimited-OCR)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 ## UnlimitedOcrImageProcessor[[transformers.UnlimitedOcrImageProcessor]] #### transformers.UnlimitedOcrImageProcessor[[transformers.UnlimitedOcrImageProcessor]] ```python transformers.UnlimitedOcrImageProcessor(**kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/image_processing_unlimited_ocr.py#L141) **パラメータ:** do_convert_rgb (`bool`, *kwargs*, *optional*, デフォルトは `True`) : 画像を RGB に変換するかどうか。 do_resize (`bool`, *kwargs*, *任意*, デフォルトは `True`) : 画像をリサイズするかどうか。 size (`Annotated[int | list[int] | tuple[int, ...] | dict[str, int] | None, None]`, *kwargs*、デフォルト値は `{'height' : 1024, 'width': 1024}`): モデルへの最大入力サイズを指定します。 default_to_square (`bool`, *kwargs*, *任意*、デフォルトは `True`) : size が整数の場合、リサイズ時に正方形の画像をデフォルトとするかどうか。 crop_size (`Annotated[int | list[int] | tuple[int, ...] | dict[str, int] | None, None]`, *kwargs*) : `center_crop` を適用した後の出力画像のサイズ。 resample (`Annotated[Union[int, PILImageResampling, NoneType], None]`, *kwargs*、デフォルトは `3`) : 画像をリサイズする場合に使用するリサンプリングフィルター。`PILImageResampling` の列挙型のいずれかになります。`do_resize` が `True` に設定されている場合のみ有効です。 do_rescale (`bool`, *kwargs*, *optional*, デフォルトは `True`) : 画像をリスケールするかどうか。 rescale_factor (`float`, *kwargs*, *optional*, デフォルトは `0.00392156862745098`) : `do_rescale` が `True` に設定されている場合、画像をリスケールするための係数。 do_normalize (`bool`, *kwargs*, *optional*, デフォルトは `True`) : 画像を正規化するかどうかを指定します。 image_mean (`Union[float, list[float], tuple[float, ...]]`, *kwargs*, *optional*, デフォルトは `[0.5, 0.5, 0.5]`) : 正規化に使用する画像の平均値。`do_normalize` が `True` に設定されている場合のみ有効です。 image_std (`Union[float, list[float], tuple[float, ...]]`, *kwargs*, *optional*, デフォルトは `[0.5, 0.5, 0.5]`) : 正規化に使用する画像の標準偏差。`do_normalize` が `True` に設定されている場合のみ有効です。 do_pad (`bool`, *kwargs*, *任意*) : 画像にパディングを適用するかどうか。パディングは、バッチ内の最大サイズに合わせるか、画像ごとに固定の正方形サイズに合わせるかのいずれかで行われます。正確なパディング戦略はモデルによって異なります。 pad_size (`Annotated[int | list[int] | tuple[int, ...] | dict[str, int] | None, None]`, *kwargs*) : 画像をパディングするサイズを`{"height": int, "width" int}`で指定します。前処理に提供されたすべての画像サイズより大きい必要があります。`pad_size`が指定されない場合、バッチ内の最大の幅と高さにパディングされます。`do_pad=True.`の場合にのみ適用されます。 do_center_crop (`bool`, *kwargs*, *optional*) : 画像を中央クロップするかどうか。 data_format (`Union[str, ~image_utils.ChannelDimension]`、*kwargs*、*optional*) : 対応するのは `ChannelDimension.FIRST` のみです。slow processors との互換性のために追加されました。 input_data_format (`Union[str, ~image_utils.ChannelDimension]`, *kwargs*, *任意*) : 入力画像のチャネル次元の形式です。設定されていない場合、入力画像からチャネル次元の形式が推論されます。以下のいずれかになります: - `"channels_first"` または `ChannelDimension.FIRST`: (num_channels, height, width) 形式の画像。 - `"channels_last"` または `ChannelDimension.LAST`: (height, width, num_channels) 形式の画像。 - `"none"` または `ChannelDimension.NONE`: (height, width) 形式の画像。 device (`Annotated[Union[str, torch.device, NoneType], None]`, *kwargs*) : 動画を処理するデバイスです。未設定の場合、入力動画からデバイスが推論されます。 return_tensors (`Annotated[str | ~utils.generic.TensorType | None, None]`, *kwargs*) : `'pt'`に設定されている場合はスタックされたテンソルを返し、それ以外の場合はテンソルのリストを返します。 disable_grouping (`bool`, *kwargs*, *optional*) : 画像をサイズごとにグループ化してバッチ処理するのではなく、個別に処理するためにグループ化を無効にするかどうかを指定します。None の場合、画像が CPU にある場合は True、それ以外の場合は False に設定されます。この選択は、https://github.com/huggingface/transformers/pull/38157 に詳しく記載されている実証的な観察に基づいています。 image_seq_length (`int`, *kwargs*, *任意*) : 入力内の各画像に使用される画像トークンの数です。後方互換性のために追加されましたが、将来のモデルではプロセッサの属性として設定されるべきです。 crop_to_patches (`bool`, *kwargs*, *optional*, デフォルトは `True`) : 画像をパッチにクロップするかどうか。`preprocess` メソッドの `crop_to_patches` パラメータで上書きできます。 min_patches (`int`, *kwargs*, *optional*, デフォルトは `2`) : 画像から抽出されるパッチの最小数です。`crop_to_patches` が `True` に設定されている場合のみ有効です。`preprocess` メソッドの `min_patches` パラメータによって上書きできます。 max_patches (`int`, *kwargs*, *optional*, デフォルトは `32`) : 画像から抽出されるパッチの最大数です。`crop_to_patches` が `True` に設定されている場合のみ有効です。`preprocess` メソッドの `max_patches` パラメータによって上書きできます。 tile_size (`int`, *kwargs*, *optional*, デフォルトは`640`) : 各ローカルタイルのサイズです。モデルのクエリ埋め込みサイズと一致する必要があります。 background_color (`list[int]`, *kwargs*, *optional*, デフォルトは `[127, 127, 127]`) : パディング用の背景色です。 maximum_pad_value (`int`, *kwargs*, *optional*, デフォルトは `640`) : `crop_to_patches` が `False` であり、かつ `max(size.height, size.width)` がこの値以下の場合、アスペクト比を保持せずに、画像を `max(size.height, size.width)` の正方形に直接リサイズします。それ以外の場合、アスペクト比を保持して画像をリサイズし、その後 `background_color` でパディングして正方形にします。 UnlimitedOcrImageProcessor イメージプロセッサを構築します。 #### crop_image_to_patches[[transformers.UnlimitedOcrImageProcessor.crop_image_to_patches]] ```python crop_image_to_patches(images: torch.Tensor, min_patches: int, max_patches: int, tile_size: int, resample: PIL.Image.Resampling | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/image_processing_unlimited_ocr.py#L163) **パラメータ:** images (`torch.Tensor`) : クロップする画像。形状は `(batch, channels, height, width)` です。 min_patches (`int`) : パッチの最小数。 max_patches (`int`) : パッチの最大数。 tile_size (`int`) : 各タイルのサイズ。 resample (`PILImageResampling`, *任意*) : リサイズ用のリサンプリングフィルタ。 **戻り値:** `tuple[torch.Tensor, int]` スタックされたパッチ`(batch, num_patches, channels, tile_size, tile_size)`と、1枚の画像あたりのパッチ数。 最適なタイル分割に基づいて、バッチ化された画像をパッチに切り出します。 #### get_number_of_image_patches[[transformers.UnlimitedOcrImageProcessor.get_number_of_image_patches]] ```python get_number_of_image_patches(height: int, width: int, images_kwargs: dict | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/image_processing_unlimited_ocr.py#L309) 指定された画像サイズ（1つのグローバルパッチ + ローカルパッチ）に対する画像パッチの数を返します。 #### pad_to_square[[transformers.UnlimitedOcrImageProcessor.pad_to_square]] ```python pad_to_square(images: torch.Tensor, background_color: int | tuple[int, int, int] = 0) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/image_processing_unlimited_ocr.py#L328) **パラメータ:** images (`torch.Tensor`) : パディングする画像。形状: (batch_size, num_channels, height, width) または (num_channels, height, width)。 background_color (`int` または `tuple[int, int, int]`、*optional*、デフォルト値は 0) : パディングに使用する色です。単一チャネルの場合は整数、マルチチャネル画像の場合は整数のタプルを指定できます。マルチチャネルモードで整数を指定した場合、以降のチャネルは `0` がデフォルトになります。 **戻り値:** `torch.Tensor` パディングされた画像。 最も長い辺に基づいて、画像を正方形にパディングします。 ## UnlimitedOcrProcessor[[transformers.UnlimitedOcrProcessor]] #### transformers.UnlimitedOcrProcessor[[transformers.UnlimitedOcrProcessor]] ```python transformers.UnlimitedOcrProcessor(image_processor = None, tokenizer = None, chat_template = None, patch_size = 16, downsample_ratio = 4, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/processing_unlimited_ocr.py#L30) **パラメータ:** image_processor (`UnlimitedOcrImageProcessor`) : 画像プロセッサは必須の入力です。 tokenizer (`tokenizer_class`) : トークナイザーは必須の入力です。 chat_template (`str`) : チャット内のメッセージのリストをトークン化可能な文字列に変換するための Jinja テンプレート。 patch_size (`int`、*optional*、デフォルトは`16`) : ビジョンエンコーダーで使用されるパッチサイズ（SAM ViT のパッチ埋め込みサイズ）。 downsample_ratio (`int`、*optional*、デフォルトは`4`) : ビジョンエンコーダーの後に適用されるダウンサンプリング比率。 UnlimitedOcrProcessor を構築します。画像プロセッサとトークナイザーを単一のプロセッサにラップします。 [UnlimitedOcrProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrProcessor) は、[UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) と `tokenizer_class` のすべての機能を提供します。詳細については、[~UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) および `~tokenizer_class` を参照してください。 #### batch_decode[[transformers.UnlimitedOcrProcessor.batch_decode]] ```python batch_decode(*args, return_detections: bool = False, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/processing_unlimited_ocr.py#L92) **パラメータ:** return_detections (`bool`, *任意*, デフォルトは `False`) : 復号化されたテキストから解析されたレイアウト検出結果も返すかどうか。 **戻り値:** `list[str]` または `tuple[list[str], list[list[dict]]]` デコードされたテキスト。`return_detections`が`True`の場合、デコードされたテキストとすべてのシーケンスの検出結果のタプルを返します。各検出結果は、キー`region_type`、`box`、`text`を持つ辞書です。ボックスは[x1, y1, x2, y2]形式で、座標は[0, 999]に正規化されています。 このメソッドは、すべての引数を PreTrainedTokenizer の [batch_decode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.batch_decode) に転送します。詳細については、このメソッドのドキュメント文字列を参照してください。 #### decode[[transformers.UnlimitedOcrProcessor.decode]] ```python decode(*args, return_detections: bool = False, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/processing_unlimited_ocr.py#L113) **パラメータ:** return_detections (`bool`, *任意*, デフォルトは `False`) : 復号化されたテキストから解析されたレイアウト検出結果も返すかどうか。 **戻り値:** `str` または `tuple[str, list[dict]]` デコードされたテキスト。`return_detections`が`True`の場合、デコードされたテキストと検出結果のリストのタプルを返します。各検出結果は、キー`region_type`、`box`、`text`を持つ辞書です。ボックスは[x1, y1, x2, y2]形式で、座標は[0, 999]に正規化されています。 このメソッドは、すべての引数を PreTrainedTokenizer の [decode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.decode) に転送します。詳細については、このメソッドのドキュメント文字列を参照してください。 ## UnlimitedOcrPreTrainedModel[[transformers.UnlimitedOcrPreTrainedModel]] #### transformers.UnlimitedOcrPreTrainedModel[[transformers.UnlimitedOcrPreTrainedModel]] ```python transformers.UnlimitedOcrPreTrainedModel(config: PreTrainedConfig, *inputs, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L281) **パラメータ:** config ([PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 このモデルは [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のドキュメントを参照してください。 ## UnlimitedOcrTextPreTrainedModel[[transformers.UnlimitedOcrTextPreTrainedModel]] #### transformers.UnlimitedOcrTextPreTrainedModel[[transformers.UnlimitedOcrTextPreTrainedModel]] ```python transformers.UnlimitedOcrTextPreTrainedModel(config: PreTrainedConfig, *inputs, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L1269) **パラメータ:** config ([PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 このモデルは [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のドキュメントを参照してください。 ## UnlimitedOcrTextModel[[transformers.UnlimitedOcrTextModel]] #### transformers.UnlimitedOcrTextModel[[transformers.UnlimitedOcrTextModel]] ```python transformers.UnlimitedOcrTextModel(config: UnlimitedOcrTextConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L1731) **パラメータ:** config ([UnlimitedOcrTextConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrTextConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連付けられた重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 特定のヘッドを付加せずに、生のhidden-statesを出力する、素のUnlimited Ocr Text 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.UnlimitedOcrTextModel.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, use_cache: bool | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L1748) **パラメータ:** input_ids (`torch.LongTensor`、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) position_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックスです。`[0, config.n_positions - 1]` の範囲から選択されます。 [位置 ID とは何か？](../glossary#position-ids) 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)`）のみを入力する必要があります。 inputs_embeds (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 **戻り値:** `MoeModelOutputWithPast` または `tuple(torch.FloatTensor)` `MoeModelOutputWithPast`、または`torch.FloatTensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。構成要素は、設定（[UnlimitedOcrConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrConfig)）と入力に応じて異なります。 [UnlimitedOcrTextModel](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrTextModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`) -- モデルの最終層の出力における隠れ状態のシーケンス。 - **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)` です。 各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。 - **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 - **router_logits** (`tuple(torch.FloatTensor)`、*optional*、`output_router_probs=True` と `config.add_router_probs=True` が渡された場合、または `config.output_router_probs=True` の場合に返されます) -- `torch.FloatTensor` のタプル（レイヤーごとに1つ）、形状は `(batch_size, sequence_length, num_experts)`。 MoE ルーターによって計算される生（raw）のルーター logits（softmax 後）であり、Mixture of Experts モデルの補助損失を計算するためにこれらの用語が使用されます。 ## UnlimitedOcrVisionModel[[transformers.UnlimitedOcrVisionModel]] #### transformers.UnlimitedOcrVisionModel[[transformers.UnlimitedOcrVisionModel]] ```python transformers.UnlimitedOcrVisionModel(config: UnlimitedOcrVisionConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L927) **パラメータ:** config ([UnlimitedOcrVisionConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrVisionConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 SAMで画像をエンコードし、その後、追加のモデル（CLIP）でエンコードするVisionモデル。 このモデルは [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.UnlimitedOcrVisionModel.forward]] ```python forward(pixel_values: Tensor, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L936) **パラメータ:** pixel_values (`torch.Tensor`、形状 `(batch_size, num_channels, image_size, image_size)`) : 入力画像に対応するテンソルです。ピクセル値は [UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) を使用して取得できます。詳細は [UnlimitedOcrImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[UnlimitedOcrProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrProcessor) は画像の処理に [UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) を使用します）。 **戻り値:** [BaseModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutput) または `tuple(torch.FloatTensor)` A [BaseModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutput) or a tuple of `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various elements depending on the configuration ([UnlimitedOcrConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrConfig)) and inputs. [UnlimitedOcrVisionModel](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrVisionModel) の forward メソッドは、`__call__` という特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`) -- モデルの最終層の出力における隠れ状態のシーケンス。 - **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、および任意の初期埋め込み出力。 - **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 >>> import torch >>> from transformers import AutoConfig, AutoImageProcessor, AutoModel >>> from transformers.image_utils import load_image >>> model_id = "baidu/Unlimited-OCR" >>> config = AutoConfig.from_pretrained(model_id) >>> model = AutoModel.from_pretrained(model_id, config=config.vision_config, device_map="auto") >>> image_processor = AutoImageProcessor.from_pretrained(model_id) >>> image = load_image("https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg") >>> inputs = image_processor(images=image, return_tensors="pt").to(model.device, model.dtype) >>> with torch.no_grad(): ... outputs = model(**inputs) >>> # Patch tokens without class tokens (batch_size, height * width, vision_hidden_size + sam_hidden_size) >>> patch_tokens = outputs.last_hidden_state ``` ## UnlimitedOcrModel[[transformers.UnlimitedOcrModel]] #### transformers.UnlimitedOcrModel[[transformers.UnlimitedOcrModel]] ```python transformers.UnlimitedOcrModel(config: UnlimitedOcrConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L1816) **パラメータ:** config ([UnlimitedOcrConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 ビジョンバックボーンと言語モデルで構成されるUnlimitedOcrモデル。 このモデルは [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.UnlimitedOcrModel.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, pixel_values: typing.Optional[torch.FloatTensor] = None, pixel_values_local: typing.Optional[torch.FloatTensor] = None, num_local_patches: list[int] | None = None, patches_grid: list[list[int]] | None = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, use_cache: bool | None = None, mm_encoder_outputs: dict[str, transformers.modeling_outputs.BaseModelOutputWithPooling] | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L1933) **パラメータ:** input_ids (`torch.LongTensor`、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) pixel_values (`torch.FloatTensor`、形状 `(batch_size, num_channels, image_size, image_size)`、*任意*) : 入力画像に対応するテンソルです。ピクセル値は [UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) を使用して取得できます。詳細は [UnlimitedOcrImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[UnlimitedOcrProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrProcessor) は画像の処理に [UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) を使用します）。 pixel_values_local (`torch.FloatTensor`, *任意*) : 形が `(total_patches, 3, H, W)` のローカルパッチのピクセル値。 num_local_patches (`list[int]`, *任意*) : バッチ内の各画像あたりのローカルパッチ数。 patches_grid (`list[list[int]]`, *任意*) : 各画像のパッチグリッド `(num_columns, num_rows)`。 attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) position_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックスです。`[0, config.n_positions - 1]` の範囲から選択されます。 [位置 ID とは何か？](../glossary#position-ids) 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)`）のみを入力する必要があります。 inputs_embeds (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 mm_encoder_outputs (`dict[str, ~modeling_outputs.BaseModelOutputWithPooling]`, *任意*) : キーがサポートされているモダリティ、値がそのモダリティのエンコード済み出力である辞書。各エンコード済み出力は、(`pooler_output`、*任意*: `last_hidden_states`、*任意*: `hidden_states`、*任意*: `attentions`) という形式のタプルで、`pooler_output` の形状は `(batch_size, sequence_length, hidden_size)`、*任意*) であり、エンコーダーのマルチモーダル特徴量をテキスト埋め込みにマージしたシーケンスです。 **戻り値:** `UnlimitedOcrModelOutputWithPast` または `tuple(torch.FloatTensor)` `UnlimitedOcrModelOutputWithPast`、または`torch.FloatTensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。設定（[UnlimitedOcrConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrConfig)）や入力に応じて、さまざまな要素で構成されます。 [UnlimitedOcrModel](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrModel)の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** (`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)を参照してください。 逐次デコーディングを高速化するために使用できる（`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)` です。 各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。 - **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 - **image_hidden_states** (`torch.FloatTensor`、*任意*) -- サイズが`(batch_size, num_images, sequence_length, hidden_size)`の`torch.FloatTensor`。ビジョンエンコーダーによって生成され、最後の隠れ状態を投影した後のモデルの image_hidden_states です。 - **router_logits** (`tuple[torch.FloatTensor]`、*optional*、`output_router_logits=True` が渡された場合または `config.add_router_probs=True` の場合に返されます) -- `torch.FloatTensor` のタプル（レイヤーごとに1つ）、形状は `(batch_size, sequence_length, num_experts)`。 モデルのRouter logits。Mixture of Expertsモデルの補助損失を計算するのに役立ちます。 ## UnlimitedOcrForConditionalGeneration[[transformers.UnlimitedOcrForConditionalGeneration]] #### transformers.UnlimitedOcrForConditionalGeneration[[transformers.UnlimitedOcrForConditionalGeneration]] ```python transformers.UnlimitedOcrForConditionalGeneration(config: UnlimitedOcrConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L1999) **パラメータ:** config ([UnlimitedOcrConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 他のモダリティ（例：画像とテキストからテキストへの生成）に条件付けられたトークン生成のためのUnlimited Ocr 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.UnlimitedOcrForConditionalGeneration.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, pixel_values: typing.Optional[torch.FloatTensor] = None, pixel_values_local: typing.Optional[torch.FloatTensor] = None, num_local_patches: list[int] | None = None, patches_grid: list[list[int]] | None = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, logits_to_keep: typing.Union[int, torch.Tensor] = 0, mm_encoder_outputs: dict[str, transformers.modeling_outputs.BaseModelOutputWithPooling] | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/unlimited_ocr/modeling_unlimited_ocr.py#L2037) **パラメータ:** input_ids (`torch.LongTensor`、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) pixel_values (`torch.FloatTensor`、形状 `(batch_size, num_channels, image_size, image_size)`、*任意*) : 入力画像に対応するテンソルです。ピクセル値は [UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) を使用して取得できます。詳細は [UnlimitedOcrImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[UnlimitedOcrProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrProcessor) は画像の処理に [UnlimitedOcrImageProcessor](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrImageProcessor) を使用します）。 pixel_values_local (`torch.FloatTensor`, *任意*) : 形が `(total_patches, 3, H, W)` のローカルパッチのピクセル値。 num_local_patches (`list[int]`, *任意*) : バッチ内の各画像あたりのローカルパッチ数。 patches_grid (`list[list[int]]`, *任意*) : 各画像のパッチグリッド `(num_columns, num_rows)`。 attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) position_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックスです。`[0, config.n_positions - 1]` の範囲から選択されます。 [位置 ID とは何か？](../glossary#position-ids) 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)`）のみを入力する必要があります。 inputs_embeds (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 labels (`torch.LongTensor`、形状 `(batch_size, sequence_length)`、*任意*) : マスク言語モデリング損失を計算するためのラベル。インデックスは `[0, ..., config.vocab_size]` の範囲内であるか、-100 である必要があります（`input_ids` のドキュメント文字列を参照）。インデックスが `-100` に設定されたトークンは無視（マスク）され、損失は `[0, ..., config.vocab_size]` の範囲内のラベルを持つトークンに対してのみ計算されます。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 logits_to_keep (`Union[int, torch.Tensor]`、*任意*、デフォルトは `0`) : `int` の場合、最後の `logits_to_keep` トークンについて logits を計算します。`0` の場合、すべての `input_ids` について logits を計算します（特殊ケース）。生成には最後のトークンの logits だけで十分であり、そのトークンのみについて計算することでメモリを節約できます。これは、長いシーケンスや大規模な語彙サイズの場合に特に顕著な効果があります。`torch.Tensor` の場合、シーケンス長次元で保持するインデックスに対応する 1 次元である必要があります。これは、パックされたテンソル形式（バッチとシーケンス長を単一の次元にまとめる形式）を使用する場合に有用です。 mm_encoder_outputs (`dict[str, ~modeling_outputs.BaseModelOutputWithPooling]`, *任意*) : キーがサポートされているモダリティ、値がそのモダリティのエンコード済み出力である辞書。各エンコード済み出力は、(`pooler_output`、*任意*: `last_hidden_states`、*任意*: `hidden_states`、*任意*: `attentions`) という形式のタプルで、`pooler_output` の形状は `(batch_size, sequence_length, hidden_size)`、*任意*) であり、エンコーダーのマルチモーダル特徴量をテキスト埋め込みにマージしたシーケンスです。 **戻り値:** `UnlimitedOcrCausalLMOutputWithPast` または `tuple(torch.FloatTensor)` `UnlimitedOcrCausalLMOutputWithPast` または、`return_dict=False` が渡された場合、または `config.return_dict=False` の場合、`torch.FloatTensor` のタプル。設定（[UnlimitedOcrConfig](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrConfig)）や入力に応じて、さまざまな要素で構成されます。 [UnlimitedOcrForConditionalGeneration](/docs/transformers/main/ja/model_doc/unlimited_ocr#transformers.UnlimitedOcrForConditionalGeneration)の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** (`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)を参照してください。 逐次デコーディングを高速化するために使用できる（`past_key_values` 入力参照）、事前計算済みの隠れ状態（自己注意ブロックのキーとバリュー）が含まれます。 - **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、および任意の初期埋め込み出力。 - **attentions** (`tuple[torch.FloatTensor]`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 - **image_hidden_states** (`torch.FloatTensor`、*任意*) -- サイズが (batch_size * num_patches, num_images, sequence_length, hidden_size) の `torch.FloatTensor`。ビジョンエンコーダーによって生成され、最後の隠れ状態を投影した後のモデルの image_hidden_states です。 - **router_logits** (`tuple[torch.FloatTensor]`、*optional*、`output_router_logits=True` が渡された場合または `config.add_router_probs=True` の場合に返されます) -- `torch.FloatTensor` のタプル（レイヤーごとに1つ）、形状は `(batch_size, sequence_length, num_experts)`。 モデルのRouter logits。Mixture of Expertsモデルの補助損失を計算するのに役立ちます。 単一ページ OCR の例: ```python >>> from transformers import AutoProcessor, AutoModelForImageTextToText >>> model = AutoModelForImageTextToText.from_pretrained("baidu/Unlimited-OCR", device_map="auto") >>> processor = AutoProcessor.from_pretrained("baidu/Unlimited-OCR") >>> image = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg" >>> messages = [ ... { ... "role": "user", ... "content": [{"type": "image", "url": image}, {"type": "text", "text": "document parsing."}], ... } ... ] >>> inputs = processor.apply_chat_template( ... messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt" ... ).to(model.device, model.dtype) >>> output = model.generate(**inputs) >>> processor.decode(output[0, inputs["input_ids"].shape[1]:], skip_special_tokens=True) >>> # image [383, 87, 497, 171]\ntext [333, 201, 558, 230]R&D QUALITY IMPROVEMENT\nSUGGESTION/SOLUTION FORM... ``` マルチページOCRの例: ```python >>> from transformers import AutoProcessor, AutoModelForImageTextToText >>> model = AutoModelForImageTextToText.from_pretrained("baidu/Unlimited-OCR", device_map="auto") >>> processor = AutoProcessor.from_pretrained("baidu/Unlimited-OCR") >>> page1 = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_suggestion_form.jpg" >>> page2 = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/model_doc/ocr_receipt.jpeg" >>> messages = [ ... { ... "role": "user", ... "content": [{"type": "image", "url": page} for page in [page1, page2]] ... + [{"type": "text", "text": "Multi page parsing."}], ... } ... ] >>> inputs = processor.apply_chat_template( ... messages, ... add_generation_prompt=True, ... tokenize=True, ... return_dict=True, ... return_tensors="pt", ... processor_kwargs={"crop_to_patches": False}, ... ).to(model.device, model.dtype) >>> output = model.generate( ... **inputs, ... no_repeat_ngram_window_size=1024, ... ) >>> processor.decode(output[0, inputs["input_ids"].shape[1]:], skip_special_tokens=True) >>> # image [382, 87, 489, 174]\ntitle [333, 201, 556, 230]R&D QUALITY IMPROVEMENT\nSUGGESTION/SCLUTION FORM... ```