"tools/convert/vscode:/vscode.git/clone" did not exist on "e106ff67250c599aa3b24f0ba40315f83cf99d8b"
deploy_local_windows.md 5.17 KB
Newer Older
gushiqiao's avatar
gushiqiao committed
1
# Windows Local Deployment Guide
helloyongyang's avatar
helloyongyang committed
2

gushiqiao's avatar
gushiqiao committed
3
## 📖 Overview
gushiqiao's avatar
gushiqiao committed
4

gushiqiao's avatar
gushiqiao committed
5
This document provides detailed instructions for deploying LightX2V locally on Windows environments, including batch file inference, Gradio Web interface inference, and other usage methods.
gushiqiao's avatar
gushiqiao committed
6

gushiqiao's avatar
gushiqiao committed
7
## 🚀 Quick Start
gushiqiao's avatar
gushiqiao committed
8

gushiqiao's avatar
gushiqiao committed
9
### Environment Requirements
gushiqiao's avatar
gushiqiao committed
10

gushiqiao's avatar
gushiqiao committed
11
12
13
14
#### Hardware Requirements
- **GPU**: NVIDIA GPU, recommended 8GB+ VRAM
- **Memory**: Recommended 16GB+ RAM
- **Storage**: Strongly recommended to use SSD solid-state drives, mechanical hard drives will cause slow model loading
gushiqiao's avatar
gushiqiao committed
15
16


gushiqiao's avatar
gushiqiao committed
17
## 🎯 Usage Methods
gushiqiao's avatar
gushiqiao committed
18

gushiqiao's avatar
gushiqiao committed
19
### Method 1: Using Batch File Inference
gushiqiao's avatar
gushiqiao committed
20

gushiqiao's avatar
gushiqiao committed
21
Refer to [Quick Start Guide](../getting_started/quickstart.md) to install environment, and use [batch files](https://github.com/ModelTC/LightX2V/tree/main/scripts/win) to run.
gushiqiao's avatar
gushiqiao committed
22

gushiqiao's avatar
gushiqiao committed
23
### Method 2: Using Gradio Web Interface Inference
gushiqiao's avatar
gushiqiao committed
24

gushiqiao's avatar
gushiqiao committed
25
#### Manual Gradio Configuration
gushiqiao's avatar
gushiqiao committed
26

gushiqiao's avatar
gushiqiao committed
27
Refer to [Quick Start Guide](../getting_started/quickstart.md) to install environment, refer to [Gradio Deployment Guide](./deploy_gradio.md)
gushiqiao's avatar
gushiqiao committed
28

gushiqiao's avatar
gushiqiao committed
29
#### One-Click Gradio Startup (Recommended)
gushiqiao's avatar
gushiqiao committed
30

gushiqiao's avatar
gushiqiao committed
31
**📦 Download Software Package**
Gu Shiqiao's avatar
Gu Shiqiao committed
32
- [Quark Cloud](https://pan.quark.cn/s/8af1162d7a15)
gushiqiao's avatar
gushiqiao committed
33

gushiqiao's avatar
gushiqiao committed
34
35
**📁 Directory Structure**
After extraction, ensure the directory structure is as follows:
gushiqiao's avatar
gushiqiao committed
36
37

```
gushiqiao's avatar
gushiqiao committed
38
39
40
41
42
├── env/                        # LightX2V environment directory
├── LightX2V/                   # LightX2V project directory
├── start_lightx2v.bat          # One-click startup script
├── lightx2v_config.txt         # Configuration file
├── LightX2V使用说明.txt         # LightX2V usage instructions
gushiqiao's avatar
gushiqiao committed
43
├── outputs/                    # Generated video save directory
gushiqiao's avatar
gushiqiao committed
44
└── models/                     # Model storage directory
gushiqiao's avatar
gushiqiao committed
45
46
```

gushiqiao's avatar
gushiqiao committed
47
48
**📥 Model Download**:

Gu Shiqiao's avatar
Gu Shiqiao committed
49
Refer to [Model Structure Documentation](./model_structure.md) or [Gradio Deployment Guide](./deploy_gradio.md) to download complete models (including quantized and non-quantized versions) or download only quantized/non-quantized versions.
gushiqiao's avatar
gushiqiao committed
50
51


gushiqiao's avatar
gushiqiao committed
52
**📋 Configuration Parameters**
gushiqiao's avatar
gushiqiao committed
53

gushiqiao's avatar
gushiqiao committed
54
Edit the `lightx2v_config.txt` file and modify the following parameters as needed:
gushiqiao's avatar
gushiqiao committed
55

gushiqiao's avatar
gushiqiao committed
56
```ini
gushiqiao's avatar
gushiqiao committed
57

gushiqiao's avatar
gushiqiao committed
58
59
# Interface language (zh: Chinese, en: English)
lang=en
gushiqiao's avatar
gushiqiao committed
60

gushiqiao's avatar
gushiqiao committed
61
62
# Server port
port=8032
gushiqiao's avatar
gushiqiao committed
63

gushiqiao's avatar
gushiqiao committed
64
65
# GPU device ID (0, 1, 2...)
gpu=0
gushiqiao's avatar
gushiqiao committed
66

Gu Shiqiao's avatar
Gu Shiqiao committed
67
68
# Model path
model_path=models/
gushiqiao's avatar
gushiqiao committed
69
70
```

gushiqiao's avatar
gushiqiao committed
71
**🚀 Start Service**
gushiqiao's avatar
gushiqiao committed
72

gushiqiao's avatar
gushiqiao committed
73
74
75
76
77
Double-click to run the `start_lightx2v.bat` file, the script will:
1. Automatically read configuration file
2. Verify model paths and file integrity
3. Start Gradio Web interface
4. Automatically open browser to access service
gushiqiao's avatar
gushiqiao committed
78
79


gushiqiao's avatar
Fix  
gushiqiao committed
80
![Gradio English Interface](../../../../assets/figs/portabl_windows/pic_gradio_en.png)
gushiqiao's avatar
gushiqiao committed
81
82
83

**⚠️ Important Notes**:
- **Display Issues**: If the webpage opens blank or displays abnormally, please run `pip install --upgrade gradio` to upgrade the Gradio version.
gushiqiao's avatar
gushiqiao committed
84

gushiqiao's avatar
gushiqiao committed
85
### Method 3: Using ComfyUI Inference
gushiqiao's avatar
gushiqiao committed
86

gushiqiao's avatar
Fix  
gushiqiao committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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                 |
Wq-dd's avatar
Wq-dd committed
121
122
123
| 4070Ti Super    | I2V        | 16G         | 6.1G        | 7.1G          |
| 4070    | I2V        | 12G         | 6.1G        | 7.1G          |
| 4060    | I2V        | 8G         | 6.1G        | 7.1G          |
gushiqiao's avatar
Fix  
gushiqiao committed
124
125
126
127

#### 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)