Commit 4f787fc7 authored by helloyongyang's avatar helloyongyang
Browse files

update docs

parent deff1192
...@@ -113,4 +113,42 @@ Double-click to run the `start_lightx2v.bat` file, the script will: ...@@ -113,4 +113,42 @@ Double-click to run the `start_lightx2v.bat` file, the script will:
### Method 3: Using ComfyUI Inference ### Method 3: Using ComfyUI Inference
TODO - To be added ComfyUI integration guide This guide will instruct you on how to download and use the portable version of the Lightx2v-ComfyUI environment, so you can avoid manual environment configuration steps. This is suitable for users who want to quickly start experiencing accelerated video generation with Lightx2v on Windows systems.
## Download the Windows Portable Environment:
- [Baidu Cloud Download](https://pan.baidu.com/s/1FVlicTXjmXJA1tAVvNCrBw?pwd=wfid), extraction code: wfid
The portable environment already packages all Python runtime dependencies, including the code and dependencies for ComfyUI and LightX2V. After downloading, simply extract to use.
After extraction, the directory structure is as follows:
```shell
lightx2v_env
├──📂 ComfyUI # ComfyUI code
├──📂 portable_python312_embed # Standalone Python environment
└── run_nvidia_gpu.bat # Windows startup script (double-click to start)
```
## Start ComfyUI
Directly double-click the run_nvidia_gpu.bat file. The system will open a Command Prompt window and run the program. The first startup may take a while, please be patient. After startup is complete, the browser will automatically open and display the ComfyUI frontend interface.
![i2v example workflow](../../../../assets/figs/portabl_windows/pic1.png)
The plugin used by LightX2V-ComfyUI is [ComfyUI-Lightx2vWrapper](https://github.com/ModelTC/ComfyUI-Lightx2vWrapper). Example workflows can be obtained from this project.
## Tested Graphics Cards (offload mode)
- Tested model: `Wan2.1-I2V-14B-480P`
| GPU Model | Task Type | VRAM Capacity | Actual Max VRAM Usage | Actual Max RAM Usage |
|:-----------|:------------|:--------------|:---------------------|:---------------------|
| 3090Ti | I2V | 24G | 6.1G | 7.1G |
| 3080Ti | I2V | 12G | 6.1G | 7.1G |
| 3060Ti | I2V | 8G | 6.1G | 7.1G |
### Environment Packaging and Usage Reference
- [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
- [Portable-Windows-ComfyUI-Docs](https://docs.comfy.org/zh-CN/installation/comfyui_portable_windows#portable-%E5%8F%8A%E8%87%AA%E9%83%A8%E7%BD%B2)
# Lightx2v-ComfyUI便携环境(Windows)
此说明将指导您如何下载与使用便携版的Lightx2v-ComfyUI环境,如此可以免去手动配置环境的步骤,适用于想要在Windows系统下快速开始体验使用Lightx2v加速视频生成的用户。
## 下载Windows便携环境:
- [百度网盘下载](https://pan.baidu.com/s/1FVlicTXjmXJA1tAVvNCrBw?pwd=wfid),提取码:wfid
便携环境中已经打包了所有Python运行相关的依赖,也包括ComfyUI和LightX2V的代码及其相关依赖,下载后解压即可使用。
解压后对应的文件目录说明如下:
```shell
lightx2v_env
├──📂 ComfyUI # ComfyUI代码
├──📂 portable_python312_embed # 独立的Python环境
└── run_nvidia_gpu.bat # Windows启动脚本(双击启动)
```
## 启动ComfyUI
直接双击run_nvidia_gpu.bat文件,系统会打开一个Command Prompt窗口并运行程序,一般第一次启动时间会比较久,请耐心等待,启动完成后会自动打开浏览器并出现ComfyUI的前端界面。
![i2v示例工作流](../../../../assets/figs/portabl_windows/pic1.png)
LightX2V-ComfyUI的插件使用的是,[ComfyUI-Lightx2vWrapper](https://github.com/ModelTC/ComfyUI-Lightx2vWrapper),示例工作流可以从此项目中获取。
## 已测试显卡(offload模式)
- 测试模型`Wan2.1-I2V-14B-480P`
| 显卡型号 | 任务类型 | 显存容量 | 实际最大显存占用 | 实际最大内存占用 |
|:----------|:-----------|:-----------|:-------- |:---------- |
| 3090Ti | I2V | 24G | 6.1G | 7.1G |
| 3080Ti | I2V | 12G | 6.1G | 7.1G |
| 3060Ti | I2V | 8G | 6.1G | 7.1G |
### 环境打包和使用参考
- [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
- [Portable-Windows-ComfyUI-Docs](https://docs.comfy.org/zh-CN/installation/comfyui_portable_windows#portable-%E5%8F%8A%E8%87%AA%E9%83%A8%E7%BD%B2)
\ No newline at end of file
...@@ -89,6 +89,45 @@ model_cls=wan2.1 ...@@ -89,6 +89,45 @@ model_cls=wan2.1
**⚠️ 重要提示**: 首次运行时会自动解压环境文件 `env.zip`,此过程需要几分钟时间,请耐心等待。后续启动无需重复此步骤。您也可以手动解压 `env.zip` 文件到当前目录以节省首次启动时间。 **⚠️ 重要提示**: 首次运行时会自动解压环境文件 `env.zip`,此过程需要几分钟时间,请耐心等待。后续启动无需重复此步骤。您也可以手动解压 `env.zip` 文件到当前目录以节省首次启动时间。
### 方式三:使用ComfyUI推理 ### 方式三:使用ComfyUI推理
TODO - 待补充ComfyUI集成指南 此说明将指导您如何下载与使用便携版的Lightx2v-ComfyUI环境,如此可以免去手动配置环境的步骤,适用于想要在Windows系统下快速开始体验使用Lightx2v加速视频生成的用户。
## 下载Windows便携环境:
- [百度网盘下载](https://pan.baidu.com/s/1FVlicTXjmXJA1tAVvNCrBw?pwd=wfid),提取码:wfid
便携环境中已经打包了所有Python运行相关的依赖,也包括ComfyUI和LightX2V的代码及其相关依赖,下载后解压即可使用。
解压后对应的文件目录说明如下:
```shell
lightx2v_env
├──📂 ComfyUI # ComfyUI代码
├──📂 portable_python312_embed # 独立的Python环境
└── run_nvidia_gpu.bat # Windows启动脚本(双击启动)
```
## 启动ComfyUI
直接双击run_nvidia_gpu.bat文件,系统会打开一个Command Prompt窗口并运行程序,一般第一次启动时间会比较久,请耐心等待,启动完成后会自动打开浏览器并出现ComfyUI的前端界面。
![i2v示例工作流](../../../../assets/figs/portabl_windows/pic1.png)
LightX2V-ComfyUI的插件使用的是,[ComfyUI-Lightx2vWrapper](https://github.com/ModelTC/ComfyUI-Lightx2vWrapper),示例工作流可以从此项目中获取。
## 已测试显卡(offload模式)
- 测试模型`Wan2.1-I2V-14B-480P`
| 显卡型号 | 任务类型 | 显存容量 | 实际最大显存占用 | 实际最大内存占用 |
|:----------|:-----------|:-----------|:-------- |:---------- |
| 3090Ti | I2V | 24G | 6.1G | 7.1G |
| 3080Ti | I2V | 12G | 6.1G | 7.1G |
| 3060Ti | I2V | 8G | 6.1G | 7.1G |
### 环境打包和使用参考
- [ComfyUI](https://github.com/comfyanonymous/ComfyUI)
- [Portable-Windows-ComfyUI-Docs](https://docs.comfy.org/zh-CN/installation/comfyui_portable_windows#portable-%E5%8F%8A%E8%87%AA%E9%83%A8%E7%BD%B2)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment