Text2vec Base Chinese Sentence

🚀 shibing624/text2vec-base-chinese-sentence

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

🚀 快速开始

本模型可通过text2vec、HuggingFace Transformers和sentence-transformers库使用，以下是不同库的使用方式：

使用text2vec库

安装text2vec库：

pip install -U text2vec

使用示例：

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

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

使用HuggingFace Transformers库

安装transformers库：

pip install transformers

使用示例：

from transformers import BertTokenizer, BertModel
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 = BertTokenizer.from_pretrained('shibing624/text2vec-base-chinese-sentence')
model = BertModel.from_pretrained('shibing624/text2vec-base-chinese-sentence')
sentences = ['如何更换花呗绑定银行卡', '花呗更改绑定银行卡']
# 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库：

pip install -U sentence-transformers

使用示例：

from sentence_transformers import SentenceTransformer

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

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

✨ 主要特性

• 能将句子映射到768维的密集向量空间，适用于句子嵌入、文本匹配和语义搜索等任务。
• 基于nghuyong/ernie-3.0-base-zh模型进行预训练和微调。
• 支持通过text2vec、HuggingFace Transformers和sentence-transformers等多种库使用。

📦 安装指南

根据不同的使用方式，安装相应的依赖库：

• 使用text2vec：pip install -U text2vec
• 使用HuggingFace Transformers：pip install transformers
• 使用sentence-transformers：pip install -U sentence-transformers

💻 使用示例

基础用法

使用text2vec库进行句子编码：

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

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

高级用法

使用HuggingFace Transformers库进行句子编码，包含自定义池化操作：

from transformers import BertTokenizer, BertModel
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 = BertTokenizer.from_pretrained('shibing624/text2vec-base-chinese-sentence')
model = BertModel.from_pretrained('shibing624/text2vec-base-chinese-sentence')
sentences = ['如何更换花呗绑定银行卡', '花呗更改绑定银行卡']
# 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

发布模型

本项目release模型的中文匹配评测结果如下：

说明：

• 结果评测指标：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(句子vs句子)语义匹配任务推荐使用。
• 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(sentence to paraphrase)数据，强化了其长文本的表征能力，并在中文各NLI测试集评估达到SOTA，运行examples/training_sup_text_matching_model_jsonl_data.py代码可训练模型，模型文件已经上传HF model hub，中文s2p(句子vs段落)语义匹配任务推荐使用。
• sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2模型是用SBERT训练，是paraphrase-MiniLM-L12-v2模型的多语言版本，支持中文、英文等。
• w2v-light-tencent-chinese是腾讯词向量的Word2Vec模型，CPU加载使用，适用于中文字面匹配任务和缺少数据的冷启动情况。

旧版 shibing624/text2vec-base-chinese-nli 模型放在tag1.0

模型架构

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

预期用途

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

训练过程

预训练

我们使用预训练的nghuyong/ernie-3.0-base-zh模型。有关预训练过程的更多详细信息，请参考该模型的说明文档。

微调

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

🔧 技术细节

• 训练数据集：https://huggingface.co/datasets/shibing624/nli-zh-all/tree/main/text2vec-base-chinese-sentence-dataset
• 基础模型：nghuyong/ernie-3.0-base-zh
• 最大序列长度：256
• 最佳训练轮数：3
• 句子嵌入维度：768

📄 许可证

本项目采用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},
}