Text2vec Base Chinese

🚀 shibing624/text2vec-base-chinese

這是一個CoSENT（餘弦句子）模型：shibing624/text2vec-base-chinese。它能將句子映射到一個768維的密集向量空間，可用於句子嵌入、文本匹配或語義搜索等任務。

🚀 快速開始

你可以通過以下幾種方式使用該模型：

使用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

# 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')
model = BertModel.from_pretrained('shibing624/text2vec-base-chinese')
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 是一個流行的用於計算句子密集向量表示的庫。 安裝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("Sentence embeddings:")
print(sentence_embeddings)

✨ 主要特性

• 該模型能將句子映射到768維的密集向量空間，可用於多種自然語言處理任務，如句子嵌入、文本匹配或語義搜索。
• 支持多種使用方式，可通過text2vec、HuggingFace Transformers、sentence-transformers等庫調用。
• 提供了模型加速的方法，如ONNX優化、OpenVINO加速和量化等。

📦 安裝指南

根據不同的使用方式，安裝相應的依賴庫：

• 使用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')
embeddings = model.encode(sentences)
print(embeddings)

高級用法

使用ONNX優化的模型進行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)

📚 詳細文檔

評估

對於該模型的自動評估，請參閱 評估基準：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（句子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加載使用，適用於中文字面匹配任務和缺少數據的冷啟動情況

模型加速

簡而言之：

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量化在某些任務上會有小的性能損失，在其他任務上有微小的性能提升，在使用中文STS-B進行量化時。此外，在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
• 最佳輪數：5
• 句子嵌入維度：768

🔧 技術細節

預訓練

使用預訓練的hfl/chinese-macbert-base模型，藉助其在大規模中文語料上學習到的語言知識，為後續的微調提供良好的初始化。

微調

採用對比目標進行微調，通過計算批次中句子對的餘弦相似度，並應用排序損失來優化模型。具體來說，會比較真實對和虛假對的相似度，使得真實對的相似度儘可能高，虛假對的相似度儘可能低。

超參數設置

• 訓練數據集：使用了https://huggingface.co/datasets/shibing624/nli_zh 數據集，該數據集包含了豐富的中文自然語言推理數據，有助於模型學習到更準確的語義信息。
• 最大序列長度：設置為128，這是為了在保證模型能夠處理一定長度文本的同時，控制計算資源和訓練時間。
• 最佳輪數：經過實驗確定為5，在這個輪數下模型在驗證集上的表現達到最佳。
• 句子嵌入維度：設置為768，這個維度能夠較好地捕捉句子的語義信息，同時也與預訓練模型的輸出維度相匹配。

📄 許可證

該模型使用Apache-2.0許可證。

Citing & Authors

該模型由 text2vec 團隊訓練。

如果你覺得這個模型有幫助，請隨意引用：

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