欢迎来到MindSpore Transformers（MindFormers）

一、介绍

MindSpore Transformers套件的目标是构建一个大模型预训练、微调、评测、推理、部署的全流程开发套件，提供业内主流的Transformer类大语言模型（Large Language Models, LLMs）和多模态理解模型（Multimodal Models, MMs）。期望帮助用户轻松地实现大模型全流程开发。

MindSpore Transformers套件基于MindSpore内置的多维混合并行技术和组件化设计，具备如下特点：

• 一键启动模型单卡或多卡预训练、微调、评测、推理、部署流程；
• 提供丰富的多维混合并行能力可供灵活易用地进行个性化配置；
• 大模型训推系统级深度优化，原生支持超大规模集群高效训推，故障快速恢复；
• 支持任务组件配置化开发。任意模块可通过统一配置进行使能，包括模型网络、优化器、学习率策略等；
• 提供训练精度/性能监控指标实时可视化能力等。

欲获取MindSpore Transformers相关使用教程以及API文档，请参阅MindSpore Transformers文档，以下提供部分内容的快速跳转链接：

• 📝 大模型预训练
• 📝 大模型微调
• 📝 大模型评测
• 📝 服务化部署

如果您对MindSpore Transformers有任何建议，请通过issue与我们联系，我们将及时处理。

模型列表

当前MindSpore Transformers全量的模型列表如下：

模型维护策略跟随最新支持版本的生命周期及版本配套策略。

二、安装

版本匹配关系

当前支持的硬件为Atlas 800T A2训练服务器。

当前套件建议使用的Python版本为3.11.4。

历史版本配套关系：

源码编译安装

MindSpore Transformers目前支持源码编译安装，用户可以执行如下命令进行安装。

git clone -b dev https://gitee.com/mindspore/mindformers.git
cd mindformers
bash build.sh

三、使用指南

MindSpore Transformers支持一键启动大模型的分布式预训练、SFT 微调、推理任务，可点击模型列表中各模型的链接查看对应使用文档。

关于MindSpore Transformers的更多功能说明可参阅MindSpore Transformers文档。

四、生命周期及版本配套策略

MindSpore Transformers版本有以下五个维护阶段：

MindSpore Transformers已发布版本维护策略：

五、免责声明

1. scripts/examples目录下的内容是作为参考示例提供的，并不构成商业发布产品的一部分，仅供用户参考。如需使用，需要用户自行负责将其转化为适合商业用途的产品，并确保进行安全防护，对于由此产生的安全问题，MindSpore不承担安全责任。
2. 关于数据集， MindSpore Transformers 仅提示性地建议可用于训练的数据集， MindSpore Transformers 不提供任何数据集。如用户使用这些数据集进行训练，请特别注意应遵守对应数据集的License，如因使用数据集而产生侵权纠纷， MindSpore Transformers 不承担任何责任。
3. 如果您不希望您的数据集在 MindSpore Transformers 中被提及，或希望更新 MindSpore Transformers 中关于您的数据集的描述，请在Gitee提交issue，我们将根据您的issue要求删除或更新您的数据集描述。衷心感谢您对 MindSpore Transformers 的理解和贡献。

六、贡献

欢迎参与社区贡献，可参考MindSpore Transformers贡献指南。

七、许可证

Apache 2.0许可证