Text2vec Base Multilingual

🚀 shibing624/text2vec-base-multilingual

这是一个CoSENT（余弦句子）模型：shibing624/text2vec-base-multilingual。它能将句子映射到一个384维的密集向量空间，可用于句子嵌入、文本匹配或语义搜索等任务。

🚀 快速开始

安装依赖库

若要使用该模型，需先安装text2vec：

pip install -U text2vec

使用示例

from text2vec import SentenceModel
sentences = ['如何更换花呗绑定银行卡', 'How to replace the Huabei bundled bank card']

model = SentenceModel('shibing624/text2vec-base-multilingual')
embeddings = model.encode(sentences)
print(embeddings)

不使用text2vec库的情况

若未安装text2vec，可按以下步骤使用模型：

安装transformers库

pip install transformers

加载模型并进行预测

from transformers import AutoTokenizer, AutoModel
import torch

# Mean Pooling - Take attention mask into account for correct averaging
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0]  # 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)

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('shibing624/text2vec-base-multilingual')
model = AutoModel.from_pretrained('shibing624/text2vec-base-multilingual')
sentences = ['如何更换花呗绑定银行卡', 'How to replace the Huabei bundled bank card']
# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# Compute token embeddings
with torch.no_grad():
    model_output = model(**encoded_input)
# Perform pooling. In this case, mean pooling.
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
print("Sentence embeddings:")
print(sentence_embeddings)

使用sentence-transformers库

sentence-transformers 是一个流行的用于计算句子密集向量表示的库。

安装sentence-transformers库

pip install -U sentence-transformers

加载模型并进行预测

from sentence_transformers import SentenceTransformer

m = SentenceTransformer("shibing624/text2vec-base-multilingual")
sentences = ['如何更换花呗绑定银行卡', 'How to replace the Huabei bundled bank card']

sentence_embeddings = m.encode(sentences)
print("Sentence embeddings:")
print(sentence_embeddings)

✨ 主要特性

• 多语言支持：支持多种语言，包括德语（de）、英语（en）、西班牙语（es）、法语（fr）、意大利语（it）、荷兰语（nl）、波兰语（pl）、葡萄牙语（pt）、俄语（ru）和中文（zh）。
• 密集向量空间映射：将句子映射到384维的密集向量空间，可用于句子嵌入、文本匹配或语义搜索等任务。
• 训练数据丰富：基于手动选择的多语言STS数据集进行训练，在中英文测试集上的评估效果相比原模型有所提升。

📦 安装指南

安装text2vec库

pip install -U text2vec

安装transformers库

pip install transformers

安装sentence-transformers库

pip install -U sentence-transformers

💻 使用示例

基础用法

from text2vec import SentenceModel
sentences = ['如何更换花呗绑定银行卡', 'How to replace the Huabei bundled bank card']

model = SentenceModel('shibing624/text2vec-base-multilingual')
embeddings = model.encode(sentences)
print(embeddings)

高级用法

from transformers import AutoTokenizer, AutoModel
import torch

# Mean Pooling - Take attention mask into account for correct averaging
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0]  # 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)

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('shibing624/text2vec-base-multilingual')
model = AutoModel.from_pretrained('shibing624/text2vec-base-multilingual')
sentences = ['如何更换花呗绑定银行卡', 'How to replace the Huabei bundled bank card']
# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# Compute token embeddings
with torch.no_grad():
    model_output = model(**encoded_input)
# Perform pooling. In this case, mean pooling.
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
print("Sentence embeddings:")
print(sentence_embeddings)

📚 详细文档

模型信息

评估

若要对该模型进行自动评估，请查看 评估基准：text2vec

支持语言

支持的语言包括：德语（de）、英语（en）、西班牙语（es）、法语（fr）、意大利语（it）、荷兰语（nl）、波兰语（pl）、葡萄牙语（pt）、俄语（ru）和中文（zh）。

发布模型

说明

• 结果评估指标：斯皮尔曼系数。
• shibing624/text2vec-base-chinese 模型：使用CoSENT方法进行训练，基于hfl/chinese-macbert-base在中文STS - B数据上进行训练，在中文STS - B测试集评估中取得了良好效果。运行 examples/training_sup_text_matching_model.py 代码可训练该模型，模型文件已上传至HF模型中心，推荐用于中文通用语义匹配任务。
• shibing624/text2vec-base-chinese-sentence 模型：使用CoSENT方法进行训练，基于nghuyong/ernie-3.0-base-zh的手动选择中文STS数据集 shibing624/nli-zh-all/text2vec-base-chinese-sentence-dataset 进行训练，在各中文NLI测试集评估中取得了良好效果。运行 examples/training_sup_text_matching_model_jsonl_data.py 代码可训练该模型，模型文件已上传至HF模型中心，推荐用于中文s2s（句子对句子）语义匹配任务。
• shibing624/text2vec-base-chinese-paraphrase 模型：使用CoSENT方法进行训练，基于nghuyong/ernie-3.0-base-zh的手动选择中文STS数据集 shibing624/nli-zh-all/text2vec-base-chinese-paraphrase-dataset 进行训练，该数据集相对于 shibing624/nli-zh-all/text2vec-base-chinese-sentence-dataset 添加了s2p（句子对段落）数据，增强了其长文本表示能力，在各中文NLI测试集评估中达到了SOTA。运行 examples/training_sup_text_matching_model_jsonl_data.py 代码可训练该模型，模型文件已上传至HF模型中心，推荐用于中文s2p（句子对段落）语义匹配任务。
• shibing624/text2vec-base-multilingual 模型：使用CoSENT方法进行训练，基于sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2的手动选择多语言STS数据集 shibing624/nli-zh-all/text2vec-base-multilingual-dataset 进行训练，在中英文测试集评估效果相比原模型有所提升。运行 examples/training_sup_text_matching_model_jsonl_data.py 代码可训练该模型，模型文件已上传至HF模型中心，推荐用于多语言语义匹配任务。
• w2v-light-tencent-chinese：腾讯词向量的Word2Vec模型，通过CPU加载使用，适用于中文文本匹配任务和数据缺失的冷启动场景。
• QPS的GPU测试环境：32GB内存的Tesla V100。

模型训练实验报告

实验报告

🔧 技术细节

完整模型架构

CoSENT(
  (0): Transformer({'max_seq_length': 256, 'do_lower_case': False}) with Transformer model: BertModel 
  (1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_mean_tokens': True})
)

预期用途

该模型旨在用作句子和短段落编码器。给定输入文本，它会输出一个捕获语义信息的向量。句子向量可用于信息检索、聚类或句子相似度任务。默认情况下，长度超过256个词块的输入文本将被截断。

训练过程

预训练

使用预训练的 sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 模型。有关预训练过程的更多详细信息，请参考该模型卡片。

微调

使用对比目标对模型进行微调。具体而言，计算批次中每个可能句子对的余弦相似度，然后通过与真实对和假对进行比较来应用排序损失。

📄 许可证

该模型采用Apache 2.0许可证。

引用与作者

该模型由 text2vec 团队训练。

如果您觉得该模型有帮助，请随意引用：

@software{text2vec,
  author = {Ming Xu},
  title = {text2vec: A Tool for Text to Vector},
  year = {2023},
  url = {https://github.com/shibing624/text2vec},
}