multi-qa-mpnet-base-cos-v1

这是一个 sentence-transformers 模型：它将句子和段落映射到 768 维的密集向量空间，专为语义搜索设计。该模型在来自不同来源的 2.15 亿个（问题，答案）对上进行了训练。关于语义搜索的入门介绍，请参阅：SBERT.net - Semantic Search

使用方法 (Sentence-Transformers)

当您安装了 sentence-transformers 后，使用此模型变得非常简单：

pip install -U sentence-transformers

然后您可以这样使用该模型：

from sentence_transformers import SentenceTransformer, util

query = \"How many people live in London?\"
docs = [\"Around 9 Million people live in London\", \"London is known for its financial district\"]

#Load the model
model = SentenceTransformer('sentence-transformers/multi-qa-mpnet-base-cos-v1')

#Encode query and documents
query_emb = model.encode(query)
doc_emb = model.encode(docs)

#Compute dot score between query and all document embeddings
scores = util.dot_score(query_emb, doc_emb)[0].cpu().tolist()

#Combine docs & scores
doc_score_pairs = list(zip(docs, scores))

#Sort by decreasing score
doc_score_pairs = sorted(doc_score_pairs, key=lambda x: x[1], reverse=True)

#Output passages & scores
for doc, score in doc_score_pairs:
    print(score, doc)

使用方法 (HuggingFace Transformers)

如果没有使用 sentence-transformers，您可以这样使用该模型：首先将输入通过 transformer 模型，然后需要在上下文词嵌入的顶部应用正确的池化操作。

from transformers import AutoTokenizer, AutoModel
import torch
import torch.nn.functional as F

# Mean Pooling - Take average of all tokens
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output.last_hidden_state # First element of model_output contains all token embeddings
    input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
    return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)


# Encode text
def encode(texts):
    # Tokenize sentences
    encoded_input = tokenizer(texts, padding=True, truncation=True, return_tensors='pt')

    # Compute token embeddings
    with torch.no_grad():
        model_output = model(**encoded_input, return_dict=True)

    # Perform pooling
    embeddings = mean_pooling(model_output, encoded_input['attention_mask'])

    # Normalize embeddings
    embeddings = F.normalize(embeddings, p=2, dim=1)
	
    return embeddings


# Sentences we want sentence embeddings for
query = \"How many people live in London?\"
docs = [\"Around 9 Million people live in London\", \"London is known for its financial district\"]

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained(\"sentence-transformers/multi-qa-mpnet-base-cos-v1\")
model = AutoModel.from_pretrained(\"sentence-transformers/multi-qa-mpnet-base-cos-v1\")

# Encode query and docs
query_emb = encode(query)
doc_emb = encode(docs)

# Compute dot score between query and all document embeddings
scores = torch.mm(query_emb, doc_emb.transpose(0, 1))[0].cpu().tolist()

# Combine docs & scores
doc_score_pairs = list(zip(docs, scores))

# Sort by decreasing score
doc_score_pairs = sorted(doc_score_pairs, key=lambda x: x[1], reverse=True)

# Output passages & scores
for doc, score in doc_score_pairs:
    print(score, doc)

使用方法 (文本嵌入推理 (TEI))

文本嵌入推理 (TEI) 是一个用于文本嵌入模型的极速推理解决方案。

• CPU：

docker run -p 8080:80 -v hf_cache:/data --pull always ghcr.io/huggingface/text-embeddings-inference:cpu-latest --model-id sentence-transformers/multi-qa-mpnet-base-cos-v1 --pooling mean --dtype float16

• NVIDIA GPU：

docker run --gpus all -p 8080:80 -v hf_cache:/data --pull always ghcr.io/huggingface/text-embeddings-inference:cuda-latest --model-id sentence-transformers/multi-qa-mpnet-base-cos-v1 --pooling mean --dtype float16

向 /v1/embeddings 发送请求以通过 OpenAI 嵌入 API 生成嵌入：

curl http://localhost:8080/v1/embeddings \
  -H \"Content-Type: application/json\" \
  -d '{
    \"model\": \"sentence-transformers/multi-qa-mpnet-base-cos-v1\",
    \"input\": \"How many people live in London?\"
  }'

或者查看 文本嵌入推理 API 规范。

技术细节

以下是有关如何使用此模型的一些技术细节：

注意：当使用 sentence-transformers 加载时，此模型生成的嵌入归一化长度为 1。在这种情况下，点积和余弦相似度是等价的。点积更受青睐，因为它的速度更快。欧氏距离与点积成正比，也可以使用。

背景

该项目旨在使用大规模句子级数据集和自监督对比学习目标来训练句子嵌入模型。我们使用对比学习目标：给定一个句子对中的一个句子，模型应该预测在我们的数据集中实际与它配对的句子是从一组随机采样的其他句子中的哪一个。

我们是在 Hugging Face 社区周 JAX/Flax 用于 NLP 和 CV 期间开发这个模型的。作为以下项目的一部分开发了这个模型： 用 10 亿训练对训练有史以来最好的句子嵌入模型。我们受益于高效硬件基础设施来运行该项目：7 个 TPU v3-8，以及来自 Google Flax、JAX 和云团队成员关于高效深度学习框架的帮助。

预期用途

我们的模型用于语义搜索：它将查询/问题和对文本段落编码到密集向量空间中。它可以为给定的段落找到相关文档。

请注意，WordPiece 令牌限制为 512 个：超过此长度的文本将被截断。另请注意，该模型仅在最多 250 个 WordPiece 的输入文本上进行过训练。对于较长的文本，它可能效果不佳。

训练过程

完整的训练脚本可在当前仓库中访问：train_script.py。

预训练

我们使用预训练的 mpnet-base 模型。关于预训练程序的更多详细信息，请参阅模型卡片。

训练

我们使用多个数据集的连接来微调我们的模型。总共有约 2.15 亿个（问题，答案）对。 我们根据加权概率对每个数据集进行采样，具体配置在 data_config.json 文件中详细说明。

该模型使用 MultipleNegativesRankingLoss 进行训练，使用 Mean-pooling（平均池化）、余弦相似度作为相似度函数，缩放值为 20。