Chinese-LLaMA-Alpaca-3 项目启动！

🇨🇳中文 | 🌐English | 📖文档/Docs | ❓提问/Issues | 💬讨论/Discussions | ⚔️竞技场/Arena

本项目开源了中文 LLaMA 模型和指令精调的 Alpaca 大模型，以进一步促进大模型在中文 NLP 社区的开放研究。这些模型在原版 LLaMA 的基础上扩充了中文词表并使用了中文数据进行二次预训练，进一步提升了中文基础语义理解能力。同时，中文 Alpaca 模型进一步使用了中文指令数据进行精调，显著提升了模型对指令的理解和执行能力。

技术报告（V2）：[Cui, Yang, and Yao] Efficient and Effective Text Encoding for Chinese LLaMA and Alpaca

本项目主要内容：

• 🚀 针对原版 LLaMA 模型扩充了中文词表，提升了中文编解码效率
• 🚀 开源了使用中文文本数据预训练的中文 LLaMA 以及经过指令精调的中文 Alpaca
• 🚀 开源了预训练脚本、指令精调脚本，用户可根据需要进一步训练模型
• 🚀 快速使用笔记本电脑（个人 PC）的 CPU/GPU 本地量化和部署体验大模型
• 🚀 支持 🤗transformers, llama.cpp, text-generation-webui, LlamaChat, LangChain, privateGPT 等生态
• 目前已开源的模型版本：7B（基础版、Plus 版、Pro 版）、13B（基础版、Plus 版、Pro 版）、33B（基础版、Plus 版、Pro 版）

💡 下图是中文 Alpaca-Plus-7B 模型在本地 CPU 量化部署后的实际体验速度和效果。

---

中文 LLaMA-2&Alpaca-2 大模型 | 多模态中文 LLaMA&Alpaca 大模型 | 多模态 VLE | 中文 MiniRBT | 中文 LERT | 中英文 PERT | 中文 MacBERT | 中文 ELECTRA | 中文 XLNet | 中文 BERT | 知识蒸馏工具 TextBrewer | 模型裁剪工具 TextPruner

新闻

[2024/04/30] Chinese-LLaMA-Alpaca-3 已正式发布，开源基于 Llama-3 的 Llama-3-Chinese-8B 和 Llama-3-Chinese-8B-Instruct，推荐所有一期、二期项目用户升级至三代模型，请参阅：https://github.com/ymcui/Chinese-LLaMA-Alpaca-3

[2024/03/27] 本项目已入驻机器之心 SOTA! 模型平台，欢迎关注：https://sota.jiqizhixin.com/project/chinese-llama-alpaca

[2023/08/14] Chinese-LLaMA-Alpaca-2 v2.0 版本已正式发布，开源 Chinese-LLaMA-2-13B 和 Chinese-Alpaca-2-13B，推荐所有一期用户升级至二代模型，请参阅：https://github.com/ymcui/Chinese-LLaMA-Alpaca-2

[2023/07/31] Chinese-LLaMA-Alpaca-2 v1.0 版本已正式发布，请参阅：https://github.com/ymcui/Chinese-LLaMA-Alpaca-2

[2023/07/19] v5.0 版本: 发布 Alpaca-Pro 系列模型，显著提升回复长度和质量；同时发布 Plus-33B 系列模型。

[2023/07/19] 🚀启动 中文 LLaMA-2、Alpaca-2 开源大模型项目，欢迎关注了解最新信息。

[2023/07/10] Beta 测试预览，提前了解即将到来的更新：详见 讨论区

[2023/07/07] Chinese-LLaMA-Alpaca 家族再添新成员，推出面向视觉问答与对话的 多模态中文 LLaMA&Alpaca 大模型，发布了 7B 测试版本。

[2023/06/30] llama.cpp 下 8K context 支持（无需对模型做出修改），相关方法和讨论见 讨论区；transformers 下支持 4K+ context 的代码请参考 PR#705

[2023/06/16] v4.1 版本: 发布新版技术报告、添加 C-Eval 解码脚本、添加低资源模型合并脚本等。

[2023/06/08] v4.0 版本: 发布中文 LLaMA/Alpaca-33B、添加 privateGPT 使用示例、添加 C-Eval 结果等。

内容导引

章节	描述
⏬模型下载	中文 LLaMA、Alpaca 大模型下载地址
🈴合并模型	（重要）介绍如何将下载的 LoRA 模型与原版 LLaMA 合并
💻本地推理与快速部署	介绍了如何对模型进行量化并使用个人电脑部署并体验大模型
💯系统效果	介绍了部分场景和任务下的使用体验效果
📝训练细节	介绍了中文 LLaMA、Alpaca 大模型的训练细节
❓FAQ	一些常见问题的回复
⚠️局限性	本项目涉及模型的局限性

模型下载

用户须知（必读）

Facebook 官方发布的 LLaMA 模型禁止商用，并且官方没有正式开源模型权重（虽然网上已经有很多第三方的下载地址）。为了遵循相应的许可，这里发布的是 LoRA 权重，可以理解为原 LLaMA 模型上的一个“补丁”，两者合并即可获得完整版权重。以下中文 LLaMA/Alpaca LoRA 模型无法单独使用，需要搭配 原版 LLaMA 模型。请参考本项目给出的 合并模型 步骤重构模型。

模型列表

下图展示了本项目以及 二期项目 推出的所有大模型之间的关系。

模型选择指引

下面是中文 LLaMA 和 Alpaca 模型的基本对比以及建议使用场景（包括但不限于），更多内容见 训练细节。

对比项	中文 LLaMA	中文 Alpaca
训练方式	传统 CLM（自回归语言模型）	指令精调
模型类型	基座模型	指令理解模型（类 ChatGPT）
训练语料	无标注通用语料	有标注指令数据
词表大小[3]	49953	49954=49953+1（pad token，填充 token）
输入模板	不需要	需要符合模板要求[1]
适用场景 ✔️	文本续写：给定上文内容，让模型生成下文	指令理解（问答、写作、建议等）；多轮上下文理解（聊天等）
不适用场景 ❌	指令理解 、多轮聊天等	文本无限制自由生成
llama.cpp	使用-p参数指定上文	使用-ins参数启动指令理解 + 聊天模式
text-generation-webui	不适合 chat 模式	使用--cpu可在无显卡形式下运行
LlamaChat	加载模型时选择"LLaMA"	加载模型时选择"Alpaca"
HF（Hugging Face）推理代码	无需添加额外启动参数	启动时添加参数 --with_prompt
web-demo 代码	不适用	直接提供 Alpaca 模型位置即可；支持多轮对话
LangChain 示例 / privateGPT	不适用	直接提供 Alpaca 模型位置即可
已知问题	如果不控制终止，则会一直写下去，直到达到输出长度上限。[2]	请使用 Pro 版，以避免 Plus 版回复过短的问题。

[1] llama.cpp/LlamaChat/HF（Hugging Face）推理代码/web-demo 代码/LangChain 示例 等已内嵌，无需手动添加模板。
[2] 如果出现模型回答质量特别低、胡言乱语、不理解问题等情况，请检查是否使用了正确的模型和启动参数。
[3] 经过指令精调的 Alpaca 会比 LLaMA 多一个 pad token（填充 token），因此请勿混用 LLaMA/Alpaca 词表。

推荐模型下载

以下为本项目推荐使用的模型列表，通常使用了更多的训练数据和优化的模型训练方法和参数，请优先使用这些模型（其余模型请查看 其他模型）。如希望体验类 ChatGPT 对话交互，请使用 Alpaca 模型，而不是 LLaMA 模型。 对于 Alpaca 模型，Pro 版针对回复内容过短的问题进行改进，模型回复效果有明显提升；如果更偏好短回复，请选择 Plus 系列。

模型名称	类型	训练数据	重构模型[1]	大小[2]	LoRA（低秩自适应）下载[3]
Chinese-LLaMA-Plus-7B	基座模型	通用 120G	原版 LLaMA-7B	790M	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-LLaMA-Plus-13B	基座模型	通用 120G	原版 LLaMA-13B	1.0G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-LLaMA-Plus-33B 🆕	基座模型	通用 120G	原版 LLaMA-33B	1.3G[6]	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-Pro-7B 🆕	指令模型	指令 4.3M	原版 LLaMA-7B & LLaMA-Plus-7B[4]	1.1G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-Pro-13B 🆕	指令模型	指令 4.3M	原版 LLaMA-13B & LLaMA-Plus-13B[4]	1.3G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-Pro-33B 🆕	指令模型	指令 4.3M	原版 LLaMA-33B & LLaMA-Plus-33B[4]	2.1G	[🤗HF] [🤖ModelScope] [Baidu]

[1] 重构需要原版 LLaMA 模型，去 LLaMA 项目申请使用 或参考这个 PR。因版权问题本项目无法提供下载链接。
[2] 经过重构后的模型大小比同等量级的原版 LLaMA 大一些（主要因为扩充了词表）。
[3] 下载后务必检查压缩包中模型文件的 SHA256 是否一致，请查看 SHA256.md。
[4] Alpaca-Plus 模型需要同时下载对应的 LLaMA-Plus 模型，请参考 [合并教程](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/手动模型合并与转换#多 lora 权重合并适用于 chinese-alpaca-plus)。
[5] 有些地方称为 30B，实际上是 Facebook 在发布模型时写错了，论文里仍然写的是 33B。
[6] 采用 FP16（半精度浮点数）存储，故模型体积较小。

压缩包内文件目录如下（以 Chinese-LLaMA-7B 为例）：

chinese_llama_lora_7b/
  - adapter_config.json		# LoRA 权重配置文件
  - adapter_model.bin		# LoRA 权重文件
  - special_tokens_map.json	# special_tokens_map 文件
  - tokenizer_config.json	# tokenizer 配置文件
  - tokenizer.model		# tokenizer 文件 

其他模型下载

由于训练方式和训练数据等因素影响，以下模型已不再推荐使用（特定场景下可能仍然有用），请优先使用上一节中的 推荐模型。

模型名称	类型	训练数据	重构模型	大小	LoRA 下载
Chinese-LLaMA-7B	基座模型	通用 20G	原版 LLaMA-7B	770M	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-LLaMA-13B	基座模型	通用 20G	原版 LLaMA-13B	1.0G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-LLaMA-33B	基座模型	通用 20G	原版 LLaMA-33B	2.7G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-7B	指令模型	指令 2M	原版 LLaMA-7B	790M	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-13B	指令模型	指令 3M	原版 LLaMA-13B	1.1G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-33B	指令模型	指令 4.3M	原版 LLaMA-33B	2.8G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-Plus-7B	指令模型	指令 4M	原版 LLaMA-7B & LLaMA-Plus-7B	1.1G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-Plus-13B	指令模型	指令 4.3M	原版 LLaMA-13B & LLaMA-Plus-13B	1.3G	[🤗HF] [🤖ModelScope] [Baidu]
Chinese-Alpaca-Plus-33B	指令模型	指令 4.3M	原版 LLaMA-33B & LLaMA-Plus-33B	2.1G	[🤗HF] [🤖ModelScope] [Baidu]

🤗transformers 调用

可以在🤗Model Hub 下载以上所有模型，并且使用 transformers 和 PEFT 调用中文 LLaMA 或 Alpaca LoRA 模型。以下模型调用名称指的是使用 .from_pretrained() 中指定的模型名称。

详细清单与模型下载地址：https://huggingface.co/hfl

合并模型

前面提到 LoRA 模型无法单独使用，必须与原版 LLaMA 进行合并才能转为完整模型，以便进行模型推理、量化或者进一步训练。请选择以下方法对模型进行转换合并。

方式	适用场景	教程
在线转换	Colab 用户可利用本项目提供的 notebook 进行在线转换并量化模型	链接
手动转换	离线方式转换，生成不同格式的模型，以便进行量化或进一步精调	链接

以下是合并模型后，FP16 精度和 4-bit 量化后的大小，转换前确保本机有足够的内存和磁盘空间（最低要求）：

模型版本	7B	13B	33B	65B
原模型大小（FP16）	13 GB	24 GB	60 GB	120 GB
量化后大小（8-bit）	7.8 GB	14.9 GB	32.4 GB	~60 GB
量化后大小（4-bit）	3.9 GB	7.8 GB	17.2 GB	38.5 GB

具体内容请参考本项目 >>> 📚 GitHub Wiki

本地推理与快速部署

本项目中的模型主要支持以下量化、推理和部署方式。

推理和部署方式	特点	平台	CPU	GPU	量化加载	图形界面	教程
llama.cpp	丰富的量化选项和高效本地推理	通用	✅	✅	✅	❌	[link](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/llama.cpp 量化部署)
🤗Transformers	原生 transformers 推理接口	通用	✅	✅	✅	✅	[link](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/使用 Transformers 推理)
text-generation-webui	前端 Web UI 界面的部署方式	通用	✅	✅	✅	✅	[link](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/使用 text-generation-webui 搭建界面)
LlamaChat	macOS 下的图形交互界面	MacOS	✅	❌	✅	✅	[link](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/使用 LlamaChat 图形界面（macOS）)
LangChain	LLM 应用开发框架，适用于进行二次开发	通用	✅†	✅	✅†	❌	[link](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/与 LangChain 进行集成)
privateGPT	基于 LangChain 的多文档本地问答框架	通用	✅	✅	✅	❌	[link](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/使用 privateGPT 进行多文档问答)
Colab Gradio Demo	Colab 中启动基于 Gradio 的交互式 Web 服务	通用	✅	✅	✅	❌	link
API 调用	仿 OpenAI API 接口的服务器 Demo	通用	✅	✅	✅	❌	[link](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/API 调用)

^†: LangChain 框架支持，但教程中未实现；详细说明请参考 LangChain 官方文档。

具体内容请参考本项目 >>> 📚 GitHub Wiki

系统效果

生成效果评测

为了快速评测相关模型的实际文本生成表现，本项目在给定相同的 prompt 的情况下，在一些常见任务上对比测试了本项目的中文 Alpaca-7B、中文 Alpaca-13B、中文 Alpaca-33B、中文 Alpaca-Plus-7B、中文 Alpaca-Plus-13B 的效果。生成回复具有随机性，受解码超参、随机种子等因素影响。以下相关评测并非绝对严谨，测试结果仅供晾晒参考，欢迎自行体验。

• 详细评测结果及生成样例请查看 examples 目录
• 📊 Alpaca 模型在线对战：http://llm-arena.ymcui.com

客观效果评测

本项目还在"NLU"类客观评测集合上对相关模型进行了测试。这类评测的结果不具有主观性，只需要输出给定标签（需要设计标签 mapping 策略），因此可以从另外一个侧面了解大模型的能力。本项目在近期推出的 C-Eval 评测数据集 上测试了相关模型效果，其中测试集包含 12.3K 个选择题，涵盖 52 个学科。以下是部分模型的 valid 和 test 集评测结果（Average），完整结果请参考 技术报告。

模型	Valid (zero-shot)	Valid (5-shot)	Test (zero-shot)	Test (5-shot)
Chinese-Alpaca-Plus-33B	46.5	46.3	44.9	43.5
Chinese-Alpaca-33B	43.3	42.6	41.6	40.4
Chinese-Alpaca-Plus-13B	43.3	42.4	41.5	39.9
Chinese-Alpaca-Plus-7B	36.7	32.9	36.4	32.3
Chinese-LLaMA-Plus-33B	37.4	40.0	35.7	38.3
Chinese-LLaMA-33B	34.9	38.4	34.6	39.5
Chinese-LLaMA-Plus-13B	27.3	34.0	27.8	33.3
Chinese-LLaMA-Plus-7B	27.3	28.3	26.9	28.4

需要注意的是，综合评估大模型能力仍然是亟待解决的重要课题，合理辩证地看待大模型相关各种评测结果有助于大模型技术的良性发展。推荐用户在自己关注的任务上进行测试，选择适配相关任务的模型。

C-Eval 推理代码请参考本项目 >>> [📚 GitHub Wiki](https://github.com/ymcui/Chinese-LLaMA-Alpaca/wiki/C-Eval 评测结果与脚本)

训练细节

整个训练流程包括词表扩充、预训练和指令精调三部分。

• 本项目的模型均在原 LLaMA 词表的基础上扩充了中文单词，代码请参考 merge_tokenizers.py
• 预训练和指令精调代码参考了🤗transformers 中的 run_clm.py 和 Stanford Alpaca 项目中数据集处理的相关部分
• 已开源用于预训练和指令精调的训练脚本：预训练脚本 Wiki、指令精调脚本 Wiki

具体内容请参考本项目 >>> 📚 GitHub Wiki

FAQ

FAQ 中给出了常见问题的解答，请在提 Issue 前务必先查看 FAQ。

问题 1：为什么不能放出完整版本权重？
问题 2：后面会有 33B、65B 的版本吗？
问题 3：一些任务上效果不好！
问题 4：为什么要扩充词表？直接在原版 LLaMA 上用中文预训练不行吗？
问题 5：回复内容很短
问题 6：Windows 下，模型无法理解中文、生成速度很慢等问题
问题 7：Chinese-LLaMA 13B 模型没法用 llama.cpp 启动，提示维度不一致
问题 8：Chinese-Alpaca-Plus 效果很差
问题 9：模型在 NLU 类任务（文本分类等）上效果不好
问题 10：为什么叫 33B，不应该是 30B 吗？
问题 11：模型合并之后 SHA256 不一致

具体问题和解答请参考本项目 >>> 📚 GitHub Wiki

局限性

虽然本项目中的模型具备一定的中文理解和生成能力，但也存在局限性，包括但不限于：

• 可能会产生不可预测的有害内容以及不符合人类偏好和价值观的内容
• 由于算力和数据问题，相关模型的训练并不充分，中文理解能力有待进一步提升
• 暂时没有在线可互动的 demo（注：用户仍然可以自行在本地部署）

引用

如果您觉得本项目对您的研究有所帮助或使用了本项目的代码或数据，请参考引用本项目的技术报告：https://arxiv.org/abs/2304.08177

@article{chinese-llama-alpaca,
      title={Efficient and Effective Text Encoding for Chinese LLaMA and Alpaca}, 
      author={Cui, Yiming and Yang, Ziqing and Yao, Xin},
      journal={arXiv preprint arXiv:2304.08177},
      url={https://arxiv.org/abs/2304.08177},
      year={2023}
}

相关项目

项目名称	简介	类型
Chinese-LLaMA-Alpaca-2（官方项目）	中文 LLaMA-2、Alpaca-2 大模型	文本
Visual-Chinese-LLaMA-Alpaca（官方项目）	多模态中文 LLaMA & Alpaca 大模型	多模态

想要加入列表？>>> 提交申请

致谢

本项目基于以下开源项目二次开发，在此对相关项目和研究开发人员表示感谢。

基础模型、代码	量化、推理、部署	数据
LLaMA by Facebook Alpaca by Stanford alpaca-lora by @tloen	llama.cpp by @ggerganov LlamaChat by @alexrozanski text-generation-webui by @oobabooga	pCLUE and MT data by @brightmart oasst1 by OpenAssistant

免责声明

本项目相关资源仅供学术研究之用，严禁用于商业用途。 使用涉及第三方代码的部分时，请严格遵循相应的开源协议。模型生成的内容受模型计算、随机性和量化精度损失等因素影响，本项目不对其准确性作出保证。对于模型输出的任何内容，本项目不承担任何法律责任，亦不对因使用相关资源和输出结果而可能产生的任何损失承担责任。本项目由个人及协作者业余时间发起并维护，因此无法保证能及时回复解决相应问题。

问题反馈

如有问题，请在 GitHub Issue 中提交。礼貌地提出问题，构建和谐的讨论社区。

• 在提交问题之前，请先查看 FAQ 能否解决问题，同时建议查阅以往的 issue 是否能解决你的问题。
• 提交问题请使用本项目设置的 Issue 模板，以帮助快速定位具体问题。
• 重复以及与本项目无关的 issue 会被 stable-bot 处理，敬请谅解。

Chinese-LLaMA-Alpaca 快速上手指南

本项目开源了中文 LLaMA 模型和指令精调的 Alpaca 大模型，在原版 LLaMA 基础上扩充了中文词表并进行了二次预训练及指令微调。支持本地量化部署及多种生态（Transformers, llama.cpp 等）。

环境准备

• 操作系统: Linux / Windows / macOS
• 硬件要求:
  • 推理：推荐 NVIDIA GPU；支持 CPU 量化部署（体验速度较慢）。
  • 训练：需要多卡 GPU 或高配置单机。
• 软件依赖:
  • Python >= 3.8
  • PyTorch (根据 CUDA 版本安装)
  • transformers, accelerate, peft 等库

安装步骤

1. 克隆项目

git clone https://github.com/ymcui/Chinese-LLaMA-Alpaca.git
cd Chinese-LLaMA-Alpaca

2. 安装依赖

pip install -r requirements.txt
# 或者手动安装核心依赖
pip install transformers accelerate peft torch

3. 下载模型权重

重要提示：本项目发布的是 LoRA 权重（补丁），需搭配 原版 LLaMA 模型 合并使用。

1. 获取原版 LLaMA 模型：需向 Meta 申请权限后下载（本项目不提供直接下载链接）。
2. 获取中文 LoRA 权重：推荐使用国内加速源。
   • HuggingFace: hfl/chinese-alpaca-pro-lora-7b
   • ModelScope (推荐): ChineseAlpacaGroup/chinese-alpaca-pro-lora-7b
   • 百度网盘: 见 README 中的下载链接

示例下载命令（以 ModelScope 为例）：

# 确保已安装 modelscope
pip install modelscope
modelscope download --model ChineseAlpacaGroup/chinese-alpaca-pro-lora-7b --local_dir ./models/chinese-alpaca-pro-lora-7b

4. 合并模型

由于 LoRA 无法单独运行，必须将下载的 LoRA 权重与原版 LLaMA 基座模型合并。请参考项目 Wiki 中的 手动模型合并教程。

通常涉及以下文件操作：

• adapter_config.json
• adapter_model.bin
• 原版 LLaMA 的 config.json, pytorch_model.bin 等

基本使用

命令行推理 (HF)

基座模型 (LLaMA)

适用于文本续写，无需特殊启动参数。

python ./scripts/inference/inference_hf.py \
    --base_model_path /path/to/original_llama \
    --lora_weights_path /path/to/chinese_llama_lora

指令模型 (Alpaca)

适用于问答、写作等指令理解任务。注意：启动时需添加 --with_prompt 参数。

python ./scripts/inference/inference_hf.py \
    --base_model_path /path/to/original_llama \
    --lora_weights_path /path/to/chinese_alpaca_lora \
    --with_prompt

Web 界面演示 (Gradio)

提供图形化交互界面，支持多轮对话。

python ./scripts/inference/gradio_demo.py \
    --model_path /path/to/merged_model

其他部署方式

• llama.cpp: 支持 8K context，使用 -ins 参数启动指令模式。
• Text-Generation-WebUI: 支持 --cpu 在无显卡环境下运行。
• LangChain / privateGPT: 直接提供合并后的模型路径即可集成。

模型选择建议：如需类 ChatGPT 对话交互，请使用 Alpaca 系列（如 Chinese-Alpaca-Pro-7B）；如需文本续写，请使用 LLaMA 系列。Pro 版针对回复长度和质量有显著优化。