vietnamese-bi-encoder

项目介绍：Vietnamese-bi-encoder

Vietnamese-bi-encoder项目是一项关于句子相似性计算的模型开发项目，旨在将句子和段落映射到768维的稠密向量空间中，可以用于聚类或语义搜索等任务。该模型是基于sentence-transformers构建的，能够有效支持越南语的文本处理。

模型训练数据集

Vietnamese-bi-encoder模型在多个合并的训练数据集上进行训练，主要包括：

• 已翻译成越南语的MS Macro数据集
• 已翻译成越南语的SQuAD v2数据集
• 2021年Zalo法律文本检索挑战赛训练集的80%

模型使用了phobert-base-v2作为预训练的基础模型进行构建。

模型性能表现

在剩余20%的Zalo法律文本检索挑战赛的训练集上，模型的表现如下：

使用说明

使用Sentence-Transformers库

安装sentence-transformers可以轻松开始使用此模型：

pip install -U sentence-transformers

然后，通过以下Python代码来获取句子的嵌入：

from sentence_transformers import SentenceTransformer

# 输入文本需要提前进行分词
sentences = ["Cô ấy là một người vui_tính .", "Cô ấy cười nói suốt cả ngày ."]

model = SentenceTransformer('bkai-foundation-models/vietnamese-bi-encoder')
embeddings = model.encode(sentences)
print(embeddings)

使用HuggingFace提供的小部件

HuggingFace提供了一个小部件，在默认管道上增加了额外的词分割器，因此无需在使用API前自行分词。有关示例可参考Hosted inference API。

使用HuggingFace Transformers库

如果不使用sentence-transformers，可以按照以下步骤操作：

from transformers import AutoTokenizer, AutoModel
import torch

# 均值池化函数 - 考虑注意力掩码以获得正确的平均值
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0]
    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 = ['Cô ấy là một người vui_tính .', 'Cô ấy cười nói suốt cả ngày .']

# 从HuggingFace Hub加载模型
tokenizer = AutoTokenizer.from_pretrained('bkai-foundation-models/vietnamese-bi-encoder')
model = AutoModel.from_pretrained('bkai-foundation-models/vietnamese-bi-encoder')

# 令牌化句子
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# 计算令牌嵌入
with torch.no_grad():
    model_output = model(**encoded_input)

# 执行池化，这里使用均值池化
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])

print("Sentence embeddings:")
print(sentence_embeddings)

训练过程

该模型的训练设置如下：

DataLoader 使用了torch.utils.data.dataloader.DataLoader，长度为17584，参数如下：

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

Loss 使用了sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss，参数如下：

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

fit()方法参数

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

模型的完整架构

SentenceTransformer(
  (0): Transformer({'max_seq_length': 256, '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, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False})
)

引用

如果在您的工作中使用了此数据集，请引用以下文献：

  @article{duc2024towards,
    title={Towards Comprehensive Vietnamese Retrieval-Augmented Generation and Large Language Models},
    author={Nguyen Quang Duc, Le Hai Son, Nguyen Duc Nhan, Nguyen Dich Nhat Minh, Le Thanh Huong, Dinh Viet Sang},
    journal={arXiv preprint arXiv:2403.01616},
    year={2024}
  }