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