OpenSoraPlan1.2 使用指南

目录

• 版本说明
  • 参考实现
  • 变更记录
• 环境安装
  • 仓库拉取
  • 环境搭建
• 权重下载及转换
  • 权重下载
  • 权重转换
• 数据集准备及处理
  • 数据集下载
• 预训练
  • 准备工作
  • 配置参数
  • 启动预训练
• 推理
  • 准备工作
  • 配置参数
  • 启动推理
• 环境变量声明

版本说明

参考实现

url=https://github.com/PKU-YuanGroup/Open-Sora-Plan.git
commit_id=adb2a20

变更记录

2024.09.20: 首次发布OpenSoraPlan1.2

---

环境安装

【模型开发时推荐使用配套的环境版本】

请参考安装指南

1. 仓库拉取

    git clone https://gitcode.com/Ascend/MindSpeed-MM.git 
    git clone https://github.com/NVIDIA/Megatron-LM.git
    cd Megatron-LM
    git checkout core_v0.12.1
    cp -r megatron ../MindSpeed-MM/
    cd ..
    cd MindSpeed-MM

2. 环境搭建

    # python3.10
    conda create -n test python=3.10
    conda activate test

    # 安装 torch 和 torch_npu，注意要选择对应python版本、x86或arm的torch、torch_npu及apex包
    pip install torch-2.7.1-cp310-cp310-manylinux_2_28_aarch64.whl
    pip install torch_npu-2.7.1*-cp310-cp310-manylinux_2_28_aarch64.whl
    
    # apex for Ascend 参考 https://gitcode.com/Ascend/apex
    # 建议从原仓编译安装

    # 将shell脚本中的环境变量路径修改为真实路径，下面为参考路径
    source /usr/local/Ascend/ascend-toolkit/set_env.sh 

    # 安装加速库
    git clone https://gitcode.com/Ascend/MindSpeed.git
    cd MindSpeed
    # checkout commit from MindSpeed core_r0.12.1
    git checkout 5176c6f5f133111e55a404d82bd2dc14a809a6ab
    pip install -r requirements.txt 
    pip3 install -e .
    cd ..

    # 安装其余依赖库
    pip install -e .

3. Decord搭建

【X86版安装】

pip install decord==0.6.0

【ARM版安装】

apt方式安装请参考链接

yum方式安装请参考脚本

---

权重下载及转换

1. 权重下载

从Huggingface等网站下载开源模型权重

• LanguageBind/Open-Sora-Plan-v1.2.0：CausalVAE模型和VideoDiT模型；

• DeepFloyd/mt5-xxl： MT5模型；

2. 权重转换

MindSpeed-MM修改了部分原始网络的结构名称，因此需要使用convert_ckpt_to_mm.py脚本进行转换，该脚本实现了从hugging face下载的预训练权重到MindSpeed-MM权重的转换以及TP（Tensor Parallel）权重的切分与合并。

转换vae权重

mm-convert OpenSoraPlanConverter --version v1.2 vae_convert \
 --cfg.source_path <"./raw_ckpt/open-sora-plan/vae/checkpoint.ckpt">
 --cfg.target_path <"./ckpt/vae/vae.pt">

转换dit部分权重

mm-convert OpenSoraPlanConverter --version v1.2 hf_to_mm \
 --cfg.source_path <"./raw_ckpt/open-sora-plan/93x480p/">
 --cfg.target_path <"./ckpt/open-sora-plan-12/93x480p/">
 --cfg.target_parallel_config.tp_size <tp_size>

权重转换工具的参数说明与默认值如下：

参数	含义	默认值
--version	opensoraplan系列不同版本	默认为v1.5，需要设置为v1.2
--cfg.source_path	原始权重路径	/
--cfg.target_path	转换或切分后权重保存路径	/
--cfg.target_parallel_config.tp_size	dit部分切分时的tp size	1

同步修改examples/opensoraplan1.2/pretrain_opensoraplan1_2.sh 中的--load参数，该路径为转换后或者切分后的权重，注意--load配置的是转换到MindSpeed-MM后的dit权重路径，vae权重路径在model_opensoraplan1_2.json中配置

LOAD_PATH="./ckpt/open-sora-plan-12/93x480p"

---

数据集准备及处理

1. 数据集下载

用户需自行获取并解压pixabay_v2数据集，获取数据结构如下：

$pixabay_v2
├── annotation.json
├── folder_01
├── ├── video0.mp4
├── ├── video1.mp4
├── ├── ...
├── ├── annotation.json
├── folder_02
├── folder_03
└── ...

---

预训练

1. 准备工作

配置脚本前需要完成前置准备工作，包括：环境安装、权重下载及转换、数据集准备及处理，详情可查看对应章节。

2. 配置参数

需根据实际情况修改model_opensoraplan1_2.json和data.json中的权重和数据集路径，包括from_pretrained、data_path、data_folder字段。

• Encoder-DP：Encoder数据并行

  • 使用场景：在开启TP、CP时，DP较小，存在vae和text_encoder的冗余encode计算。开启以减小冗余计算，但会增加通信，需要按场景开启。
  • 使能方式：在xxx_model.json中设置"enable_encoder_dp": true。
  • 限制条件：暂不兼容PP、VAE-CP。支持与Encoder Interleaved Offload功能同时开启。

• Encoder Interleaved Offload: Encoder 交替卸载

  • 使用场景：在NPU内存瓶颈的训练场景中，可以一次性编码多步训练输入数据然后卸载编码器至cpu上，使得文本编码器无需常驻内存，减少内存占用。 故可在不增加内存消耗的前提下实现在线训练，避免手动离线提取特征。
  • 使能方式：在xxx_model.json中，设置 encoder_offload_interval > 1. 建议设置根据实际场景设置大于10，可以极小化卸载带来的性能损耗
  • 限制条件：启用时建议调大num_worker以达最佳性能; 支持与Encoder-DP同时开启。

【单机运行】

    GPUS_PER_NODE=8
    MASTER_ADDR=localhost
    MASTER_PORT=29501
    NNODES=1  
    NODE_RANK=0  
    WORLD_SIZE=$(($GPUS_PER_NODE * $NNODES))

【多机运行】

    # 根据分布式集群实际情况配置分布式参数
    GPUS_PER_NODE=8  #每个节点的卡数
    MASTER_ADDR="your master node IP"  #都需要修改为主节点的IP地址（不能为localhost）
    MASTER_PORT=29501
    NNODES=2  #集群里的节点数，以实际情况填写,
    NODE_RANK="current node id"  #当前节点的RANK，多个节点不能重复，主节点为0, 其他节点可以是1,2..
    WORLD_SIZE=$(($GPUS_PER_NODE * $NNODES))

3. 启动预训练

    bash examples/opensoraplan1.2/pretrain_opensoraplan1_2.sh

注意：

• 多机训练需在多个终端同时启动预训练脚本(每个终端的预训练脚本只有NODE_RANK参数不同，其他参数均相同)
• 如果使用多机训练，需要在每个节点准备训练数据和模型权重

---

推理

1. 准备工作

参考上述的权重下载及转换章节，需求的权重需要到huggingface中下载，以及参考上面的权重转换代码进行转换。 链接参考: predict_model VAE tokenizer/text_encoder

如果在训练时对dit部分进行了TP切分，推理时可以运行下面的脚本将该部分权重进行合并

mm-convert OpenSoraPlanConverter --version v1.2 resplit \
 --cfg.source_path <"./ckpt/open-sora-plan-12/93x480p/">
 --cfg.target_path <"./ckpt/open-sora-plan-12/93x480p_merge/">

2. 配置参数

将准备好的权重传入到inference_model_29x480x640.json中，更改其中的路径，包括from_pretrained，自定义的prompt可以传入到prompt字段中

3. 启动推理

启动推理脚本

bash examples/opensoraplan1.2/inference_opensoraplan1_2.sh

---

环境变量声明

环境变量	描述	取值说明
ASCEND_SLOG_PRINT_TO_STDOUT	是否开启日志打印	0: 关闭日志打屏 1: 开启日志打屏
ASCEND_GLOBAL_LOG_LEVEL	设置应用类日志的日志级别及各模块日志级别，仅支持调试日志	0: 对应DEBUG级别 1: 对应INFO级别 2: 对应WARNING级别 3: 对应ERROR级别 4: 对应NULL级别，不输出日志
TASK_QUEUE_ENABLE	用于控制开启task_queue算子下发队列优化的等级	0: 关闭 1: 开启Level 1优化 2: 开启Level 2优化
COMBINED_ENABLE	设置combined标志。设置为0表示关闭此功能；设置为1表示开启，用于优化非连续两个算子组合类场景	0: 关闭 1: 开启
CPU_AFFINITY_CONF	控制CPU端算子任务的处理器亲和性，即设定任务绑核	设置0或未设置: 表示不启用绑核功能 1: 表示开启粗粒度绑核 2: 表示开启细粒度绑核
HCCL_CONNECT_TIMEOUT	用于限制不同设备之间socket建链过程的超时等待时间	需要配置为整数，取值范围[120,7200]，默认值为120，单位s
PYTORCH_NPU_ALLOC_CONF	控制缓存分配器行为	expandable_segments:<value>: 使能内存池扩展段功能，即虚拟内存特征
HCCL_EXEC_TIMEOUT	控制设备间执行时同步等待的时间，在该配置时间内各设备进程等待其他设备执行通信同步	需要配置为整数，取值范围[68,17340]，默认值为1800，单位s
ACLNN_CACHE_LIMIT	配置单算子执行API在Host侧缓存的算子信息条目个数	需要配置为整数，取值范围[1, 10,000,000]，默认值为10000
TOKENIZERS_PARALLELISM	用于控制Hugging Face的transformers库中的分词器（tokenizer）在多线程环境下的行为	False: 禁用并行分词 True: 开启并行分词
MULTI_STREAM_MEMORY_REUSE	配置多流内存复用是否开启	0: 关闭多流内存复用 1: 开启多流内存复用
NPU_ASD_ENABLE	控制是否开启Ascend Extension for PyTorch的特征值检测功能	设置0或未设置: 关闭特征值检测 1: 表示开启特征值检测，只打印异常日志，不告警 2:开启特征值检测，并告警 3:开启特征值检测，并告警，同时会在device侧info级别日志中记录过程数据
ASCEND_LAUNCH_BLOCKING	控制算子执行时是否启动同步模式	0: 采用异步方式执行 1: 强制算子采用同步模式运行
NPUS_PER_NODE	配置一个计算节点上使用的NPU数量	整数值（如 1, 8 等）