Rubert Tiny Bviolet

🚀 {MODEL_NAME}

这是一个句子转换器模型：它可以将句子和段落映射到一个312维的密集向量空间，可用于聚类或语义搜索等任务。

🚀 快速开始

本模型的使用方法将根据你是否安装 sentence-transformers 库而有所不同。下面分别介绍两种情况下的使用方法。

📦 安装指南

如果你尚未安装 sentence-transformers，可以使用以下命令进行安装：

pip install -U sentence-transformers

💻 使用示例

基础用法（使用 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)

高级用法（不使用 Sentence-Transformers 库）

如果你没有安装 sentence-transformers，也可以使用本模型。首先，你需要将输入数据通过 Transformer 模型，然后对上下文词嵌入应用正确的池化操作。以下是详细的代码示例：

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)


# Sentences we want sentence embeddings for
sentences = ['This is an example sentence', 'Each sentence is converted']

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
model = AutoModel.from_pretrained('{MODEL_NAME}')

# 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)

📚 详细文档

评估结果

要对本模型进行自动评估，请参考 句子嵌入基准测试：https://seb.sbert.net

训练情况

本模型使用以下参数进行训练：

数据加载器： sentence_transformers.datasets.NoDuplicatesDataLoader.NoDuplicatesDataLoader，长度为 5750，参数如下：

{'batch_size': 8}

损失函数： sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss，参数如下：

{'scale': 20.0, 'similarity_fct': 'cos_sim'}

fit() 方法的参数：

{
    "epochs": 4,
    "evaluation_steps": 0,
    "evaluator": "NoneType",
    "max_grad_norm": 1,
    "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
    "optimizer_params": {
        "lr": 2e-05
    },
    "scheduler": "WarmupLinear",
    "steps_per_epoch": null,
    "warmup_steps": 2300,
    "weight_decay": 0.01
}

完整模型架构

SentenceTransformer(
  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel 
  (1): Pooling({'word_embedding_dimension': 312, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
)

引用与作者