Modernbert Base ColBERT

🚀 PyLateモデル（answerdotai/ModernBERT-baseベース）

このモデルは、answerdotai/ModernBERT-base を train データセットでファインチューニングした PyLate モデルです。文章や段落を128次元の密ベクトルのシーケンスにマッピングし、MaxSim演算子を使用して意味的な文章の類似度を計算することができます。

🚀 クイックスタート

このモデルを使い始めるには、まずPyLateライブラリをインストールする必要があります。

pip install -U pylate

✨ 主な機能

• 文章や段落を128次元の密ベクトルに変換することができます。
• MaxSim演算子を使用して、意味的な文章の類似度を計算することができます。
• ColBERTモデルを使用して、文書のインデックス作成と検索を行うことができます。
• 第一ステージの検索パイプラインの上で、ColBERTモデルを使用して再ランキングを行うことができます。

📦 インストール

pip install -U pylate

💻 使用例

基本的な使用法

文書のインデックス作成

from pylate import indexes, models, retrieve

# Step 1: Load the ColBERT model
model = models.ColBERT(
    model_name_or_path=pylate_model_id,
)

# Step 2: Initialize the Voyager index
index = indexes.Voyager(
    index_folder="pylate-index",
    index_name="index",
    override=True,  # This overwrites the existing index if any
)

# Step 3: Encode the documents
documents_ids = ["1", "2", "3"]
documents = ["document 1 text", "document 2 text", "document 3 text"]

documents_embeddings = model.encode(
    documents,
    batch_size=32,
    is_query=False,  # Ensure that it is set to False to indicate that these are documents, not queries
    show_progress_bar=True,
)

# Step 4: Add document embeddings to the index by providing embeddings and corresponding ids
index.add_documents(
    documents_ids=documents_ids,
    documents_embeddings=documents_embeddings,
)

インデックスの再利用

# To load an index, simply instantiate it with the correct folder/name and without overriding it
index = indexes.Voyager(
    index_folder="pylate-index",
    index_name="index",
)

クエリに対する上位k件の文書の検索

# Step 1: Initialize the ColBERT retriever
retriever = retrieve.ColBERT(index=index)

# Step 2: Encode the queries
queries_embeddings = model.encode(
    ["query for document 3", "query for document 1"],
    batch_size=32,
    is_query=True,  #  # Ensure that it is set to False to indicate that these are queries
    show_progress_bar=True,
)

# Step 3: Retrieve top-k documents
scores = retriever.retrieve(
    queries_embeddings=queries_embeddings, 
    k=10,  # Retrieve the top 10 matches for each query
)

高度な使用法

再ランキング

from pylate import rank, models

queries = [
    "query A",
    "query B",
]

documents = [
    ["document A", "document B"],
    ["document 1", "document C", "document B"],
]

documents_ids = [
    [1, 2],
    [1, 3, 2],
]

model = models.ColBERT(
    model_name_or_path=pylate_model_id,
)

queries_embeddings = model.encode(
    queries,
    is_query=True,
)

documents_embeddings = model.encode(
    documents,
    is_query=False,
)

reranked_documents = rank.rerank(
    documents_ids=documents_ids,
    queries_embeddings=queries_embeddings,
    documents_embeddings=documents_embeddings,
)

📚 ドキュメント

モデルの詳細

モデルの説明

モデルのソース

• ドキュメント: PyLate Documentation
• リポジトリ: PyLate on GitHub
• Hugging Face: PyLate models on Hugging Face

完全なモデルアーキテクチャ

ColBERT(
  (0): Transformer({'max_seq_length': 179, 'do_lower_case': False}) with Transformer model: ModernBertModel 
  (1): Dense({'in_features': 768, 'out_features': 128, 'bias': False, 'activation_function': 'torch.nn.modules.linear.Identity'})
)

学習の詳細

学習データセット

train

• データセット: train at 11e6ffa
• サイズ: 808,728学習サンプル
• 列: query_id、document_ids、scores
• 最初の1000サンプルに基づく概算統計:

  	query_id	document_ids	scores
  タイプ	string	list	list
  詳細	最小: 5トークン 平均: 5.59トークン 最大: 6トークン	サイズ: 32要素	サイズ: 32要素

• サンプル:

  query_id	document_ids	scores
  121352	['2259784', '4923159', '40211', '1545154', '8527175', ...]	[0.2343463897705078, 0.639204204082489, 0.3806908428668976, 0.5623092651367188, 0.8051995635032654, ...]
  634306	['7723525', '1874779', '379307', '2738583', '7599583', ...]	[0.7124203443527222, 0.7379189729690552, 0.5786551237106323, 0.6142299175262451, 0.6755089163780212, ...]
  920825	['5976297', '2866112', '3560294', '3285659', '4706740', ...]	[0.6462352871894836, 0.7880821228027344, 0.791019856929779, 0.7709633111953735, 0.8284491300582886, ...]

• 損失: pylate.losses.distillation.Distillation

評価結果

多ベクトル検索モデルのnDCG@10スコア

学習ハイパーパラメータ

非デフォルトのハイパーパラメータ

• per_device_train_batch_size: 16
• learning_rate: 8e-05
• num_train_epochs: 1
• warmup_ratio: 0.05
• bf16: True

すべてのハイパーパラメータ

フレームワークのバージョン

• Python: 3.11.9
• Sentence Transformers: 3.3.0
• PyLate: 1.1.4
• Transformers: 4.48.0.dev0
• PyTorch: 2.4.0
• Accelerate: 1.2.1
• Datasets: 2.21.0
• Tokenizers: 0.21.0

📄 ライセンス

ライセンス情報は不明です。

📄 引用

BibTeX

Sentence Transformers

@inproceedings{reimers-2019-sentence-bert,
    title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
    author = "Reimers, Nils and Gurevych, Iryna",
    booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
    month = "11",
    year = "2019",
    publisher = "Association for Computational Linguistics",
    url = "https://arxiv.org/abs/1908.10084"
}

PyLate

@misc{PyLate,
title={PyLate: Flexible Training and Retrieval for Late Interaction Models},
author={Chaffin, Antoine and Sourty, Raphaël},
url={https://github.com/lightonai/pylate},
year={2024}
}