diff --git a/xtuner_config/README_llama3_8b_instruct_qlora_alpaca_e3_M.md b/xtuner_config/README_llama3_8b_instruct_qlora_alpaca_e3_M.md new file mode 100644 index 0000000..c7e8cf2 --- /dev/null +++ b/xtuner_config/README_llama3_8b_instruct_qlora_alpaca_e3_M.md @@ -0,0 +1,317 @@ +# Llama-3-8B-Instruct QLoRA 快速微调指南 + +本文将从以下几个方面来介绍**Llama3的下载和使用**，**在EmoLLM项目上进行基于Xtuner微调**。 + +- Huggingface上Llama3模型使用申请 +- 实验环境搭建 +- 下载LLama3模型和github安装 +- 下载和安装Xtuner +- 修改Xtuner模型配置文件 +- 在EmoLLM项目上进行基于Xtuner进行QLoRA微调 + +## 模型和有关GitHub项目下载 + +### Llama-3-8B-Instruct模型下载 + +我们这里采用的是Meta-Llama-3-8B-Instruct模型 + +该模型已经**针对指令和任务数据集**进行了 fine-tuning，使其更适合**需要遵循指令或完成任务的应用场景**。(The "Instruct" suffix indicates that this model has been fine-tuned on a dataset of instructions and tasks, making it more suitable for applications that require following instructions or completing tasks.) + +```python +from modelscope import snapshot_download + +model_dir = snapshot_download('LLM-Research/Meta-Llama-3-8B-Instruct') +print(model_dir) +``` + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539295924-090cc0a2-11e8-47cb-85e2-2bd3c8952606.png#averageHue=%23050910&clientId=uc3565ceb-1d40-4&from=paste&id=udf3bb6a7&originHeight=399&originWidth=431&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=uba96494a-41be-4549-8c03-7b494d925fb&title=) + +## 实验环境搭建 + +### 建议新建环境 + +```bash +conda create -n llama python=3.10 +``` + +### pytorch安装 + +```python +# CUDA 12.1 +conda install pytorch==2.1.0 torchvision==0.16.0 torchaudio==2.1.0 pytorch-cuda=12.1 -c pytorch -c nvidia +``` + +### git clone xtuner-0.1.18.dev0 + +```python +git clone https://github.com/InternLM/xtuner +``` + +查看更新的`/root/xtuner/xtuner/utils/templates.py`中`llama3_chat`的模板 + +```python +llama3_chat=dict( + SYSTEM=('<|start_header_id|>system<|end_header_id|>\n\n' + '{system}<|eot_id|>'), + INSTRUCTION=( + '<|start_header_id|>user<|end_header_id|>\n\n{input}<|eot_id|>' + '<|start_header_id|>assistant<|end_header_id|>\n\n'), + SUFFIX='<|eot_id|>', + SUFFIX_AS_EOS=True, + STOP_WORDS=['<|eot_id|>']), +``` + +- 微调模型是为对话应用训练的。 +- 为了获得它们的预期特性和性能，需要遵循 [ChatFormat](https://github.com/meta-llama/llama3/blob/main/llama/tokenizer.py#L202) 中定义的特定格式： + 1. 提示以特殊令牌 <|begin_of_text|> 开始，之后跟随一个或多个消息。 + 2. 每条消息以标签 <|start_header_id|> 开始，角色为 system、user 或 assistant，并以标签 <|end_header_id|> 结束。 + 3. 在双换行 \n\n 之后，消息的内容随之而来。每条消息的结尾由 <|eot_id|> 令牌标记。 +- Ref： [ArtificialZeng/llama3_explained](https://github.com/ArtificialZeng/llama3_explained) + +### 安装xtuner-0.1.18.dev0 + +```python +# 进入源码目录 +cd /root/xtuner/xtuner + +# 从源码安装 XTuner +pip install -e '.[all]' +``` + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539296026-ab8aa256-d55c-4b52-85fc-807bc7e38ed5.png#averageHue=%23384c57&clientId=uc3565ceb-1d40-4&from=paste&id=u1be0c9be&originHeight=318&originWidth=720&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=u6c2f10b3-fd9b-4eed-a123-e718d30f87f&title=) + +## 配置文件和参数调整 + +### 修改配置文件 + +我们这里可以参照[EmoLLM](https://link.zhihu.com/?target=https%3A//github.com/SmartFlowAI/EmoLLM)的[README_internlm2_7b_base_qlora.md](https://link.zhihu.com/?target=https%3A//github.com/SmartFlowAI/EmoLLM/blob/main/xtuner_config/README_internlm2_7b_base_qlora.md)来进行修改 +这里主要修改模型路径`pretrained_model_name_or_path` 和对话模板`prompt_template` ，将我们下载的Llama模型路径`Meta-Llama-3-8B-Instruct`和修改后的对话模板`llama3_chatM` 改到对应的位置即可 + +```python +# pretrained_model_name_or_path = '/root/share/model_repos/internlm2-chat-7b' +pretrained_model_name_or_path = '/root/models/LLM-Research/Meta-Llama-3-8B-Instruct' + + +# prompt_template = PROMPT_TEMPLATE.internlm2_chat # there is No internlm2_base +prompt_template = PROMPT_TEMPLATE.llama3_chatM # there is No internlm2_base + + +# alpaca_en_path = 'tatsu-lab/alpaca' +# alpaca_en = dict( +# type=process_hf_dataset, +# dataset=dict(type=load_dataset, path=alpaca_en_path),） + +data_path = '/root/StableCascade/emollm2/EmoLLM/datasets/processed/combined_data.json' +alpaca_en = dict( + type=process_hf_dataset, + dataset=dict(type=load_dataset, path='json', data_files=dict(train=data_path)),） + + # configure default hooks + default_hooks = dict( + # save checkpoint per `save_steps`. + checkpoint=dict( + type=CheckpointHook, + + # by_epoch=False, + # interval=save_steps, + interval=1, + + max_keep_ckpts=save_total_limit), + ) +``` + +### 根据硬件配置调整参数 + +除修改模型路径和对话模板之外，还需要根据自己的GPU硬件配置来调整一下有关参数 + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539296391-a1dd32ce-7dd9-4ccc-9d85-6d299dad2bf8.png#averageHue=%23080d14&clientId=uc3565ceb-1d40-4&from=paste&id=u97f1acad&originHeight=381&originWidth=652&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=u9fcd4a33-10af-47f5-8031-e30c1844c49&title=) + +这里还有个问题，就是需要**设置下环境变量**`PYTORCH_CUDA_ALLOC_CON`，来更好的利用所有的**GPU显存** + +```python +export 'PYTORCH_CUDA_ALLOC_CONF=max_split_size_mb:256' +``` + +采用以下的配置，可以使单张A100基本跑满 + +```python +max_length = 2048 +batch_size = 16 # per_device +accumulative_counts = 1 +max_epochs = 3 +lr = 1e-4 +evaluation_freq = 500 +``` + +还有一个需要和匹配的是model.lora中的r和lora_alpha参数，也需要根据自己的硬件环境来调整 + +```python +r=32, +lora_alpha=64, +``` + +### 添加中文回答prompt + +更重要的是，Llama3目前对中文的支持不太好，所以可能需要你在system prompt中加一些和你相关任务的调整, 如，接下来你将只使用中文来回答和咨询问题。 + +```python +SYSTEM = "你由EmoLLM团队打造的中文领域心理健康助手, 是一个研究过无数具有心理健康问题的病人与心理健康医生对话的心理专家, 在心理方面拥有广博的知识储备和丰富的研究咨询经验，接下来你将只使用中文来回答和咨询问题。" +``` + +修改好配置文件，就可以微调启动了！ + +## 数据格式 + +数据集介绍详见[EmoLLM](https://link.zhihu.com/?target=https%3A//github.com/SmartFlowAI/EmoLLM/)的[README_internlm2_7b_base_qlora.md](https://link.zhihu.com/?target=https%3A//github.com/SmartFlowAI/EmoLLM/blob/main/xtuner_config/README_internlm2_7b_base_qlora.md)和[datasets](https://link.zhihu.com/?target=https%3A//github.com/SmartFlowAI/EmoLLM/tree/main/datasets) + +训练用的数据来自[single_turn_dataset_2.json](datasets/single_turn_dataset_2.json)，被处理成多轮对话的形式，如 + +```python +[ + # 多轮对话 + { + "conversation": [ + { + "input": "我最近很迷茫，高三后的压力让我感到恐惧，我对自己的存在感到怀疑，您能不能给我一些建议呢？", + "output": "看到你面临的困境与压力，真心希望能够帮助你。首先，我想说的是，你并不是孤独的，高考前的困惑与迷茫是很常见的。不要给自己太大的压力，给自己短暂的放松。你认识到问题所在，这已经是一个很大的进步了。", + "system": "你是心理健康助手EmoLLM，由EmoLLM团队打造。你旨在通过专业心理咨询，协助来访者完成心理诊断。请充分利用专业心理学知识与咨询技术，一步步帮助来访者解决心理问题。" + }, + { + "input": "谢谢您的鼓励，但我觉得自己学习成绩不好，没有进步，这让我更加困惑。", + "output": "学习成绩好坏不是解决问题的关键，专注于自己的进步更为重要。为了达到自己的目标，制定一份合理的计划，按部就班的完成每一项任务。有时候自学不如求助他人，不要害怕问老师和同学问题，以便获得更好的帮助和理解。" + }, + { + "input": "我认为我缺乏自信，不知道怎样扭转自己的消极情绪，您能给我一些建议吗？", + "output": "建立自信需要时间和努力。让我们从一点一滴的进步中建立自信心。设立一些具体的目标，完成这些目标将会培养自己的自信。鼓励自己，在每天结束前，总结一下自己的成就，这将帮助你更好的看到自身的优点。" + }, + { + "input": "我感到很无助，不知道该如何调整自己的心态。", + "output": "了解自己的情绪并寻找有效的调节方法是处理感到无助情况的关键。比如爱好运动、听音乐和阅读书籍等，这些活动对于您的心理健康都是有积极帮助的。此外，在处理感到无助的情况下，家庭和朋友的支持也是非常关键的。" + }, + { + "input": "我感觉我的思维和学习方法都很糟糕，该怎样改进呢？", + "output": "学习方法确实很重要，它会对你的成绩和情绪有很大的影响。最有效的学习方法是利用时间来做练习，多做一些题目，练习自己的掌握能力。建立起对知识的兴趣，这需要不断的积累，不要害怕失败或挫折，它们会成为助你成长的宝贵财富。" + }, + { + "input": "我会按照您的建议努力，但想问一下，我该如何面对可能的失败？", + "output": "每个人都会面对失败和挫折，不要让它们打败你。碰到失败时，重新审视自己，分析分析自己的不足，寻找方法去改进。记得勇敢地看向未来，不要让过去的失败阻碍了自己前进的脚步。" + }, + { + "input": "非常感谢您的建议和支持，我会努力去实践。", + "output": "这是我应该做的，你有勇气面对自己困难，你并不孤独，我们会一起为你打气，祝愿你早日获得心灵的平静和所有的成功。" + } + ] + }, + ...... +] +``` + +## 微调 + +### 微调指令 + +```python +cd xtuner_config +xtuner train llama3_8b_instruct_qlora_alpaca_e3_M.py --deepspeed deepspeed_zero2 +``` + +### 训练开始的截图 + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539296499-3c5956ce-38dc-4214-bac6-00b39dad91fc.png#averageHue=%230a1119&clientId=uc3565ceb-1d40-4&from=paste&id=u1d0c1573&originHeight=434&originWidth=720&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=ue48b6c84-72b4-41b0-9dc3-6a7477fd77a&title=) + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539297205-30e6314e-c08b-4afa-82d3-31b8ef800d85.png#averageHue=%23192027&clientId=uc3565ceb-1d40-4&from=paste&id=u8949a500&originHeight=405&originWidth=720&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=u74e39023-ef4f-47ee-83dc-6f15af2fbe0&title=) + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539297193-414ed828-b65e-43fd-9fb4-ace4cbe1f35c.png#averageHue=%23090e14&clientId=uc3565ceb-1d40-4&from=paste&id=u488b21e9&originHeight=357&originWidth=720&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=u822349ed-7efe-40c9-b5a2-26b51b287c1&title=) + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539297228-d8f00d2c-868e-4bfc-a01f-b941437e1976.png#averageHue=%2311171e&clientId=uc3565ceb-1d40-4&from=paste&id=u7b174934&originHeight=304&originWidth=720&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=u9b08bb9d-08b9-437a-9492-4bed88fd11c&title=) + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539297173-37e20031-6621-4f7d-877c-8a0a6de3e824.png#averageHue=%230a1119&clientId=uc3565ceb-1d40-4&from=paste&id=u83b53f99&originHeight=347&originWidth=720&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=uc60c9dbd-5ff3-473e-8e0f-b6b7f96c291&title=) + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539297483-535d17f4-8f56-409e-8bd9-b378cde27571.png#averageHue=%230c121b&clientId=uc3565ceb-1d40-4&from=paste&id=u8dad52e2&originHeight=167&originWidth=1235&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=ub8de5823-f3ef-4828-8e42-4ed425f15ae&title=) + +### 500step打印 + +![](https://cdn.nlark.com/yuque/0/2024/png/43035260/1713539298145-001f7e4d-ff2a-480a-8343-479dec79ae0a.png#averageHue=%230d131a&clientId=uc3565ceb-1d40-4&from=paste&id=ud6b548b1&originHeight=426&originWidth=720&originalType=url&ratio=1&rotation=0&showTitle=false&status=done&style=none&taskId=u2d75814e-53d3-4abb-b01a-7479a26ebb1&title=)
添加图片注释，不超过 140 字（可选） + +### 训练完一个epoch之后 + +## 将得到的 PTH 模型转换为 HuggingFace 模型 + +即：生成 HuggingFace Adapter 文件夹, 用于和原模型权重合并 + +```python +cd xtuner_config +mkdir hf +export MKL_SERVICE_FORCE_INTEL=1 +xtuner convert pth_to_hf llama3_8b_instruct_qlora_alpaca_e3_M.py ./work_dirs/llama3_8b_instruct_qlora_alpaca_e3_M/epoch_1.pth ./hf_llama3 +``` + +## 将 HuggingFace Adapter QLoRA权重合并到大语言模型 + +```python +xtuner convert merge /root/models/LLM-Research/Meta-Llama-3-8B-Instruct ./hf_llama3 ./merged_Llama3_8b_instruct --max-shard-size 2GB +# xtuner convert merge \ +# ${NAME_OR_PATH_TO_LLM} \ +# ${NAME_OR_PATH_TO_ADAPTER} \ +# ${SAVE_PATH} \ +# --max-shard-size 2GB +``` + +## 测试 + +在EmoLLM的demo文件夹下，创建cli_Llama3.py，注意，这里我们采用本地离线测试（offline model），在线测试可以上传模型到有关平台后，再下载测试 + +```python +import torch +from transformers import AutoTokenizer, AutoModelForCausalLM +from openxlab.model import download +from modelscope import snapshot_download +import os + +# download model in openxlab +download(model_repo='ajupyter/EmoLLM_internlm2_7b_full', + output='ajupyter/EmoLLM_internlm2_7b_full') +model_name_or_path = 'ajupyter/EmoLLM_internlm2_7b_full' + +# # download model in modelscope +# model_name_or_path = snapshot_download('ajupyter/EmoLLM_internlm2_7b_full', +# cache_dir='EmoLLM_internlm2_7b_full') + +# offline model +model_name_or_path = "/root/EmoLLM/xtuner_config/merged_Llama" + +tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, trust_remote_code=True) +model = AutoModelForCausalLM.from_pretrained(model_name_or_path, trust_remote_code=True, torch_dtype=torch.bfloat16, device_map='auto') +model = model.eval() + +system_prompt = '你由EmoLLM团队打造的中文领域心理健康助手, 是一个研究过无数具有心理健康问题的病人与心理健康医生对话的心理专家, 在心理方面拥有广博的知识储备和丰富的研究咨询经验，接下来你将只使用中文来回答和咨询问题。' + +messages = [(system_prompt, '')] + +print("=============Welcome to InternLM chatbot, type 'exit' to exit.=============") + +while True: + input_text = input("User >>> ") + input_text.replace(' ', '') + if input_text == "exit": + break + response, history = model.chat(tokenizer, input_text, history=messages) + messages.append((input_text, response)) + print(f"robot >>> {response}") +``` + +执行 + +```python +cd demo +python cli_Llama3.py +``` + +## 其他 + +欢迎大家给[Xtuner](https://link.zhihu.com/?target=https%3A//github.com/InternLM/xtuner)和[EmoLLM](https://link.zhihu.com/?target=https%3A//github.com/aJupyter/EmoLLM)点点star~ + +### **知乎原文** + +1. [Llama3][EmoLLM][Minisora]Meta Llama 3快速上手：用EmoLLM数据基于Xtuner采用QLoRA微调Meta-Llama-3-8B-Instruct模型【V0】 - 知乎 https://zhuanlan.zhihu.com/p/693321573 +2. [Llama3][EmoLLM][Minisora]Meta Llama 3快速上手：用EmoLLM数据基于Xtuner采用QLoRA微调Meta-Llama-3-8B-Instruct模型【V1】 - 知乎 https://zhuanlan.zhihu.com/p/693454096 diff --git a/xtuner_config/llama3_8b_instruct_qlora_alpaca_e3_M.py b/xtuner_config/llama3_8b_instruct_qlora_alpaca_e3_M.py index 72c88b6..6c15667 100644 --- a/xtuner_config/llama3_8b_instruct_qlora_alpaca_e3_M.py +++ b/xtuner_config/llama3_8b_instruct_qlora_alpaca_e3_M.py @@ -28,7 +28,7 @@ pretrained_model_name_or_path = '/root/models/LLM-Research/Meta-Llama-3-8B-Instr use_varlen_attn = False # new # Data -data_path = '/root/StableCascade/emollm2/EmoLLM/datasets/processed/combined_data.json' +data_path = '../datasets/multi_turn_dataset_2.json' prompt_template = PROMPT_TEMPLATE.llama3_chat max_length = 2048 pack_to_max_length = True