Skip to content

Latest commit

 

History

History
147 lines (112 loc) · 5.59 KB

ChatGLM3_Export_Guide.md

File metadata and controls

147 lines (112 loc) · 5.59 KB
Raw

ChatGLM3模型导出与编译

1. 准备工作

ChatGLM3模型导出需要依赖ChatGLM3官方仓库。onnx模型导出和转bmodel模型推荐在mlir部分提供的docker中完成。

注意：

  • 编译模型需要在x86主机完成。
  • ChatGLM3-6B官方库50G左右，转模型需要保证运行内存至少32G以上，导出onnx模型需要存储空间100G以上，fp16模型转换需要存储空间200G以上，int8和int4模型需要的空间会更少。

2. 主要步骤

模型编译前需要安装TPU-MLIR。安装好后需在TPU-MLIR环境中进入例程目录。先导出onnx，然后使用TPU-MLIR将onnx模型编译为BModel。编译的具体方法可参考《TPU-MLIR快速入门手册》的“3. 编译ONNX模型”(请从算能官网相应版本的SDK中获取)。

2.1 TPU-MLIR环境搭建

2.1.1 安装docker

若已安装docker，请跳过本节。
```bash
# 安装docker
sudo apt-get install docker.io
# docker命令免root权限执行
# 创建docker用户组，若已有docker组会报错，没关系可忽略
sudo groupadd docker
# 将当前用户加入docker组
sudo usermod -aG docker $USER
# 切换当前会话到新group或重新登录重启X会话
newgrp docker​ 
```
> **提示**：需要logout系统然后重新登录，再使用docker就不需要sudo了。

2.1.2. 下载并解压TPU-MLIR

从sftp上获取TPU-MLIR压缩包
```bash
pip3 install dfss --upgrade
python3 -m dfss [email protected]:sophon-demo/ChatGLM3/tpu-mlir_v1.6.15-g671ee88e0-20240219.tar.gz
```

2.1.3. 创建并进入docker

TPU-MLIR使用的docker是sophgo/tpuc_dev:latest, docker镜像和tpu-mlir有绑定关系，少数情况下有可能更新了tpu-mlir，需要新的镜像。
```bash
docker pull sophgo/tpuc_dev:latest
# 这里将本级目录映射到docker内的/workspace目录,用户需要根据实际情况将demo的目录映射到docker里面
# myname只是举个名字的例子, 请指定成自己想要的容器的名字
docker run --name myname -v $PWD:/workspace -it sophgo/tpuc_dev:latest
# 此时已经进入docker，并在/workspace目录下
# 初始化软件环境
cd /workspace/tpu-mlir_vx.y.z-<hash>-<date>
source ./envsetup.sh
```

此镜像仅onnx模型导出和编译量化模型，程序编译和运行请在开发和运行环境中进行。更多TPU-MLIR的教程请参考算能官网的《TPU-MLIR快速入门手册》和《TPU-MLIR开发参考手册》。

2.2 获取onnx

2.2.1 下载ChatGLM3官方代码

注： ChatGLM3-6B官方库50G左右，在下载之前，要确认自己有huggingface官网的access token或者SSH key。

git lfs install
git clone [email protected]:THUDM/chatglm3-6b

如果git clone完代码之后出现卡住，可以尝试ctrl+c中断，然后进入仓库运行git lfs pull。

如果无法从官网下载，也可以下载我们之前下好的，压缩包20G左右

pip3 install dfss
python3 -m dfss [email protected]:ext_model_information/LLM/chatglm3-6b.tar.gz
tar zxvf chatglm3-6b.tar.gz

2.1.2 修改官方代码：

本例程的tools目录下提供了修改好之后的config.json和modeling_chatglm.py。可以直接替换掉原仓库的文件：

cp tools/chatglm3-6b/config.json chatglm3-6b/
cp tools/chatglm3-6b/modeling_chatglm.py chatglm3-6b/

以下是对应的三处修改：

  • 将config.json文件中seq_length配置为512；

  • 将modeling_chatglm.py文件中的如下代码：

if attention_mask is not None:
    attention_scores = attention_scores.masked_fill(attention_mask, float("-inf"))

修改为：

if attention_mask is not None:
    attention_scores = attention_scores + attention_mask

这样修改可以提升效率，使用masked_fill效率低下，我们把这一步骤从模型中拿了出来，放到了前处理里面。

  • 将modeling_chatglm.py文件中的如下代码：
pytorch_major_version = int(torch.__version__.split('.')[0])
if pytorch_major_version >= 2:

修改为

pytorch_major_version = int(torch.__version__.split('.')[0])
if False:

这是因为ONNX无法支持torch.nn.functional.scaled_dot_product_attention算子的转换。

2.1.3 导出onnx

  • 指定chatglm3-6B官方仓库的python路径
# 将/workspace/chatglm3-6b换成docker环境中您的chatglm3-6b仓库的路径
export PYTHONPATH=/workspace/chatglm3-6b:$PYTHONPATH
  • 导出所有onnx模型，如果过程中提示缺少某些组件，直接pip install组件即可
# 将/workspace/chatglm3-6b换成docker环境中您的chatglm3-6b仓库的路径
python3 tools/export_onnx.py --model_path /workspace/chatglm3-6b --onnx_path ./models/onnx

此时有大量onnx模型被导出到本例程中ChatGLM3/models/onnx的目录。

2.2 bmodel编译

目前TPU-MLIR支持1684x对ChatGLM3进行F16, INT8和INT4量化，使用如下命令生成bmodel。

./script/gen_bmodel --mode fp16

其中，mode可以指定fp16/int8/int4，编译成功之后，模型将会存放在models/BM1684X/目录下。

2.3 准备tokenizer

如果您之前没有运行过下载脚本，那么您需要运行它以获取tokenizer。经过上面的步骤，现在你的目录下已经存在models文件夹，所以它只会下载tokenizer。

# 安装unzip，若已安装请跳过，非ubuntu系统视情况使用yum或其他方式安装
sudo apt install unzip
chmod -R +x scripts/
./scripts/download.sh