Modernbert Base ColBERT

🚀 基于answerdotai/ModernBERT-base的PyLate模型

本模型基于answerdotai/ModernBERT-base，在训练数据集上进行微调。它能将句子和段落映射为128维的密集向量序列，可通过MaxSim算子用于语义文本相似度计算。

🚀 快速开始

本模型是基于answerdotai/ModernBERT-base微调的PyLate模型，可用于语义文本相似度任务。以下是使用该模型的基本步骤：

1. 安装PyLate库。
2. 加载模型并进行文档索引和检索。
3. 可根据需求进行重排序操作。

✨ 主要特性

• 高效映射：能够将句子和段落映射为128维的密集向量，便于进行语义文本相似度计算。
• 多场景应用：支持文档索引、检索和重排序等多种应用场景。
• 集成Voyager索引：在检索过程中，利用Voyager HNSW索引高效处理文档嵌入，实现快速检索。

📦 安装指南

首先，安装PyLate库：

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
)

高级用法

重排序

如果仅想使用ColBERT模型在一级检索管道的基础上进行重排序，而不构建索引，可以使用rank函数：

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文档
• 仓库：GitHub上的PyLate
• Hugging Face：Hugging Face上的PyLate模型

完整模型架构

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，版本为11e6ffa
• 大小：808,728个训练样本
• 列：query_id、document_ids和scores
• 基于前1000个样本的近似统计信息：

  	query_id	document_ids	scores
  类型	字符串	列表	列表
  详情	最小：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

📄 许可证

文档未提及相关信息。

🔧 技术细节

本模型基于answerdotai/ModernBERT-base进行微调，使用ColBERT架构。在训练过程中，利用Voyager HNSW索引对文档嵌入进行高效处理，以实现快速检索。模型将句子和段落映射为128维的密集向量，通过MaxSim算子计算语义文本相似度。训练数据集为lightonai/ms-marco-en-bge，包含808,728个样本。训练过程中使用了Distillation损失函数，并设置了一系列超参数，如per_device_train_batch_size为16，learning_rate为8e-05等。

📄 引用

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}
}