Skip to content

Commit d7f430c

Browse files
committed
docs: update docs and help message
1 parent 141a4b4 commit d7f430c

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Diffusion model(SD,Flux,Wan,...) inference in pure C/C++
88

99
***Note that this project is under active development. \
10-
API and command-line parameters may change frequently.***
10+
API and command-line option may change frequently.***
1111

1212
## Features
1313

@@ -290,9 +290,10 @@ usage: ./bin/sd [arguments]
290290
291291
arguments:
292292
-h, --help show this help message and exit
293-
-M, --mode [MODE] run mode, one of: [img_gen, convert], default: img_gen
293+
-M, --mode [MODE] run mode, one of: [img_gen, vid_gen, convert], default: img_gen
294294
-t, --threads N number of threads to use during computation (default: -1)
295295
If threads <= 0, then threads will be set to the number of CPU physical cores
296+
--offload-to-cpu place the weights in RAM to save VRAM, and automatically load them into VRAM when needed
296297
-m, --model [MODEL] path to full model
297298
--diffusion-model path to the standalone diffusion model
298299
--high-noise-diffusion-model path to the standalone high noise diffusion model
@@ -346,7 +347,7 @@ arguments:
346347
--high-noise-scheduler {discrete, karras, exponential, ays, gits} Denoiser sigma scheduler (default: discrete)
347348
--high-noise-sampling-method {euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm, ddim_trailing, tcd}
348349
(high noise) sampling method (default: "euler_a")
349-
--high-noise-steps STEPS (high noise) number of sample steps (default: 20)
350+
--high-noise-steps STEPS (high noise) number of sample steps (default: -1 = auto)
350351
SLG will be enabled at step int([STEPS]*[START]) and disabled at int([STEPS]*[END])
351352
--strength STRENGTH strength for noising/unnoising (default: 0.75)
352353
--style-ratio STYLE-RATIO strength for keeping input identity (default: 20)
@@ -377,6 +378,9 @@ arguments:
377378
--chroma-t5-mask-pad PAD_SIZE t5 mask pad size of chroma
378379
--video-frames video frames (default: 1)
379380
--fps fps (default: 24)
381+
--moe-boundary BOUNDARY timestep boundary for Wan2.2 MoE model. (default: 0.875)
382+
only enabled if `--high-noise-steps` is set to -1
383+
--flow-shift SHIFT shift value for Flow models like SD3.x or WAN (default: auto)
380384
-v, --verbose print extra info
381385
```
382386

docs/wan.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@
4343

4444
## Examples
4545

46-
Since GitHub does not support AVI files, the file I uploaded was converted from AVI to MP4.
47-
4846
### Wan2.1 T2V 1.3B
4947

5048
```

examples/cli/main.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,10 @@ void print_usage(int argc, const char* argv[]) {
193193
printf("\n");
194194
printf("arguments:\n");
195195
printf(" -h, --help show this help message and exit\n");
196-
printf(" -M, --mode [MODE] run mode, one of: [img_gen, convert], default: img_gen\n");
196+
printf(" -M, --mode [MODE] run mode, one of: [img_gen, vid_gen, convert], default: img_gen\n");
197197
printf(" -t, --threads N number of threads to use during computation (default: -1)\n");
198198
printf(" If threads <= 0, then threads will be set to the number of CPU physical cores\n");
199+
printf(" --offload-to-cpu place the weights in RAM to save VRAM, and automatically load them into VRAM when needed\n");
199200
printf(" -m, --model [MODEL] path to full model\n");
200201
printf(" --diffusion-model path to the standalone diffusion model\n");
201202
printf(" --high-noise-diffusion-model path to the standalone high noise diffusion model\n");

0 commit comments

Comments
 (0)