LightX2V 快速入门指南#

欢迎使用 LightX2V!本指南将帮助您快速搭建环境并开始使用 LightX2V 进行视频生成。

📋 目录#

🚀 系统要求#

  • 操作系统: Linux (Ubuntu 18.04+) 或 Windows 10/11

  • Python: 3.10 或更高版本

  • GPU: NVIDIA GPU,支持 CUDA,至少 8GB 显存

  • 内存: 建议 16GB 或更多

  • 存储: 至少 50GB 可用空间

🐧 Linux 系统环境搭建#

🐳 Docker 环境(推荐)#

我们强烈推荐使用 Docker 环境,这是最简单快捷的安装方式。

1. 拉取镜像#

访问 LightX2V 的 Docker Hub,选择一个最新日期的 tag,比如 26011201-cu128

docker pull lightx2v/lightx2v:26011201-cu128

我们推荐使用cuda128环境,以获得更快的推理速度,若需要使用cuda124环境,可以使用带-cu124后缀的镜像版本:

docker pull lightx2v/lightx2v:25101501-cu124

2. 运行容器#

docker run --gpus all -itd --ipc=host --name [容器名] -v [挂载设置] --entrypoint /bin/bash [镜像id]

3. 中国镜像源(可选)#

对于中国大陆地区,如果拉取镜像时网络不稳定,可以从阿里云上拉取:

# cuda128
docker pull registry.cn-hangzhou.aliyuncs.com/yongyang/lightx2v:26011201-cu128

# cuda124
docker pull registry.cn-hangzhou.aliyuncs.com/yongyang/lightx2v:25101501-cu124

🐍 Conda 环境搭建#

如果您希望使用 Conda 自行搭建环境,请按照以下步骤操作:

步骤 1: 克隆项目#

# 下载项目代码
git clone https://github.com/ModelTC/LightX2V.git
cd LightX2V

步骤 2: 创建 conda 虚拟环境#

# 创建并激活 conda 环境
conda create -n lightx2v python=3.11 -y
conda activate lightx2v

步骤 3: 安装依赖及代码#

pip install -v -e .

步骤 4: 安装注意力机制算子#

选项 A: Flash Attention 2

git clone https://github.com/Dao-AILab/flash-attention.git --recursive
cd flash-attention && python setup.py install

选项 B: Flash Attention 3(用于 Hopper 架构显卡)

cd flash-attention/hopper && python setup.py install

选项 C: SageAttention 2(推荐)

git clone https://github.com/thu-ml/SageAttention.git
cd SageAttention && CUDA_ARCHITECTURES="8.0,8.6,8.9,9.0,12.0" EXT_PARALLEL=4 NVCC_APPEND_FLAGS="--threads 8" MAX_JOBS=32 pip install -v -e .

步骤 4: 安装量化算子(可选)#

量化算子用于支持模型量化功能,可以显著降低显存占用并加速推理。根据您的需求选择合适的量化算子:

选项 A: VLLM Kernels(推荐) 适用于多种量化方案,支持 FP8 等量化格式。

pip install vllm

或者从源码安装以获得最新功能:

git clone https://github.com/vllm-project/vllm.git
cd vllm
uv pip install -e .

选项 B: SGL Kernels 适用于 SGL 量化方案,需要 torch == 2.8.0。

pip install sgl-kernel --upgrade

选项 C: Q8 Kernels 适用于 Ada 架构显卡(如 RTX 4090、L40S 等)。

git clone https://github.com/KONAKONA666/q8_kernels.git
cd q8_kernels && git submodule init && git submodule update
python setup.py install

💡 提示:

步骤 5: 验证安装#

import lightx2v
print(f"LightX2V 版本: {lightx2v.__version__}")

🪟 Windows 系统环境搭建#

Windows 系统仅支持 Conda 环境搭建方式,请按照以下步骤操作:

🐍 Conda 环境搭建#

步骤 1: 检查 CUDA 版本#

首先确认您的 GPU 驱动和 CUDA 版本:

nvidia-smi

记录输出中的 CUDA Version 信息,后续安装时需要保持版本一致。

步骤 2: 创建 Python 环境#

# 创建新环境(推荐 Python 3.12)
conda create -n lightx2v python=3.12 -y

# 激活环境
conda activate lightx2v

💡 提示: 建议使用 Python 3.10 或更高版本以获得最佳兼容性。

步骤 3: 安装 PyTorch 框架#

方法一:下载官方 wheel 包(推荐)

  1. 访问 PyTorch 官方下载页面

  2. 选择对应版本的 wheel 包,注意匹配以下参数:

    • Python 版本: 与您的环境一致

    • CUDA 版本: 与您的 GPU 驱动匹配

    • 平台: 选择 Windows 版本

示例(Python 3.12 + PyTorch 2.6 + CUDA 12.4):

# 下载并安装 PyTorch
pip install torch-2.6.0+cu124-cp312-cp312-win_amd64.whl

# 安装配套包
pip install torchvision==0.21.0 torchaudio==2.6.0

方法二:使用 pip 直接安装

# CUDA 12.4 版本示例
pip install torch==2.6.0+cu124 torchvision==0.21.0+cu124 torchaudio==2.6.0+cu124 --index-url https://download.pytorch.org/whl/cu124

步骤 4: 克隆项目并安装依赖#

# 克隆项目代码
git clone https://github.com/ModelTC/LightX2V.git
cd LightX2V

# 安装 Windows 专用依赖
pip install -r requirements_win.txt
pip install -v -e .

步骤 5: 安装注意力机制算子#

选项 A: Flash Attention 2

pip install flash-attn==2.7.2.post1

选项 B: SageAttention 2(强烈推荐)

下载源:

# 安装 SageAttention(请根据实际文件名调整)
pip install sageattention-2.1.1+cu126torch2.6.0-cp312-cp312-win_amd64.whl

⚠️ 注意: SageAttention 的 CUDA 版本可以不严格对齐,但 Python 和 PyTorch 版本必须匹配。

步骤 6 (可选): 安装量化算子#

默认使用 Triton kernel 进行量化推理,实现高效且无需安装额外依赖,只需确保已安装 triton-windows 即可。

如需使用其他量化算子,可安装以下选项:

1. 安装 Windows 版 vLLM

vllm-windows releases 下载对应的 wheel 包。

版本匹配要求:

  • Python 版本匹配

  • PyTorch 版本匹配

  • CUDA 版本匹配

# 安装 vLLM(请根据实际文件名调整)
pip install vllm-0.9.1+cu124-cp312-cp312-win_amd64.whl

2. 安装 q8-kernels

对于 RTX 40 系显卡,推荐安装 q8_kernel==0.1.0

git clone https://github.com/KONAKONA666/q8_kernels.git
cd q8_kernels && git submodule init && git submodule update
python setup.py install

对于其他显卡,推荐安装 q8_kernel==0.5.0,请参考 LTX-Video-Q8-Kernels

💡 提示:

步骤 8: 验证安装#

import lightx2v
print(f"LightX2V 版本: {lightx2v.__version__}")

🎯 推理使用#

📥 模型准备#

在开始推理之前,您需要提前下载好模型文件。我们推荐:

  • 下载源: 从 LightX2V 官方 Hugging Face或者其他开源模型库下载模型

  • 存储位置: 建议将模型存储在 SSD 磁盘上以获得更好的读取性能

  • 可用模型: 包括 Wan2.1-I2V、Wan2.1-T2V 等多种模型,支持不同分辨率和功能

📁 配置文件与脚本#

推理会用到的配置文件都在这里,脚本都在这里

需要将下载的模型路径配置到运行脚本中。除了脚本中的输入参数,--config_json 指向的配置文件中也会包含一些必要参数,您可以根据需要自行修改。

🚀 开始推理#

Linux 环境#

# 修改脚本中的路径后运行
bash scripts/wan/run_wan_t2v.sh

Windows 环境#

# 使用 Windows 批处理脚本
scripts\win\run_wan_t2v.bat

Python脚本启动#

from lightx2v import LightX2VPipeline

pipe = LightX2VPipeline(
    model_path="/path/to/Wan2.1-T2V-14B",
    model_cls="wan2.1",
    task="t2v",
)

pipe.create_generator(
    attn_mode="sage_attn2",
    infer_steps=50,
    height=480, # 720
    width=832, # 1280
    num_frames=81,
    guidance_scale=5.0,
    sample_shift=5.0,
)

seed = 42
prompt = "Two anthropomorphic cats in comfy boxing gear and bright gloves fight intensely on a spotlighted stage."
negative_prompt = "镜头晃动,色调艳丽,过曝,静态,细节模糊不清,字幕,风格,作品,画作,画面,静止,整体发灰,最差质量,低质量,JPEG压缩残留,丑陋的,残缺的,多余的手指,画得不好的手部,画得不好的脸部,畸形的,毁容的,形态畸形的肢体,手指融合,静止不动的画面,杂乱的背景,三条腿,背景人很多,倒着走"
save_result_path="/path/to/save_results/output.mp4"

pipe.generate(
    seed=seed,
    prompt=prompt,
    negative_prompt=negative_prompt,
    save_result_path=save_result_path,
)

📞 获取帮助#

如果您在安装或使用过程中遇到问题,请:

  1. GitHub Issues 中搜索相关问题

  2. 提交新的 Issue 描述您的问题


🎉 恭喜! 现在您已经成功搭建了 LightX2V 环境,可以开始享受视频生成的乐趣了!