Koe5

🚀 🔎 KoE5

KoE5是一款具备先进检索能力的模型，在韩语文本检索任务中表现卓越，为韩语信息检索提供了高效的解决方案。

如需了解更多详情，请访问 KURE 仓库。

✨ 主要特性

• 强大的检索能力：在韩语文本检索方面表现出色。
• 多语言支持：支持韩语和英语。

📦 安装指南

安装依赖

首先，您需要安装 sentence-transformers 库：

pip install -U sentence-transformers

💻 使用示例

基础用法

安装好依赖后，您可以加载模型并进行推理：

from sentence_transformers import SentenceTransformer

# 从 🤗 Hub 下载模型
model = SentenceTransformer("nlpai-lab/KoE5")

# 进行推理
sentences = [
    'query: 헌법과 법원조직법은 어떤 방식을 통해 기본권 보장 등의 다양한 법적 모색을 가능하게 했어',
    'passage: 4. 시사점과 개선방향 앞서 살펴본 바와 같이 우리 헌법과 ｢법원조직 법｣은 대법원 구성을 다양화하여 기본권 보장과 민주주의 확립에 있어 다각적인 법적 모색을 가능하게 하는 것을 근본 규범으로 하고 있다. 더욱이 합의체로서의 대법원 원리를 채택하고 있는 것 역시 그 구성의 다양성을 요청하는 것으로 해석된다. 이와 같은 관점에서 볼 때 현직 법원장급 고위법관을 중심으로 대법원을 구성하는 관행은 개선할 필요가 있는 것으로 보인다.',
    'passage: □ 연방헌법재판소는 2001년 1월 24일 5:3의 다수견해로 「법원조직법」 제169조 제2문이 헌법에 합치된다는 판결을 내렸음 ○ 5인의 다수 재판관은 소송관계인의 인격권 보호, 공정한 절차의 보장과 방해받지 않는 법과 진실 발견 등을 근거로 하여 텔레비전 촬영에 대한 절대적인 금지를 헌법에 합치하는 것으로 보았음 ○ 그러나 나머지 3인의 재판관은 행정법원의 소송절차는 특별한 인격권 보호의 이익도 없으며, 텔레비전 공개주의로 인해 법과 진실 발견의 과정이 언제나 위태롭게 되는 것은 아니라면서 반대의견을 제시함 ○ 왜냐하면 행정법원의 소송절차에서는 소송당사자가 개인적으로 직접 심리에 참석하기보다는 변호사가 참석하는 경우가 많으며, 심리대상도 사실문제가 아닌 법률문제가 대부분이기 때문이라는 것임 □ 한편, 연방헌법재판소는 「연방헌법재판소법」(Bundesverfassungsgerichtsgesetz: BVerfGG) 제17a조에 따라 제한적이나마 재판에 대한 방송을 허용하고 있음 ○ 「연방헌법재판소법」 제17조에서 「법원조직법」 제14절 내지 제16절의 규정을 준용하도록 하고 있지만, 녹음이나 촬영을 통한 재판공개와 관련하여서는 「법원조직법」과 다른 내용을 규정하고 있음',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 1024]

# 获取嵌入向量的相似度分数
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.6721, 0.3897],
#        [0.6721, 1.0000, 0.3740],
#        [0.3897, 0.3740, 1.0000]])

📚 详细文档

模型版本

模型描述

这是一个已发布到 🤗 Hub 的 transformers 模型的卡片信息：

• 开发者：NLP&AI Lab
• 支持语言 (NLP)：韩语、英语
• 许可证：MIT
• 微调基础模型：intfloat/multilingual-e5-large
• 微调数据集：ko-triplet-v1.0

训练详情

训练数据

• ko-triplet-v1.0
• 韩语查询 - 文档 - 难负样本数据对（开放数据）
• 总共使用约 700000+ 个示例

训练过程

• 损失函数：使用 sentence-transformers 库中的 CachedMultipleNegativesRankingLoss
• 批次大小：512
• 学习率：1e-05
• 训练轮数：1

评估

评估指标

• 召回率（Recall）、精确率（Precision）、归一化折损累积增益（NDCG）、F1 分数

基准数据集

• Ko-StrategyQA：韩语开放域问答多跳检索数据集（StrategyQA 翻译版）
• AutoRAGRetrieval：针对金融、公共、医疗、法律、商业 5 个领域，通过解析 pdf 构建的韩语文档检索数据集
• MIRACLRetrieval：基于 Wikipedia 的韩语文档检索数据集
• PublicHealthQA：医疗及公共卫生领域的韩语文档检索数据集
• BelebeleRetrieval：基于 FLORES-200 的韩语文档检索数据集
• MrTidyRetrieval：基于 Wikipedia 的韩语文档检索数据集
• MultiLongDocRetrieval：多领域的韩语长文检索数据集
• XPQARetrieval：多领域的韩语文档检索数据集

评估结果

以下是所有模型在所有基准数据集上的平均评估结果。详细结果可在 KURE Github 查看。

Top-k 1

Top-k 3

Top-k 5

Top-k 10

🔧 技术细节

输入文本前缀

在输入文本时，需要添加 "query: " 和 "passage: " 前缀，这是模型的训练方式，否则模型性能会下降。以下是一些使用建议：

• 非对称任务：如开放问答中的段落检索、临时信息检索等，分别使用 "query: " 和 "passage: " 前缀。
• 对称任务：如语义相似度、双语挖掘、释义检索等，使用 "query: " 前缀。
• 特征使用：如线性探测分类、聚类等，使用 "query: " 前缀。

文本长度限制

长文本将被截断为最多 512 个标记。

📄 许可证

本项目采用 MIT 许可证。

引用

如果您觉得我们的论文或模型有帮助，请考虑按以下方式引用：

@misc{KURE,
  publisher = {Youngjoon Jang, Junyoung Son, Taemin Lee},
  year = {2024},
  url = {https://github.com/nlpai-lab/KURE}
},

@misc{KoE5,
  author = {NLP & AI Lab and Human-Inspired AI research},
  title = {KoE5: A New Dataset and Model for Improving Korean Embedding Performance},
  year = {2024},
  publisher = {Youngjoon Jang, Junyoung Son, Taemin Lee},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/nlpai-lab/KoE5}},
}