ascend-robot[Docs] modify the branch version

371f2867创建于 2025年10月24日历史提交

VideoAlign 使用指南

版本说明

参考实现

url=https://github.com/KwaiVGI/VideoAlign.git
commit_id=0150859

变更记录

2025.08.26: 首次支持VideoAlign模型

环境安装

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

请参考安装指南

1. 仓库拉取

git clone --branch 2.2.0 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
mkdir logs
mkdir data
mkdir ckpt

2. 环境搭建

git clone --branch 2.2.0 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
mkdir logs data ckpt
# 安装加速库
git clone https://gitcode.com/Ascend/MindSpeed.git
cd MindSpeed
# checkout commit from MindSpeed core_r0.12.1
git checkout 6d63944cb2470a0bebc38dfb65299b91329b8d92
# 安装mindspeed及依赖
pip install -e .
cd ..
# 安装mindspeed mm及依赖
pip install -e .

# 指定版本库安装
pip install peft==0.10.0

权重下载及转换

1. 权重下载

从Huggingface库下载对应的模型权重:

模型地址: Qwen2-VL-2B；
模型地址: VideoAlign；

将下载的模型权重保存到对应目录下： Qwen2-VL-2B：ckpt/hf_path/Qwen2-VL-2B-Instruct VideoAlign：ckpt/hf_path/VideoReward

2. 权重转换(hf2mm)

MindSpeed-MM修改了部分原始网络的结构名称，使用mm-convert工具对原始预训练权重进行转换。该工具实现了huggingface权重到MindSpeed-MM权重的转换。参考权重转换工具

参数	含义及用法
mm_dir	转换后保存目录
hf_dir	huggingface权重目录
pt_path	videoalign模型 .pth格式路径
llm_pp_layers	llm在每个卡上切分的层数，注意要和model.json中配置的pipeline_num_layers一致
vit_pp_layers	vit在每个卡上切分的层数，注意要和model.json中配置的pipeline_num_layers一致
tp_size	tp并行数量，注意要和微调启动脚本中的配置一致
resize_vocab_size	采用评测指标tokens后的vocab_size 会根据vocab_siz变化对Qwen2-VL-2B模型embed_tokens.weight层权重进行resize ['VQ', 'MQ', 'TA']打分指标对应vocab_size为151660
model_prefix	消除huggingface中VideoAlign权重里因peft包裹产生的前缀（"base_model.model."）
new_transformers_weight_key	是否使用新Qwen2VL权重名的huggingface权重若huggface的权重名为transformers新权重名：model.language_model.layers.xx, model.visual.blocks.xx（原来权重名为：model.layers.xx, visual.blocks.xx）, 设置如下命令： --cfg.common_model_config.new_transformers_weight_key true \

# Qwen2VL权重转mm格式用于训练
mm-convert  VideoAlignConverter hf_to_mm \
  --cfg.mm_dir "ckpt/mm_path/Qwen2-VL-2B-Instruct" \
  --cfg.hf_config.hf_dir "ckpt/hf_path/Qwen2-VL-2B-Instruct" \
  --cfg.parallel_config.llm_pp_layers [[28]] \
  --cfg.parallel_config.vit_pp_layers [[32]] \
  --cfg.parallel_config.tp_size 1 \
  --cfg.common_model_config.resize_vocab_size 151660

# VideoAlign权重转mm用于微调/推理/评测
mm-convert  VideoAlignConverter hf_to_mm \
  --cfg.mm_dir "ckpt/mm_path/VideoReward" \
  --cfg.hf_config.hf_dir "ckpt/hf_path/Qwen2-VL-2B-Instruct" \
  --cfg.pt_path "ckpt/hf_path/VideoReward/checkpoint-xxx/model.pth" \
  --cfg.parallel_config.llm_pp_layers [[28]] \
  --cfg.parallel_config.vit_pp_layers [[32]] \
  --cfg.parallel_config.tp_size 1 \
  --cfg.common_model_config.model_prefix "base_model.model."

如果需要用转换后模型训练的话，同步修改examples/videoalign/finetune_lora.sh中的LOAD_PATH参数，该路径为转换后或者切分后的权重，注意与原始权重进行区分。

LOAD_PATH="ckpt/mm_path/Qwen2-VL-2B-Instruct"

或

LOAD_PATH="ckpt/mm_path/VideoReward"

数据集准备及处理

数据集下载(以RewardBench数据集为例)

用户需要自行下载RewardBench数据集VideoGen-RewardBench，并解压到项目目录下的./datafolder/VideoGen-RewardBench文件夹中

微调

1. 准备工作

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

微调中数据集csv文件应包含应包含如下数据：

path_A	path_B	prompt	VQ	MQ	TA	fps_A	num_frames_A	fps_B	num_frames_B
...	...	...	...	...	...	...	...	...	...

2. 配置参数

【数据目录配置】

根据实际情况修改data.json中的数据集路径，包括model_name_or_path、data_folder、data_path, cache_dir等字段。注意model_name_or_path的权重路径为转换前的权重路径。

注意cache_dir在多机上不要配置同一个挂载目录避免写入同一个文件导致冲突。

{
    "dataset_param": {
        "dataset_type": "rewardvideo",
        "preprocess_parameters": {
            "model_name_or_path": "./ckpt/hf_path/Qwen2-VL-2B-Instruct/",
            ...
        },
        "basic_parameters": {
            ...
            "data_folder": "./datafolder/VideoGen-RewardBench/",
            "data_path": "./datafolder/VideoGen-RewardBench/videogen-rewardbench.csv",
            "cache_dir": "./cache_dir",
            ...
        },
        ...
    },
    ...
}

【模型目录配置】根据实际情况修改model.json中的训练配置，包括:

参数	含义及用法
`output_dim`	模型输出维度
`reward_token`	reward_token的计算方式
`loss_type`	reward loss的计算类型
`lora_mixed_training`	是否开启lora参数和非lora参数混合训练（例如ViT采用全参微调，text-decoder采用lora微调）
`lora_apply_modules`	混合训练时采用lora微调的模块
`lora_save_full_weight`	混合训练中同时保持lora权重和非lora权重
`freeze`	冻结该模块参数，不参与训练

{
    "model_id": "qwen2vl",
    "img_context_token_id": 151656,
    "video_token_id": 151656,
    "vision_start_token_id": 151652,
    "output_dim": 1,
    "reward_token": "special",
    "loss_type": "btt",
    "lora_apply_modules": ["text_decoder"],
    "lora_mixed_training": true,
    "lora_save_full_weight": true,
    ...

"image_encoder": {
        "vision_encoder": {
            ...
            "freeze": true,
            ...

注：默认配置image-encoder全参训练，text-decoder采用lora微调的混合训练方式，否则容易出现显存不足

【模型保存加载及日志信息配置】

根据实际情况配置examples/videoalign/finetune_lora.sh的参数，包括加载、保存路径以及保存间隔--save-interval（注意：分布式优化器保存文件较大耗时较长，请谨慎设置保存间隔）

...
# 加载路径
LOAD_PATH="ckpt/mm_path/Qwen2-VL-2B-Instruct"
# 保存路径
SAVE_PATH="save_dir"
...
GPT_ARGS="
    ...
    --no-load-optim \  # 不加载优化器状态，若需加载请移除
    --no-load-rng \  # 不加载随机数状态，若需加载请移除
    --no-save-optim \  # 不保存优化器状态，若需保存请移除
    --no-save-rng \  # 不保存随机数状态，若需保存请移除
    ...
"
...
OUTPUT_ARGS="
    --log-interval 1 \  # 日志间隔
    --save-interval 5000 \  # 保存间隔
    ...
    --log-tps \  # 增加此参数可使能在训练中打印每步语言模块的平均序列长度，并在训练结束后计算每秒吞吐tokens量。
"

若需要加载指定迭代次数的权重、优化器等状态，需将加载路径LOAD_PATH设置为保存文件夹路径LOAD_PATH="save_dir"，并修改latest_checkpointed_iteration.txt文件内容为指定迭代次数 (此功能coming soon)

$save_dir
   ├── latest_checkpointed_iteration.txt
   ├── ...

若开启lora混合训练，保存权重包含lora权重和非lora权重，需要通过转换脚本进行拆分后分别加载。(此功能coming soon)

【单机运行配置】

配置examples/videoalign/finetune_lora.sh参数如下

# 根据实际情况修改 ascend-toolkit 路径
source /usr/local/Ascend/ascend-toolkit/set_env.sh
NPUS_PER_NODE=8
MASTER_ADDR=localhost
MASTER_PORT=6000
NNODES=1
NODE_RANK=0
WORLD_SIZE=$(($NPUS_PER_NODE * $NNODES))

注：训练默认开启FA，否则可能会显存不足报错，通过开关--use-flash-attn 控制。

当开启PP时，model.json中配置的vision_encoder和text_decoder的pipeline_num_layer参数控制了各自的PP切分策略。对于流水线并行，要先处理vision_encoder再处理text_decoder。比如[32,0,0,0]、[1,10,10,7]，其含义为PP域内第一张卡先放32层vision_encoder再放1层text_decoder、第二张卡放text_decoder接着的10层、第三张卡放text_decoder接着的10层、第四张卡放text_decoder接着的7层，vision_encoder没有放完时不能先放text_decoder（比如[30,2,0,0]、[1,10,10,7]的配置是错的）。

如果某张卡上的参数全部冻结时会导致没有梯度（比如vision_encoder冻结时PP配置[30,2,0,0]、[0,11,10,7]），需要在finetune_qwen2vl_7b.sh中GPT_ARGS参数中增加--enable-dummy-optimizer，参考dummy_optimizer特性文档。

3. 启动微调

通过以下命令启动微调训练任务。

bash examples/videoalign/finetune_lora.sh

推理

1、准备工作（以微调环境为基础，包括环境安装、权重下载及转换）

推理数据csv应包含如下数据：

path_A	path_B	prompt	fps_A	num_frames_A	fps_B	num_frames_B
...	...	...	...	...	...	...

2、配置参数

【数据目录配置】
根据实际情况修改examples/videoalign/data.json中的数据路径等参数：

参数	配置方法
`model_name_or_path`	配置与微调保持中一致
`data_folder`	推理数据集所在文件夹路径
`data_path`	推理数据集csv路径
`save_path`	推理结果xlsx保存路径
`task`	任务类型，选择`inference`

"inference_param": {
        "data_folder": "./datafolder/VideoGen-RewardBench/",
        "data_path": "./datafolder/VideoGen-RewardBench/videogen-rewardbench.csv",
        "save_path": "./inference_result/",
        "task": "inference",
        ...

3、启动推理

bash examples/videoalign/inference.sh

推理结果会输出到inference_result路径中，会输出结果文件：

reward_out_single.xlsx文件，这个文件会输出每条视频的评测分数。

评测

1、准备工作（以微调环境为基础，包括环境安装、权重下载及转换）

评测数据csv应包含如下数据：

path_A	path_B	prompt	VQ	MQ	TA	Overall	fps_A	num_frames_A	fps_B	num_frames_B
...	...	...	...	...	...	...	...	...	...	---

2、配置参数

【数据目录配置】根据实际情况修改examples/videoalign/data.json中的数据路径等参数：

参数	配置方法
`model_name_or_path`	配置与微调保持中一致
`data_folder`	评测数据集所在文件夹路径
`data_path`	评测数据集csv路径
`save_path`	评测结果xlsx保存路径
`task`	任务类型，选择`evaluate`
`reward_attributes`	评测指标
`use_norm`	评测分数是否归一化
`norm_param`	归一化参数

"inference_param": {
        "data_folder": "./datafolder/VideoGen-RewardBench/",
        "data_path": "./datafolder/VideoGen-RewardBench/videogen-rewardbench.csv",
        "save_path": "./evaluate_result/",
        "task": "evaluate",
        "reward_attributes": ["VQ", "MQ", "TA", "Overall"],
        "use_norm": false,
        "norm_param": {
            "VQ_mean": 3.6757,
            "VQ_std": 2.2476,
            "MQ_mean": 1.1646,
            "MQ_std": 1.3811,
            "TA_mean": 2.8105,
            "TA_std": 2.5121
        }
        ...

3、启动评测

bash examples/videoalign/inference.sh

评测结果会输出到evaluate_result路径中，会输出结果文件：

reward_out_single.xlsx文件，这个文件会输出每条视频的评测分数。
reward_out_pair.xlsx文件，这个文件会输出每对样本的评测分数及胜负情况。
eval_accuracy.json文件，这个文件会输出各评测指标统计准确率等数据。

特性使用介绍

lora微调

LoRA为框架通用能力，当前功能已支持，可参考LoRA特性文档。

环境变量声明

环境变量	描述	取值说明
`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` 等）

注意事项

在 finetune_lora.sh里，与模型结构相关的参数并不生效，以examples/videoalign/model.json里同名参数配置为准，非模型结构的训练相关参数在 finetune_lora.sh修改。