🚀 {MODEL_NAME}
這是一個 sentence-transformers 模型:它可以將句子和段落映射到一個 768 維的密集向量空間,可用於聚類或語義搜索等任務。
🚀 快速開始
本模型可通過兩種方式使用,分別是藉助 sentence-transformers
庫和直接使用 HuggingFace Transformers
庫。以下是詳細的使用步驟。
📦 安裝指南
若要使用 sentence-transformers
庫,可通過以下命令進行安裝:
pip install -U sentence-transformers
💻 使用示例
基礎用法(Sentence-Transformers)
from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]
model = SentenceTransformer('{MODEL_NAME}')
embeddings = model.encode(sentences)
print(embeddings)
高級用法(HuggingFace Transformers)
若不使用 sentence-transformers
庫,可按以下步驟使用模型:首先將輸入數據傳入 Transformer 模型,然後對上下文詞嵌入應用合適的池化操作。
from transformers import AutoTokenizer, AutoModel
import torch
def cls_pooling(model_output, attention_mask):
return model_output[0][:,0]
sentences = ['This is an example sentence', 'Each sentence is converted']
tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
model = AutoModel.from_pretrained('{MODEL_NAME}')
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')
with torch.no_grad():
model_output = model(**encoded_input)
sentence_embeddings = cls_pooling(model_output, encoded_input['attention_mask'])
print("Sentence embeddings:")
print(sentence_embeddings)
📚 詳細文檔
評估結果
若要對該模型進行自動化評估,可參考 Sentence Embeddings Benchmark:https://seb.sbert.net
訓練細節
該模型的訓練參數如下:
數據加載器
使用 torch.utils.data.dataloader.DataLoader
,長度為 698,參數如下:
{'batch_size': 10, 'sampler': 'torch.utils.data.sampler.SequentialSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
損失函數
使用 sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss
,參數如下:
{'scale': 20.0, 'similarity_fct': 'cos_sim'}
fit() 方法的參數
{
"epochs": 2,
"evaluation_steps": 50,
"evaluator": "sentence_transformers.evaluation.InformationRetrievalEvaluator.InformationRetrievalEvaluator",
"max_grad_norm": 1,
"optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
"optimizer_params": {
"lr": 2e-05
},
"scheduler": "WarmupLinear",
"steps_per_epoch": null,
"warmup_steps": 139,
"weight_decay": 0.01
}
完整模型架構
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, 'do_lower_case': True}) with Transformer model: BertModel
(1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
)
引用與作者
如需獲取更多信息,請參考相關文檔。