CogVideoX1.5 5b模型基于Lite Server适配PyTorch NPU全量微调指导（6.5.901）

方案概览

本方案介绍了在ModelArts的Server上使用昇腾计算资源开展CogVideoX1.5 5b全量微调的详细过程。完成本方案的部署，需要先联系您所在企业的华为方技术支持购买Server资源。

本方案目前仅适用于企业客户。

资源规格要求

推荐使用“西南-贵阳一”Region上的Server资源和Ascend Snt9B单机。

获取软件和镜像

约束限制

• 本文档适配昇腾云ModelArts 6.5.901版本，请参考表2获取配套版本的软件包和镜像，请严格遵照版本配套关系使用本文档。
• 确保容器可以访问公网。

步骤一：准备环境

1. 请参考Lite Server资源开通，购买Server资源，并确保机器已开通，密码已获取，能通过SSH登录，不同机器之间网络互通。
   

   当容器需要提供服务给多个用户，或者多个用户共享使用该容器时，应限制容器访问Openstack的管理地址（169.254.169.254），以防止容器获取宿主机的元数据。具体操作请参见禁止容器获取宿主机元数据。

2. SSH登录机器后，检查NPU设备状态。运行如下命令，返回NPU设备信息。

   npu-smi info                    # 在每个实例节点上运行此命令可以看到NPU卡状态
   npu-smi info -l | grep Total    # 在每个实例节点上运行此命令可以看到总卡数

   如出现错误，可能是机器上的NPU设备没有正常安装，或者NPU镜像被其他容器挂载。请先正常安装固件和驱动，或释放被挂载的NPU。

3. 检查docker是否安装。

   docker -v   #检查docker是否安装

   如尚未安装，运行以下命令安装docker。

   yum install -y docker-engine.aarch64 docker-engine-selinux.noarch docker-runc.aarch64

4. 配置IP转发，用于容器内的网络访问。执行以下命令查看net.ipv4.ip_forward配置项的值，如果为1，可跳过此步骤。

   sysctl -p | grep net.ipv4.ip_forward

   如果net.ipv4.ip_forward配置项的值不为1，执行以下命令配置IP转发。

   sed -i 's/net\.ipv4\.ip_forward=0/net\.ipv4\.ip_forward=1/g' /etc/sysctl.conf
   sysctl -p | grep net.ipv4.ip_forward

步骤二：获取基础镜像

建议使用官方提供的镜像部署服务。镜像地址{image_url}参见表2。

docker pull {image_url}

步骤三：启动容器镜像

1. 启动容器镜像。启动前请先按照参数说明修改${}中的参数。

   export work_dir="自定义挂载的工作目录"
   export container_work_dir="自定义挂载到容器内的工作目录"
   export container_name="自定义容器名称"
   export image_name="镜像名称或ID"
   // 启动一个容器去运行镜像 
   docker run  -itd --net=bridge \
       --device=/dev/davinci0 \
       --device=/dev/davinci1 \
       --device=/dev/davinci2 \
       --device=/dev/davinci3 \
       --device=/dev/davinci4 \
       --device=/dev/davinci5 \
       --device=/dev/davinci6 \
       --device=/dev/davinci7 \
       --device=/dev/davinci_manager \
       --device=/dev/devmm_svm \
       --device=/dev/hisi_hdc \
       --shm-size=256g \
       -v /usr/local/dcmi:/usr/local/dcmi \
       -v /usr/local/Ascend/driver:/usr/local/Ascend/driver \
       -v /var/log/npu/:/usr/slog \
       -v /usr/local/sbin/npu-smi:/usr/local/sbin/npu-smi \
       -v ${work_dir}:${container_work_dir} \
       --name ${container_name} \
       ${image_name} \
       /bin/bash

   参数说明：

   • -v ${work_dir}:${container_work_dir}：代表需要在容器中挂载宿主机的目录。宿主机和容器使用不同的文件系统。work_dir为宿主机中工作目录，目录下可存放项目所需代码、数据等文件。container_work_dir为要挂载到的容器中的目录。为方便两个地址可以相同。
     

     • 容器不能挂载到/home/ma-user目录，此目录为ma-user用户家目录。如果容器挂载到/home/ma-user下，拉起容器时会与基础镜像冲突，导致基础镜像不可用。

     • driver及npu-smi需同时挂载至容器。
   • --name ${container_name}：容器名称，进入容器时会用到，此处可以自己定义一个容器名称。
   • ${image_name}：容器镜像的名称。
   • --device=/dev/davinci0 ：挂载对应卡到容器，当需要挂载多卡，请依次添加多项该配置
2. 通过容器名称进入容器中。默认使用ma-user用户，后续所有操作步骤都在ma-user用户下执行。

   docker exec -it ${container_name} bash

步骤四：安装依赖和软件包

1. git clone和git lfs下载大模型可以参考如下操作。
   1. 由于欧拉源上没有git-lfs包，所以需要从压缩包中解压使用，在浏览器中输入如下地址下载git-lfs压缩包并上传到容器的/home/ma-user目录下。

      https://github.com/git-lfs/git-lfs/releases/download/v3.2.0/git-lfs-linux-arm64-v3.2.0.tar.gz

      或直接下载到容器，这样在容器中可以直接使用。

      cd /home/ma-user
      wget https://github.com/git-lfs/git-lfs/releases/download/v3.2.0/git-lfs-linux-arm64-v3.2.0.tar.gz

   2. 进入容器，执行安装git lfs命令。

      cd /home/ma-user
      tar -zxvf git-lfs-linux-arm64-v3.2.0.tar.gz 
      cd git-lfs-3.2.0 
      sudo sh install.sh

   3. 设置git配置去掉ssl校验。

      git config --global http.sslVerify false

2. 从github拉取finetrainers代码。

   cd /home/ma-user
   git clone https://github.com/a-r-r-o-w/finetrainers.git
   cd /home/ma-user/finetrainers
   git checkout 80d1150a0e233a1

3. 若进行训练微调需依赖decord包，arm版本可参考附录安装编译。
4. 由于当前CogVideoX1.5版本依赖的diffuser暂未合入主线，需安装分支版本diffuser

   cd /home/ma-user
   git clone https://github.com/zRzRzRzRzRzRzR/diffusers
   cd /home/ma-user/diffusers/
   git checkout cogvideox1.1-5b
   git checkout ea166f85ad0090d182ec5f0
   pip install -e .

5. 安装CogVideo Ascend软件包。
   1. 将获取到的CogVideo Ascend软件包AscendCloud-AIGC-*.zip文件上传到容器的/home/ma-user目录下。获取路径参见获取软件和镜像。
   2. 解压AscendCloud-AIGC-*.zip文件，解压后将里面指定文件与对应CogVideo文件进行替换，执行以下命令即可。

      cd /home/ma-user
      unzip AscendCloud-AIGC-*.zip -d ./AscendCloud
      cd AscendCloud/multimodal_algorithm/CogVideoX_1_5/
      dos2unix install.sh
      bash install.sh

      

      AscendCloud-AIGC-*.zip后面的*表示时间戳，请按照实际替换。

      CogVideo Ascend软件包内容如下：

      .
      |---- install.sh           安装torch-npu适配修改脚本
      |---- modify.patch         适配CogVideo训练代码git patch文件
      |---- README.md            适配文档基于官方代码commit id说明
      |---- requirements.txt     python依赖包

步骤五：CogVideo微调

1. 下载模型权重

   下载CogVideoX1.5 5b模型，huggingface地址如下

   https://huggingface.co/THUDM/CogVideoX1.5-5B

2. 准备数据集

   数据集可参考使用如下数据集

   https://huggingface.co/datasets/Wild-Heart/Tom-and-Jerry-VideoGeneration-Dataset

3. 进行data cache

   由于CogVideoX1.5对显存需求较大，直接训练显存不足，训练采用data cache，将text encoder和vae两个不参与训练的模型对数据集进行预编码处理。

   cd /home/ma-user/finetrainers

   对/home/ma-user/finetrainers/prepare_dataset.sh文件进行修改，配置对应的参数：

   MODEL_ID="path/CogVideoX1.5-5B" # 模型路径
   DATA_ROOT="path/Tom-and-Jerry-VideoGeneration-Dataset"  # 数据集路径
   CAPTION_COLUMN="captions.txt"   # 数据集提示词文件名
   VIDEO_COLUMN="videos.txt"       # 数据集视频名文件名 
   OUTPUT_DIR="path/preprocessed-Tom-dataset"   # 预编码处理的tensor数据集输出路径

   修改后，执行prepare_dataset.sh脚本

   bash prepare_dataset.sh

4. 进行模型训练

   cd /home/ma-user/finetrainers

   对finetrainers/train_text_to_video_sft.sh文件进行修改，配置训练使用的超参数：

   MAX_TRAIN_STEPS=("20000")    # 最大训练步数
   DATA_ROOT="path/preprocessed-Tom-dataset"  # 预编码处理的tensor数据集路径，即data cache的输出路径
   CAPTION_COLUMN="prompts.txt"        # 数据集提示词文件名
   VIDEO_COLUMN="videos.txt"            # 数据集视频名文件名
   MODEL_PATH="THUDM/CogVideoX1.5-5B"   # 模型路径
   output_dir="/path/to/my/models/cogvideox-sft # 模型输出路径

   修改后，执行train_text_to_video_sft.sh脚本

   bash train_text_to_video_sft.sh

以上微调文档提示来自官方文档，有关可用微调脚本参数及其功能的全面文档，您可以参考官方finetrainers中CogVideo训练文档。

附：decord在arm版本安装参考

由于训练使用decord的Python包没有arm版本，请自行进行编译安装，以下给出安装编译教程仅供参考：

• decord包编译

  可参考如下脚本：

  bash install_decord.sh # install_decord.sh内容如下

  install_decord.sh脚本内容如下：

  cd /home/ma-user/
  git config --global http.sslVerify false
  git clone  --recursive https://github.com/dmlc/decord --depth 1
  cd decord
  mkdir build && cd build
  cmake ..  -DCMAKE_BUILD_TYPE=Release -DFFMPEG_DIR:PATH="/usr/local/ffmpeg/"
  make
  cd ../python
  ### option 1: add python path to $PYTHONPATH, you will need to install numpy separately
  echo "PYTHONPATH=$PYTHONPATH:/home/ma-user/decord/python" >> ~/.bashrc
  source ~/.bashrc
  ### option 2: install with setuptools
  python3 setup.py install --user