deploy_local_windows.md 4.14 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

gushiqiao's avatar
gushiqiao committed
16
17
18
19
20
#### Software Requirements
- **Operating System**: Windows 10/11
- **Python**: 3.12 or higher version
- **CUDA**: 12.4 or higher version
- **Dependencies**: Refer to LightX2V project's requirements_win.txt
gushiqiao's avatar
gushiqiao committed
21

gushiqiao's avatar
gushiqiao committed
22
## 🎯 Usage Methods
gushiqiao's avatar
gushiqiao committed
23

gushiqiao's avatar
gushiqiao committed
24
### Method 1: Using Batch File Inference
gushiqiao's avatar
gushiqiao committed
25

gushiqiao's avatar
gushiqiao committed
26
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
27

gushiqiao's avatar
gushiqiao committed
28
### Method 2: Using Gradio Web Interface Inference
gushiqiao's avatar
gushiqiao committed
29

gushiqiao's avatar
gushiqiao committed
30
#### Manual Gradio Configuration
gushiqiao's avatar
gushiqiao committed
31

gushiqiao's avatar
gushiqiao committed
32
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
33

gushiqiao's avatar
gushiqiao committed
34
#### One-Click Gradio Startup (Recommended)
gushiqiao's avatar
gushiqiao committed
35

gushiqiao's avatar
gushiqiao committed
36
**📦 Download Software Package**
gushiqiao's avatar
gushiqiao committed
37
38
- [Baidu Cloud](https://pan.baidu.com/s/1ef3hEXyIuO0z6z9MoXe4nQ?pwd=7g4f)
- [Quark Cloud](https://pan.quark.cn/s/36a0cdbde7d9)
gushiqiao's avatar
gushiqiao committed
39

gushiqiao's avatar
gushiqiao committed
40
41
**📁 Directory Structure**
After extraction, ensure the directory structure is as follows:
gushiqiao's avatar
gushiqiao committed
42
43

```
gushiqiao's avatar
gushiqiao committed
44
45
46
47
48
49
50
51
52
53
54
55
56
57
├── 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
└── models/                     # Model storage directory
    ├── 说明.txt                       # Model documentation
    ├── Wan2.1-I2V-14B-480P-Lightx2v/  # Image-to-video model (480P)
    ├── Wan2.1-I2V-14B-720P-Lightx2v/  # Image-to-video model (720P)
    ├── Wan2.1-I2V-14B-480P-StepDistill-CfgDistil-Lightx2v/  # Image-to-video model (4-step distillation, 480P)
    ├── Wan2.1-I2V-14B-720P-StepDistill-CfgDistil-Lightx2v/  # Image-to-video model (4-step distillation, 720P)
    ├── Wan2.1-T2V-1.3B-Lightx2v/      # Text-to-video model (1.3B parameters)
    ├── Wan2.1-T2V-14B-Lightx2v/       # Text-to-video model (14B parameters)
    └── Wan2.1-T2V-14B-StepDistill-CfgDistill-Lightx2v/      # Text-to-video model (4-step distillation)
gushiqiao's avatar
gushiqiao committed
58
59
```

gushiqiao's avatar
gushiqiao committed
60
**📋 Configuration Parameters**
gushiqiao's avatar
gushiqiao committed
61

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

gushiqiao's avatar
gushiqiao committed
64
65
66
```ini
# Task type (i2v: image-to-video, t2v: text-to-video)
task=i2v
gushiqiao's avatar
gushiqiao committed
67

gushiqiao's avatar
gushiqiao committed
68
69
# Interface language (zh: Chinese, en: English)
lang=en
gushiqiao's avatar
gushiqiao committed
70

gushiqiao's avatar
gushiqiao committed
71
72
# Server port
port=8032
gushiqiao's avatar
gushiqiao committed
73

gushiqiao's avatar
gushiqiao committed
74
75
# GPU device ID (0, 1, 2...)
gpu=0
gushiqiao's avatar
gushiqiao committed
76

gushiqiao's avatar
gushiqiao committed
77
78
# Model size (14b: 14B parameter model, 1.3b: 1.3B parameter model)
model_size=14b
gushiqiao's avatar
gushiqiao committed
79

gushiqiao's avatar
gushiqiao committed
80
81
# Model class (wan2.1: standard model, wan2.1_distill: distilled model)
model_cls=wan2.1
gushiqiao's avatar
gushiqiao committed
82
83
```

gushiqiao's avatar
gushiqiao committed
84
**⚠️ Important Note**: If using distilled models (model names containing StepDistill-CfgDistil field), please set `model_cls` to `wan2.1_distill`
gushiqiao's avatar
gushiqiao committed
85

gushiqiao's avatar
gushiqiao committed
86
**🚀 Start Service**
gushiqiao's avatar
gushiqiao committed
87

gushiqiao's avatar
gushiqiao committed
88
89
90
91
92
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
93

gushiqiao's avatar
gushiqiao committed
94
**💡 Usage Suggestion**: After opening the Gradio Web page, it's recommended to check "Auto-configure Inference Options", the system will automatically select appropriate optimization configurations for your machine. When reselecting resolution, you also need to re-check "Auto-configure Inference Options".
gushiqiao's avatar
gushiqiao committed
95

gushiqiao's avatar
gushiqiao committed
96
**⚠️ Important Note**: On first run, the system will automatically extract the environment file `env.zip`, which may take several minutes. Please be patient. Subsequent launches will skip this step. You can also manually extract the `env.zip` file to the current directory to save time on first startup.
gushiqiao's avatar
gushiqiao committed
97

gushiqiao's avatar
gushiqiao committed
98
### Method 3: Using ComfyUI Inference
gushiqiao's avatar
gushiqiao committed
99

gushiqiao's avatar
gushiqiao committed
100
TODO - To be added ComfyUI integration guide