license: apache-2.0
pipeline_tag: sentence-similarity
tags:

• Sentence Transformers
• sentence-similarity
• sentence-transformers
  datasets:
• shibing624/nli_zh
  language:
• zh
  library_name: sentence-transformers

shibing624/text2vec-base-chinese

这是一个基于CoSENT（余弦句子）的模型：shibing624/text2vec-base-chinese。

它将句子映射到768维的密集向量空间，可用于句子嵌入、文本匹配或语义搜索等任务。

评估

关于该模型的自动化评估，请参见评估基准：text2vec

• 中文文本匹配任务：

说明：

• 结果评测指标：Spearman系数
• shibing624/text2vec-base-chinese模型采用CoSENT方法训练，基于hfl/chinese-macbert-base在中文STS-B数据上训练得到，并在中文STS-B测试集上表现优异。运行examples/training_sup_text_matching_model.py可训练模型，模型文件已上传至HF model hub，推荐用于中文通用语义匹配任务。
• 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 model hub，推荐用于中文句子对句子（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 model hub，推荐用于中文句子对段落（s2p）语义匹配任务。
• sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2模型采用SBERT训练，是paraphrase-MiniLM-L12-v2模型的多语言版本，支持中文、英文等。
• w2v-light-tencent-chinese是腾讯词向量的Word2Vec模型，适用于CPU加载场景，适合中文字面匹配任务和冷启动情况。

使用（text2vec）

安装text2vec后即可轻松使用该模型：

pip install -U text2vec

使用示例：

from text2vec import SentenceModel
sentences = ['如何更换花呗绑定银行卡', '花呗更改绑定银行卡']

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

使用（HuggingFace Transformers）

若不使用text2vec，可按以下方式使用模型：

首先通过transformer模型处理输入，然后对上下文词嵌入应用适当的池化操作。

安装transformers：

pip install transformers

加载模型并预测：

from transformers import BertTokenizer, BertModel
import torch

# 均值池化 - 考虑注意力掩码以正确平均
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0]  # 模型输出的第一个元素包含所有词嵌入
    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)

# 从HuggingFace Hub加载模型
tokenizer = BertTokenizer.from_pretrained('shibing624/text2vec-base-chinese')
model = BertModel.from_pretrained('shibing624/text2vec-base-chinese')
sentences = ['如何更换花呗绑定银行卡', '花呗更改绑定银行卡']
# 分词
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# 计算词嵌入
with torch.no_grad():
    model_output = model(**encoded_input)
# 执行池化（此处为均值池化）
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
print("句子嵌入：")
print(sentence_embeddings)

使用（sentence-transformers）

sentence-transformers是计算句子稠密向量表示的流行库。

安装sentence-transformers：

pip install -U sentence-transformers

加载模型并预测：

from sentence_transformers import SentenceTransformer

m = SentenceTransformer("shibing624/text2vec-base-chinese")
sentences = ['如何更换花呗绑定银行卡', '花呗更改绑定银行卡']

sentence_embeddings = m.encode(sentences)
print("句子嵌入：")
print(sentence_embeddings)

模型加速

简而言之：

1. ✅ shibing624/text2vec-base-chinese (onnx-O4)：ONNX优化至O4不会降低性能，且在GPU上提供约2倍加速。
2. ✅ shibing624/text2vec-base-chinese (ov)：OpenVINO不会降低性能，且在CPU上提供1.12倍加速。
3. 🟡 shibing624/text2vec-base-chinese (ov-qint8)：使用OV进行int8量化在某些任务上会有小幅性能下降，而在其他任务上略有提升（量化基于Chinese STSB）。此外，在CPU上可实现4.78倍加速。

• 使用示例：shibing624/text2vec-base-chinese (onnx-O4)，适用于GPU

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "shibing624/text2vec-base-chinese",
    backend="onnx",
    model_kwargs={"file_name": "model_O4.onnx"},
)
embeddings = model.encode(["如何更换花呗绑定银行卡", "花呗更改绑定银行卡", "你是谁"])
print(embeddings.shape)
similarities = model.similarity(embeddings, embeddings)
print(similarities)

• 使用示例：shibing624/text2vec-base-chinese (ov)，适用于CPU

# pip install 'optimum[openvino]'

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "shibing624/text2vec-base-chinese",
    backend="openvino",
)

embeddings = model.encode(["如何更换花呗绑定银行卡", "花呗更改绑定银行卡", "你是谁"])
print(embeddings.shape)
similarities = model.similarity(embeddings, embeddings)
print(similarities)

• 使用示例：shibing624/text2vec-base-chinese (ov-qint8)，适用于CPU

# pip install optimum
from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "shibing624/text2vec-base-chinese",
    backend="onnx",
    model_kwargs={"file_name": "model_qint8_avx512_vnni.onnx"},
)
embeddings = model.encode(["如何更换花呗绑定银行卡", "花呗更改绑定银行卡", "你是谁"])
print(embeddings.shape)
similarities = model.similarity(embeddings, embeddings)
print(similarities)

完整模型架构

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

预期用途

本模型旨在作为句子和短段落编码器使用。给定输入文本，它输出捕获语义信息的向量。该句子向量可用于信息检索、聚类或句子相似度任务。

默认情况下，超过256个词片的输入文本会被截断。

训练过程

预训练

我们使用预训练的hfl/chinese-macbert-base模型。
关于预训练过程的更多细节，请参考模型卡片。

微调

我们使用对比目标进行微调。具体来说，计算批次中所有可能的句子对的余弦相似度，然后通过比较正样本对和负样本对应用排序损失。

超参数

• 训练数据集：https://huggingface.co/datasets/shibing624/nli_zh
• 最大序列长度：128
• 最佳epoch：5
• 句子嵌入维度：768

引用与作者

该模型由text2vec训练。

如果觉得本模型有帮助，欢迎引用：

@software{text2vec,
  author = {徐明},
  title = {text2vec: 文本转向量工具},
  year = {2022},
  url = {https://github.com/shibing624/text2vec},
}