S DagoBERT STSb

🚀 {s-DagoBERT-STSb}

{s-DagoBERT-STSb} 是一个 sentence-transformers 模型，它可以将句子和段落映射到 768 维的密集向量空间，可用于聚类或语义搜索等任务。

🚀 快速开始

安装依赖

若要使用此模型，需先安装 sentence-transformers：

pip install -U 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)

✨ 主要特性

• 向量映射：能够将句子和段落映射到 768 维的密集向量空间。
• 多任务适用性：可用于聚类、语义搜索等多种自然语言处理任务。

📦 安装指南

使用此模型前，需安装 sentence-transformers，安装命令如下：

pip install -U 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)

高级用法

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)

📚 详细文档

评估结果

若要对该模型进行自动化评估，可参考 Sentence Embeddings Benchmark：https://seb.sbert.net

训练参数

该模型的训练参数如下：

数据加载器

torch.utils.data.dataloader.DataLoader，长度为 44，参数如下：

{'batch_size': 128, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}

损失函数

sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss

训练方法参数

{
    "epochs": 15,
    "evaluation_steps": 360,
    "evaluator": "sentence_transformers.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator",
    "max_grad_norm": 1,
    "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
    "optimizer_params": {
        "lr": 3e-05
    },
    "scheduler": "WarmupLinear",
    "steps_per_epoch": null,
    "warmup_steps": 50,
    "weight_decay": 0
}

完整模型架构

SentenceTransformer(
  (0): Transformer({'max_seq_length': 80, 'do_lower_case': False}) with Transformer model: RobertaModel 
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
)

🔧 技术细节

该模型基于 sentence-transformers 框架构建，利用 Transformer 架构将句子和段落映射到 768 维的密集向量空间。在训练过程中，使用了 CosineSimilarityLoss 损失函数，并结合 AdamW 优化器进行参数更新。通过池化操作（如均值池化）对上下文词嵌入进行处理，以获得句子级别的向量表示。

📄 许可证

文档中未提及许可证相关信息。

Citing & Authors

文档中未提供相关信息。