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