Transformers documentation

視覚的ドキュメント検索

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

視覚的ドキュメント検索

ドキュメントには、テキストに加えてチャート、テーブル、ビジュアルが含まれている場合があり、マルチモーダルデータを含むことがあります。これらのドキュメントから情報を検索することは困難です。テキスト検索モデルだけでは視覚データを処理できず、画像検索モデルには粒度とドキュメント処理の機能が不足しているためです。

ビジュアルドキュメント検索は、マルチモーダル検索拡張生成(RAG)を含む、あらゆる種類のドキュメントから情報を検索するのに役立ちます。これらのモデルは、ドキュメント(画像として)とテキストを受け取り、それらの間の類似度スコアを計算します。

このガイドでは、ColPaliを使用してドキュメントのインデックス作成と検索を行う方法を紹介します。

大規模なユースケースでは、ベクトルデータベースを使用してドキュメントのインデックス作成と検索を行うことを検討してください。

Transformers と Datasets がインストールされていることを確認してください。

pip install -q datasets transformers

UFO目撃に関する文書のデータセットをインデックス付けします。対象の列が欠落しているサンプルをフィルタリングします。データセットには複数の列が含まれており、文書の短い要約を含むspecific_detail_query列と、文書本体を含むimage列が対象です。

from datasets import load_dataset

dataset = load_dataset("davanstrien/ufo-ColPali")
dataset = dataset["train"]
dataset = dataset.filter(lambda example: example["specific_detail_query"] is not None)
print(dataset)
Dataset({
    features: ['image', 'raw_queries', 'broad_topical_query', 'broad_topical_explanation', 'specific_detail_query', 'specific_detail_explanation', 'visual_element_query', 'visual_element_explanation', 'parsed_into_json'],
    num_rows: 2172
})

モデルとトークナイザーを読み込みましょう。

import torch
from transformers import ColPaliForRetrieval, ColPaliProcessor
from accelerate import Accelerator

device = Accelerator().device

model_name = "vidore/colpali-v1.2-hf"

processor = ColPaliProcessor.from_pretrained(model_name)

model = ColPaliForRetrieval.from_pretrained(
    model_name,
    dtype=torch.bfloat16,
    device_map="auto",
).eval()

テキストクエリをプロセッサに渡し、モデルからインデックス付きのテキスト埋め込みを返します。画像からテキストへの検索を行う場合は、ColPaliProcessorのtextパラメータをimagesパラメータに置き換え、画像を渡します。

inputs = processor(text="a document about Mars expedition").to(model.device)
with torch.no_grad():
  text_embeds = model(**inputs, return_tensors="pt").embeddings

画像をオフラインでインデックス化し、推論時にはクエリテキストの埋め込みを返して、それに最も近い画像の埋め込みを取得します。

map を使用して、画像と画像埋め込みをデータセットに書き込み、それらを保存します。以下に示すように、インデックス付きの埋め込みを含む embeddings 列を追加します。ColPali の埋め込みはストレージを大量に消費するため、アクセラレーターから削除し、NumPy ベクトルとして CPU に保存します。

ds_with_embeddings = dataset.map(lambda example: {'embeddings': model(**processor(images=example["image"]).to(device), return_tensors="pt").embeddings.to(torch.float32).detach().cpu().numpy()})

オンライン推論では、画像埋め込みをバッチで検索し、最も関連性の高い k 個の画像を取得する関数を作成します。以下の関数は、インデックス化されたデータセット、テキスト埋め込み、上位結果の数、およびバッチサイズを受け取り、データセット内のインデックスとスコアを返します。

def find_top_k_indices_batched(dataset, text_embedding, processor, k=10, batch_size=4):
    scores_and_indices = []

    for start_idx in range(0, len(dataset), batch_size):

        end_idx = min(start_idx + batch_size, len(dataset))
        batch = dataset[start_idx:end_idx]        
        batch_embeddings = [torch.tensor(emb[0], dtype=torch.float32) for emb in batch["embeddings"]]
        scores = processor.score_retrieval(text_embedding.to("cpu").to(torch.float32), batch_embeddings)

        if hasattr(scores, "tolist"):
            scores = scores.tolist()[0]

        for i, score in enumerate(scores):
            scores_and_indices.append((score, start_idx + i))

    sorted_results = sorted(scores_and_indices, key=lambda x: -x[0])

    topk = sorted_results[:k]
    indices = [idx for _, idx in topk]
    scores = [score for score, _ in topk]

    return indices, scores

テキストの埋め込みを生成し、上記の関数に渡して、データセットのインデックスとスコアを返します。

with torch.no_grad():
  text_embeds = model(**processor(text="a document about Mars expedition").to(model.device), return_tensors="pt").embeddings
indices, scores = find_top_k_indices_batched(ds_with_embeddings, text_embeds, processor, k=3, batch_size=4)
print(indices, scores)
([440, 442, 443],
 [14.370786666870117,
  13.675487518310547,
  12.9899320602417])

Mars関連のドキュメントを確認するために、画像を表示します。

for i in indices:
  display(dataset[i]["image"])
Document 1 Document 2 Document 3
Update on GitHub