E5 Base Korean

🚀 upskyy/e5-base-korean

該模型是基於 intfloat/multilingual-e5-base 進行 korsts 和 kornli 微調的模型。它能將句子和段落映射到 768 維的密集向量空間，可用於語義文本相似度計算、語義搜索、釋義挖掘、文本分類、聚類等任務。

🚀 快速開始

安裝 Sentence Transformers 庫

pip install -U sentence-transformers

加載模型並進行推理

from sentence_transformers import SentenceTransformer

# 從 🤗 Hub 下載
model = SentenceTransformer("upskyy/e5-base-korean")

# 進行推理
sentences = [
    '아이를 가진 엄마가 해변을 걷는다.',
    '두 사람이 해변을 걷는다.',
    '한 남자가 해변에서 개를 산책시킨다.',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# 獲取嵌入向量的相似度分數
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [3, 3]

不使用 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 = ["안녕하세요?", "한국어 문장 임베딩을 위한 버트 모델입니다."]

# 從 HuggingFace Hub 加載模型
tokenizer = AutoTokenizer.from_pretrained("upskyy/e5-base-korean")
model = AutoModel.from_pretrained("upskyy/e5-base-korean")

# 對句子進行分詞
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)

✨ 主要特性

• 多語言支持：支持多種語言，包括韓語等。
• 語義相似度計算：可有效計算句子之間的語義相似度。
• 高維向量映射：將句子和段落映射到 768 維的密集向量空間。

📦 安裝指南

安裝 Sentence Transformers 庫：

pip install -U sentence-transformers

💻 使用示例

基礎用法

from sentence_transformers import SentenceTransformer

# 從 🤗 Hub 下載
model = SentenceTransformer("upskyy/e5-base-korean")

# 進行推理
sentences = [
    '아이를 가진 엄마가 해변을 걷는다.',
    '두 사람이 해변을 걷는다.',
    '한 남자가 해변에서 개를 산책시킨다.',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# 獲取嵌入向量的相似度分數
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [3, 3]

高級用法

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 = ["안녕하세요?", "한국어 문장 임베딩을 위한 버트 모델입니다."]

# 從 HuggingFace Hub 加載模型
tokenizer = AutoTokenizer.from_pretrained("upskyy/e5-base-korean")
model = AutoModel.from_pretrained("upskyy/e5-base-korean")

# 對句子進行分詞
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)

📚 詳細文檔

模型詳情

模型描述

完整模型架構

SentenceTransformer(
  (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: XLMRobertaModel 
  (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, 'include_prompt': True})
)

評估指標

語義相似度

• 數據集：sts-dev
• 使用 EmbeddingSimilarityEvaluator 進行評估

框架版本

• Python: 3.10.13
• Sentence Transformers: 3.0.1
• Transformers: 4.42.4
• PyTorch: 2.3.0+cu121
• Accelerate: 0.30.1
• Datasets: 2.16.1
• Tokenizers: 0.19.1

📄 許可證

本模型採用 MIT 許可證。

📚 引用

BibTeX

@article{wang2024multilingual,
  title={Multilingual E5 Text Embeddings: A Technical Report},
  author={Wang, Liang and Yang, Nan and Huang, Xiaolong and Yang, Linjun and Majumder, Rangan and Wei, Furu},
  journal={arXiv preprint arXiv:2402.05672},
  year={2024}
}

@inproceedings{reimers-2019-sentence-bert,
    title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
    author = "Reimers, Nils and Gurevych, Iryna",
    booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
    month = "11",
    year = "2019",
    publisher = "Association for Computational Linguistics",
    url = "https://arxiv.org/abs/1908.10084",
}