# ColPali [ColPali](https://huggingface.co/papers/2407.01449) は、視覚的特徴を分析してドキュメントを検索するために設計されたモデルです。テキスト抽出や OCR に大きく依存する従来のシステムとは異なり、ColPali は各ページを画像として扱います。[Paligemma-3B](./paligemma) を使用して、テキストだけでなく、レイアウト、表、チャート、その他の視覚的要素も捉え、ペアワイズな遅延相互作用類似度スコアを計算して検索に使用できる詳細なマルチベクトル埋め込みを生成します。これにより、ドキュメントに対するより包括的な理解が可能になり、より効率的かつ正確な検索が実現します。 このモデルは、[@tonywu71](https://huggingface.co/tonywu71)（ILLUIN Technology）と[@yonigozlan](https://huggingface.co/yonigozlan)（HuggingFace）によって提供されました。 Vidoreの[Hf-native ColVision Models](https://huggingface.co/collections/vidore/hf-native-colvision-models-6755d68fc60a8553acaa96f7)コレクションに、すべてのオリジナルのColPaliチェックポイントを見つけることができます。 > [!TIP] > ColPali を画像検索に活用するその他の例については、右側のサイドバーにある ColPali モデルをクリックしてください。 ```python import requests import torch from PIL import Image from transformers import ColPaliForRetrieval, ColPaliProcessor # Load the model and the processor model_name = "vidore/colpali-v1.3-hf" model = ColPaliForRetrieval.from_pretrained( model_name, device_map="auto", # "cpu", "cuda", "xpu", or "mps" for Apple Silicon ) processor = ColPaliProcessor.from_pretrained(model_name) # The document page screenshots from your corpus url1 = "https://upload.wikimedia.org/wikipedia/commons/8/89/US-original-Declaration-1776.jpg" url2 = "https://upload.wikimedia.org/wikipedia/commons/thumb/4/4c/Romeoandjuliet1597.jpg/500px-Romeoandjuliet1597.jpg" images = [ Image.open(requests.get(url1, stream=True).raw), Image.open(requests.get(url2, stream=True).raw), ] # The queries you want to retrieve documents for queries = [ "When was the United States Declaration of Independence proclaimed?", "Who printed the edition of Romeo and Juliet?", ] # Process the inputs inputs_images = processor(images=images).to(model.device) inputs_text = processor(text=queries).to(model.device) # Forward pass with torch.no_grad(): image_embeddings = model(**inputs_images).embeddings query_embeddings = model(**inputs_text).embeddings # Score the queries against the images scores = processor.score_retrieval(query_embeddings, image_embeddings) print("Retrieval scores (query x image):") print(scores) ``` PILでの画像読み込みに問題がある場合は、以下のコードを使用してダミー画像を作成できます。 ```python images = [ Image.new("RGB", (128, 128), color="white"), Image.new("RGB", (64, 32), color="black"), ] ``` Quantization は、重みを低精度で表現することで、大規模モデルのメモリ負荷を軽減します。利用可能な Quantization バックエンドの詳細については、[Quantization](../quantization/overview) の概要を参照してください。 以下の例では、[bitsandbytes](../quantization/bitsandbytes)を使用して重みをint4に量子化します。 ```python import requests import torch from PIL import Image from transformers import BitsAndBytesConfig, ColPaliForRetrieval, ColPaliProcessor model_name = "vidore/colpali-v1.3-hf" # 4-bit quantization configuration bnb_config = BitsAndBytesConfig( load_in_4bit=True, bnb_4bit_use_double_quant=True, bnb_4bit_quant_type="nf4", bnb_4bit_compute_dtype=torch.float16, ) model = ColPaliForRetrieval.from_pretrained( model_name, quantization_config=bnb_config, device_map="auto", ) processor = ColPaliProcessor.from_pretrained(model_name) url1 = "https://upload.wikimedia.org/wikipedia/commons/8/89/US-original-Declaration-1776.jpg" url2 = "https://upload.wikimedia.org/wikipedia/commons/thumb/4/4c/Romeoandjuliet1597.jpg/500px-Romeoandjuliet1597.jpg" images = [ Image.open(requests.get(url1, stream=True).raw), Image.open(requests.get(url2, stream=True).raw), ] queries = [ "When was the United States Declaration of Independence proclaimed?", "Who printed the edition of Romeo and Juliet?", ] # Process the inputs inputs_images = processor(images=images, return_tensors="pt").to(model.device) inputs_text = processor(text=queries, return_tensors="pt").to(model.device) # Forward pass with torch.no_grad(): image_embeddings = model(**inputs_images).embeddings query_embeddings = model(**inputs_text).embeddings # Score the queries against the images scores = processor.score_retrieval(query_embeddings, image_embeddings) print("Retrieval scores (query x image):") print(scores) ``` ## 注記 - `score_retrieval()` は、第1次元がクエリの数、第2次元が画像の数である2次元テンソルを返します。スコアが高いほど、クエリと画像の類似度が高いことを示します。 ## ColPaliConfig[[transformers.ColPaliConfig]] #### transformers.ColPaliConfig[[transformers.ColPaliConfig]] ```python transformers.ColPaliConfig(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, vlm_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, embedding_dim: int = 128) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/colpali/configuration_colpali.py#L28) **パラメータ:** vlm_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`, *optional*) : ビジョン・言語バックボーンの config オブジェクトまたは辞書。 embedding_dim (`int`、*optional*、デフォルトは`128`) : 埋め込みおよび隠れ状態の次元数。 これはColpaliModelの設定を保存するための設定クラスです。指定された引数に基づいてColpaliモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[vidore/colpali-v1.2](https://huggingface.co/vidore/colpali-v1.2)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 例: ```python from transformers.models.colpali import ColPaliConfig, ColPaliForRetrieval config = ColPaliConfig() model = ColPaliForRetrieval(config) ``` ## ColPaliProcessor[[transformers.ColPaliProcessor]] #### transformers.ColPaliProcessor[[transformers.ColPaliProcessor]] ```python transformers.ColPaliProcessor(image_processor = None, tokenizer = None, chat_template = None, visual_prompt_prefix: str = 'Describe the image.', query_prefix: str = 'Question: ') ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/colpali/processing_colpali.py#L54) **パラメータ:** image_processor (`SiglipImageProcessor`) : 画像プロセッサは必須の入力です。 tokenizer (`tokenizer_class`) : トークナイザーは必須の入力です。 chat_template (`str`) : チャット内のメッセージのリストをトークン化可能な文字列に変換するための Jinja テンプレート。 visual_prompt_prefix (`str`、*任意*、デフォルトは `"Describe the image."`) : トークン化されて画像トークンの前に付加される文字列。 query_prefix (`str`、*任意*、デフォルトは`"Question : "`)：クエリに使用するプレフィックス。 画像プロセッサとトークナイザーを単一のプロセッサにラップするColPaliProcessorを構築します。 [ColPaliProcessor](/docs/transformers/main/ja/model_doc/colpali#transformers.ColPaliProcessor) は、[SiglipImageProcessor](/docs/transformers/main/ja/model_doc/siglip#transformers.SiglipImageProcessor) と `tokenizer_class` のすべての機能を提供します。詳細については、[~SiglipImageProcessor](/docs/transformers/main/ja/model_doc/siglip#transformers.SiglipImageProcessor) および `~tokenizer_class` を参照してください。 #### __call__[[transformers.ColPaliProcessor.__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/colpali/processing_colpali.py#L94) **パラメータ:** 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 クラスを参照してください。 **戻り値:** [BatchFeature](/docs/transformers/main/ja/main_classes/feature_extractor#transformers.BatchFeature) 以下のフィールドを持つ[BatchFeature](/docs/transformers/main/ja/main_classes/feature_extractor#transformers.BatchFeature): - **input_ids** -- モデルに与えるトークンIDのリスト。`text`が`None`でない場合に返されます。`suffix`が指定されている場合、`input_ids`にはサフィックスのinput idsも含まれます。 - **attention_mask** -- モデルが注意すべきトークンを指定するインデックスのリスト（`return_attention_mask=True`の場合、または`self.model_input_names`に*"attention_mask"*が含まれており`text`が`None`でない場合）。 - **pixel_values** -- モデルに渡すピクセル値。`images` が `None` でない場合に返されます。 - **labels** -- `suffix`がNoneでない場合に、トレーニングと互換性のあるラベル ## ColPaliForRetrieval[[transformers.ColPaliForRetrieval]] #### transformers.ColPaliForRetrieval[[transformers.ColPaliForRetrieval]] ```python transformers.ColPaliForRetrieval(config: ColPaliConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/colpali/modeling_colpali.py#L90) **パラメータ:** config ([ColPaliConfig](/docs/transformers/main/ja/model_doc/colpali#transformers.ColPaliConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 ColPali アーキテクチャは、VLM を活用して、文書検索のために文書画像（「スクリーンショット」）から直接効率的なマルチベクトル埋め込みを構築します。このモデルは、ColBERT で導入された遅延相互作用（late interaction）手法を用いて、これらの文書埋め込みと対応するクエリ埋め込みの類似度を最大化するように学習されます。 ColPali を使用すると、テキストとビジュアル（レイアウト、チャートなど）の両方の内容を単一のモデルで考慮できるため、複雑で脆弱になりがちなレイアウト認識や OCR パイプラインの必要性がなくなります。 ColPaliは、以下の論文で初めて紹介されたColVisionモデルファミリーの一部です: [*ColPali: Efficient Document Retrieval with Vision Language Models*](https://huggingface.co/papers/2407.01449)。 このモデルは [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.ColPaliForRetrieval.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, pixel_values: typing.Optional[torch.FloatTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/colpali/modeling_colpali.py#L104) **パラメータ:** 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`、shape `(batch_size, num_channels, image_size, image_size)`、*optional*) : 入力画像に対応するテンソルです。ピクセル値は `image_processor_class` を使用して取得できます。詳細は `image_processor_class.__call__` を参照してください（`processor_class` は画像の処理に `image_processor_class` を使用します）。 attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) **戻り値:** `ColPaliForRetrievalOutput` または `tuple(torch.FloatTensor)` `ColPaliForRetrievalOutput`、または`torch.FloatTensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。設定（`None`）や入力に応じて、さまざまな要素で構成されます。 [ColPaliForRetrieval](/docs/transformers/main/ja/model_doc/colpali#transformers.ColPaliForRetrieval)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **loss** (`torch.FloatTensor`、shape `(1,)`、*optional*、`labels` が指定された場合に返されます) -- 言語モデリングの損失(次のトークンの予測用)。 - **embeddings** (`torch.FloatTensor`、形状 `(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)を参照してください。 逐次デコーディングを高速化するために使用できる（`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_images, sequence_length, hidden_size)` の `torch.FloatTensor`。ビジュアルエンコーダーによって生成されたモデルの image_hidden_states。最後の隠れ状態を投影した後のものです。