uniem

项目介绍：uniem

uniem 项目旨在开发中文最优秀的通用文本嵌入模型，以此为目标，项目不仅提供了用于模型训练、微调和评估的完整代码，还将模型与数据集发布在 HuggingFace 社区中供大家使用。

🌟 重要更新

版本更新

2023年7月11日，发布了 uniem 0.3.0。此次更新使 FineTuner 除了支持 M3E 之外，还能微调 sentence_transformers 和 text2vec 等模型，同时也加入了通过 SGPT 方式对 GPT 系列模型进行训练的支持，包括 Prefix Tuning。需要注意的是，FineTuner 的初始化 API 存在不兼容 0.2.0 版本的小改动。
2023年6月17日，发布了 uniem 0.2.1，实现了 FineTuner 的原生微调支持，让开发人员仅需几行代码即可完成适配。
同日，发布了 MTEB-zh 正式版，支持六大类 Embedding 模型，四大类任务的自动化评测，涵盖九种数据集。
2023年6月8日，推出了 M3E 模型，其在中文文本分类和检索任务中表现超越了 openai text-embedding-ada-002。

🔧 使用 M3E

M3E 系列模型与 sentence-transformers 完全兼容。用户可以通过简单的替换模型名称的方式，在任意支持 sentence-transformers 的项目中使用 M3E。以下为 M3E 的安装和使用示例：

安装

pip install sentence-transformers

使用

from sentence_transformers import SentenceTransformer

model = SentenceTransformer("moka-ai/m3e-base")
embeddings = model.encode(['Hello World!', '你好,世界!'])

🎨 微调模型

uniem 提供便捷的微调接口，让用户可以快速适配所需的模型和数据集：

from datasets import load_dataset
from uniem.finetuner import FineTuner

dataset = load_dataset('shibing624/nli_zh', 'STS-B')
finetuner = FineTuner.from_pretrained('moka-ai/m3e-small', dataset=dataset)
finetuner.run(epochs=3)

详细的微调教程可参考项目提供的教程文档。

💯 MTEB-zh

为了弥补中文 Embedding 模型缺乏统一评测标准的缺憾，项目参考 MTEB 构建了 MTEB-zh，目前已对多种模型进行评测。

文本分类

官方评测使用了在 HuggingFace 上开源的六种文本分类数据集，包括新闻、电商评论、股票评论等，使用 MTEB 的方法进行评测并报告准确率（Accuracy）。

检索排序

检索排序使用了 T2Ranking 数据集，该数据集为评测提供了前10000篇文章，评测指标为 map@1, map@10, mrr@1, mrr@10, ndcg@1, ndcg@10。

🤝 参与贡献

欢迎开发者通过 issues 或 PR 向 MTEB-zh 添加评测数据集或模型，项目团队期待您的积极贡献和参与。

📜 许可

uniem 项目采用 Apache-2.0 许可证，详情请查阅 LICENSE 文件。

🏷 引用

若需引用此模型，请使用如下格式：

@software {Moka Massive Mixed Embedding,
author = {Wang Yuxin,Sun Qingxuan,He sicheng},
title = {M3E: Moka Massive Mixed Embedding Model},
year = {2023} }