Tips: 图片完全由AI生成
不同于其他优秀的开源训练框架的高度封装与集成，LLM-Dojo使用简洁且易阅读的代码构建模型训练、RLHF框架等各种功能，使项目易于学习，每个人都能以此项目为基础自己构建与理解，且与大多开源框架相同均是基于huggingface，性能并不会有太多出入。 主要内容如下：
- 开源大模型训练框架: 简洁清晰的开源大模型训练框架，支持Deepspeed多卡、Lora(Dora)、QLora、全参等训练，细节代码主要集中在
utils文件夹下，训练代码在main_train.py。 - RLHF框架: RLHF训练框架，支持并持续更新Reward训练、PPO、DPO、RLOO、SimPO等各种强化学习方法，适配Deepspeed多卡及Lora，一张A100即可运行，详情可见: RLHF。
- 最新LLM tricks详解: 持续更新大模型领域最新tricks介绍，包括新论文方法的复现等，希望可以给你一些创新的想法，该模块主要集中在
llm_tricks文件夹下。 - 主流模型chat template汇总: 整合当前主流模型的chat template，以方便自己训练代码时数据处理及微调等操作，详情可见: Chat Template。
- [2024-09-20] 增加evaluate模块，一个简洁的模型评测框架，目前仅支持Humaneval。可见Evaluate
- [2024-08-27] 🤓增加从零实现自己编写DPO、SimPO代码，包括数据、loss、训练等部分。可见DPO example
- [2024-08-08] 支持直接修改配置文件启动及命令行启动，增加框架适配数据处理代码。
- [2024-08-04] 支持自适应单轮或多轮对话，无需指定单轮或多轮，训练根据数据自行判断单轮或多轮。且可自主设置system命令。可见训练数据格式说明
- [2024-07-19] RLHF 强化学习框架新增CPO,SimPO，以及二者融合CPO-SimPO
- [2024-07-16] RLHF 强化学习框架更新完成，支持deepspeed单卡/多卡 进行强化学习lora、qlora等训练，详细可见RLHF
- [2024-06-9] 🚀支持DPO训练，分为单轮对话DPO(自己构建，方便魔改)和多轮对话DPO(简洁实现)，支持deepspeed的lora和qlora，具体介绍可见 DPO使用说明
- [2024-06-5] 🤓llm_tricks 增加从头开始实现MOE
More news...
- [2024-06-10] 🚀增加一步一步实现Transformer技术发文(包括代码等从零介绍)，可见 技术发文
- [2024-05-18] 🤓支持Deepspeed单机多卡、单机单卡的Lora、Qlora、全量微调等训练！
- [2024-05-13] 🚀 更新各大模型的Chat Template
- [2024-05-06] 🚀 支持Qwen、Yi模型的Lora、Qlora、Dora微调
- [2024-04-28] 🚀 更新dora微调原理示例、支持qwen模型微调
RLHF训练框架，支持并持续更新Reward训练、PPO、DPO、RLOO、SimPO等各种强化学习方法，适配Deepspeed多卡及Lora，一张A100即可运行。 详情可见: RLHF。
理论上支持对所有模型的微调,下述仅为测试过。
支持基于Deepspeed的多卡/单卡 Lora、Qlora、Dora微调:
- Qwen(Qwen1.5/Qwen2)
- Yi
- Gemma系列
- Phi-3
- Deepseek
- MiniCPM
- Llama系列
- deepseek-coder
- 哔哩哔哩 Index-1.9B
- baichuan系列
- GLM系列
- 待更新Mistral系列
所有相关的trciks及讲解都在llm_tricks文件夹下
More news...
本框架采用的SFT数据格式无论单轮对话或多轮对话均为jsonl形式。无需指定单轮或多轮，训练根据数据自行判断单轮或多轮。
单轮对话即message字段中只有一对user和assistant，多轮对话则有多对。
示例如下，示例文件可参见data/sft_data.jsonl:
{"message": [{"role": "system", "content": "You are a friendly chatbot who always responds in the style of a pirate"},{"role": "user", "content": "How many helicopters can a human eat in one sitting"},{"role": "assistant", "content": "Sure! Here are some ways to eat bananas and dragonfruits together"},{"role": "user", "content": "你好"},{"role": "assistant", "content": "hellow"}]}可根据需求自行决定是否增加system字段，例如不需要或修改system则只需将上述示例数据中的
{"role": "system", "content": "You are a friendly chatbot who always responds in the style of a pirate"}
删除或修改conten即可。建议训练数据没有特殊需求不必增加system字段
对于DPO数据，可见data/dpo_multi_data.jsonl示例数据
鉴于框架指定格式数据可能会跟常规数据有些不同，故可以通过generate_data.py文件进行处理，输入应为正常的instruction和output的jsonl格式文件，
如下：
{"instruction":"将这个句子改写成将来时态：“太阳将会照耀明亮。”","output":"太阳将会散发温暖的光芒。"}运行后即可得到无system的user、assistant指定格式。
包括SFT和DPO。
目前支持直接python命令单卡训练、deepspeed单机多卡及单机单卡训练。
所有方式均支持Qlora、Lora、Dora方法。
1、支持命令行传参启动，启动示例可见run_example.sh
2、也支持参数文件直接修改默认值，具体如下：
不同的微调方法有不同的配置，但大体都是类似的，基本默认设置即可，你只需要改一下模型路径、输出路径等等。
常规的参数在utils下的args.py。
其中:
train_args_path：为Step2中需要配置的参数，可选sft_args和dpo_args，分别都在train_args文件夹下
相关训练参数在train_args文件夹下对应的文件中，分为SFT和DPO。 均是采用dataclass格式配置参数，直接在default中修改即可。
😶Python命令单卡启动：
设置好相关配置后即可运行main_train.py进行训练
python main_train.py🙃Deepspeed单卡或多卡启动：
使用Deepspeed训练时前两步与常规相同，但需要额外配置ds_config文件，项目中已给出常用的配置示例，位于train_args/deepspeed_config/路径下，
更详细的Deepspeed原理及解释可以看文章：Deepspeed配置及使用讲解
运行以下命令启动：
deepspeed --include localhost:6,7 main_train.py其中include localhost参数用于选择训练的GPU，可选单卡也可选多卡。
显存占用测试如下：
| 策略 | 模型大小 | 显存占用 |
|---|---|---|
| Lora | Qwen（7B） | 26g |
| Lora+Zero2 | Qwen（7B） | 26g |
| Lora+zero3 | Qwen（7B） | 16g |
目前区分single_dpo和multi_dpo模式，前者是自己实现dataset并映射，以供大家魔改使用。 后者采用官方示例，故建议使用后者。具体使用说明可见：DPO使用说明
项目学习了优秀开源项目，感谢huggingface、流萤等及一些国内外小伙伴的开源项目。
LLM Dojo 期待你的加入。🪂 无论是提出问题（Issue）还是贡献代码（Pull Request），都是对项目的巨大支持。