Skip to content

Commit aaa8a51

Browse files
committed
docs: update sd-cli/sd-server docs
1 parent ba35dd7 commit aaa8a51

2 files changed

Lines changed: 28 additions & 21 deletions

File tree

examples/cli/README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44
usage: ./bin/sd-cli [options]
55
66
CLI Options:
7-
-o, --output <string> path to write result image to. you can use printf-style %d format specifiers for image sequences (default: ./output.png) (eg. output_%03d.png)
8-
--output-begin-idx <int> starting index for output image sequence, must be non-negative (default 0 if specified %d in output path, 1 otherwise)
7+
-o, --output <string> path to write result image to. you can use printf-style %d format specifiers for image sequences (default:
8+
./output.png) (eg. output_%03d.png)
99
--preview-path <string> path to write preview image to (default: ./preview.png)
1010
--preview-interval <int> interval in denoising steps between consecutive updates of the image preview file (default is 1, meaning updating at
1111
every step)
12+
--output-begin-idx <int> starting index for output image sequence, must be non-negative (default 0 if specified %d in output path, 1 otherwise)
1213
--canny apply canny preprocessor (edge detection)
1314
--convert-name convert tensor name (for convert mode)
1415
-v, --verbose print extra info
@@ -59,6 +60,7 @@ Context Options:
5960
--circularx enable circular RoPE wrapping on x-axis (width) only
6061
--circulary enable circular RoPE wrapping on y-axis (height) only
6162
--chroma-disable-dit-mask disable dit mask for chroma
63+
--qwen-image-zero-cond-t enable zero_cond_t for qwen image
6264
--chroma-enable-t5-mask enable t5 mask for chroma
6365
--type weight type (examples: f32, f16, q4_0, q4_1, q5_0, q5_1, q8_0, q2_K, q3_K, q4_K). If not specified, the default is the
6466
type of the weight file
@@ -107,15 +109,15 @@ Generation Options:
107109
medium
108110
--skip-layer-start <float> SLG enabling point (default: 0.01)
109111
--skip-layer-end <float> SLG disabling point (default: 0.2)
110-
--eta <float> eta in DDIM, only for DDIM/TCD/res_multistep/res_2s (default: 0)
112+
--eta <float> eta in DDIM, only for DDIM and TCD (default: 0)
111113
--flow-shift <float> shift value for Flow models like SD3.x or WAN (default: auto)
112114
--high-noise-cfg-scale <float> (high noise) unconditional guidance scale: (default: 7.0)
113115
--high-noise-img-cfg-scale <float> (high noise) image guidance scale for inpaint or instruct-pix2pix models (default: same as --cfg-scale)
114116
--high-noise-guidance <float> (high noise) distilled guidance scale for models with guidance input (default: 3.5)
115117
--high-noise-slg-scale <float> (high noise) skip layer guidance (SLG) scale, only for DiT models: (default: 0)
116118
--high-noise-skip-layer-start <float> (high noise) SLG enabling point (default: 0.01)
117119
--high-noise-skip-layer-end <float> (high noise) SLG disabling point (default: 0.2)
118-
--high-noise-eta <float> (high noise) eta in DDIM, only for DDIM/TCD/res_multistep/res_2s (default: 0)
120+
--high-noise-eta <float> (high noise) eta in DDIM, only for DDIM and TCD (default: 0)
119121
--strength <float> strength for noising/unnoising (default: 0.75)
120122
--pm-style-strength <float>
121123
--control-strength <float> strength to apply Control Net (default: 0.9). 1.0 corresponds to full destruction of information in init image
@@ -124,10 +126,12 @@ Generation Options:
124126
--increase-ref-index automatically increase the indices of references images based on the order they are listed (starting with 1).
125127
--disable-auto-resize-ref-image disable auto resize of ref images
126128
-s, --seed RNG seed (default: 42, use random seed for < 0)
127-
--sampling-method sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm, ddim_trailing, tcd,
128-
res_multistep, res_2s] (default: euler for Flux/SD3/Wan, euler_a otherwise)
129-
--high-noise-sampling-method (high noise) sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm, ddim_trailing,
130-
tcd, res_multistep, res_2s] default: euler for Flux/SD3/Wan, euler_a otherwise
129+
--sampling-method sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm, ddim_trailing,
130+
tcd, res_multistep, res_2s] (default: euler for Flux/SD3/Wan, euler_a
131+
otherwise)
132+
--high-noise-sampling-method (high noise) sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm,
133+
ddim_trailing, tcd, res_multistep, res_2s] default: euler for Flux/SD3/Wan,
134+
euler_a otherwise
131135
--scheduler denoiser sigma scheduler, one of [discrete, karras, exponential, ays, gits, smoothstep, sgm_uniform, simple,
132136
kl_optimal, lcm, bong_tangent], default: discrete
133137
--sigmas custom sigma values for the sampler, comma-separated (e.g., "14.61,7.8,3.5,0.0").

examples/server/README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
usage: ./bin/sd-server [options]
55
66
Svr Options:
7-
-l, --listen-ip <string> server listen ip (default: 127.0.0.1)
8-
--listen-port <int> server listen port (default: 1234)
9-
--serve-html-path <string> path to HTML file to serve at root (optional)
10-
-v, --verbose print extra info
11-
--color colors the logging tags according to level
12-
-h, --help show this help message and exit
7+
-l, --listen-ip <string> server listen ip (default: 127.0.0.1)
8+
--serve-html-path <string> path to HTML file to serve at root (optional)
9+
--listen-port <int> server listen port (default: 1234)
10+
-v, --verbose print extra info
11+
--color colors the logging tags according to level
12+
-h, --help show this help message and exit
1313
1414
Context Options:
1515
-m, --model <string> path to full model
@@ -39,10 +39,10 @@ Context Options:
3939
--vae-tiling process vae in tiles to reduce memory usage
4040
--force-sdxl-vae-conv-scale force use of conv scale on sdxl vae
4141
--offload-to-cpu place the weights in RAM to save VRAM, and automatically load them into VRAM when needed
42+
--mmap whether to memory-map model
4243
--control-net-cpu keep controlnet in cpu (for low vram)
4344
--clip-on-cpu keep clip in cpu (for low vram)
4445
--vae-on-cpu keep vae in cpu (for low vram)
45-
--mmap whether to memory-map model
4646
--fa use flash attention
4747
--diffusion-fa use flash attention in the diffusion model only
4848
--diffusion-conv-direct use ggml_conv2d_direct in the diffusion model
@@ -51,6 +51,7 @@ Context Options:
5151
--circularx enable circular RoPE wrapping on x-axis (width) only
5252
--circulary enable circular RoPE wrapping on y-axis (height) only
5353
--chroma-disable-dit-mask disable dit mask for chroma
54+
--qwen-image-zero-cond-t enable zero_cond_t for qwen image
5455
--chroma-enable-t5-mask enable t5 mask for chroma
5556
--type weight type (examples: f32, f16, q4_0, q4_1, q5_0, q5_1, q8_0, q2_K, q3_K, q4_K). If not specified, the default is the
5657
type of the weight file
@@ -99,15 +100,15 @@ Default Generation Options:
99100
medium
100101
--skip-layer-start <float> SLG enabling point (default: 0.01)
101102
--skip-layer-end <float> SLG disabling point (default: 0.2)
102-
--eta <float> eta in DDIM, only for DDIM/TCD/res_multistep/res_2s (default: 0)
103+
--eta <float> eta in DDIM, only for DDIM and TCD (default: 0)
103104
--flow-shift <float> shift value for Flow models like SD3.x or WAN (default: auto)
104105
--high-noise-cfg-scale <float> (high noise) unconditional guidance scale: (default: 7.0)
105106
--high-noise-img-cfg-scale <float> (high noise) image guidance scale for inpaint or instruct-pix2pix models (default: same as --cfg-scale)
106107
--high-noise-guidance <float> (high noise) distilled guidance scale for models with guidance input (default: 3.5)
107108
--high-noise-slg-scale <float> (high noise) skip layer guidance (SLG) scale, only for DiT models: (default: 0)
108109
--high-noise-skip-layer-start <float> (high noise) SLG enabling point (default: 0.01)
109110
--high-noise-skip-layer-end <float> (high noise) SLG disabling point (default: 0.2)
110-
--high-noise-eta <float> (high noise) eta in DDIM, only for DDIM/TCD/res_multistep/res_2s (default: 0)
111+
--high-noise-eta <float> (high noise) eta in DDIM, only for DDIM and TCD (default: 0)
111112
--strength <float> strength for noising/unnoising (default: 0.75)
112113
--pm-style-strength <float>
113114
--control-strength <float> strength to apply Control Net (default: 0.9). 1.0 corresponds to full destruction of information in init image
@@ -116,10 +117,12 @@ Default Generation Options:
116117
--increase-ref-index automatically increase the indices of references images based on the order they are listed (starting with 1).
117118
--disable-auto-resize-ref-image disable auto resize of ref images
118119
-s, --seed RNG seed (default: 42, use random seed for < 0)
119-
--sampling-method sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm, ddim_trailing, tcd,
120-
res_multistep, res_2s] (default: euler for Flux/SD3/Wan, euler_a otherwise)
121-
--high-noise-sampling-method (high noise) sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm, ddim_trailing,
122-
tcd, res_multistep, res_2s] default: euler for Flux/SD3/Wan, euler_a otherwise
120+
--sampling-method sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm, ddim_trailing,
121+
tcd, res_multistep, res_2s] (default: euler for Flux/SD3/Wan, euler_a
122+
otherwise)
123+
--high-noise-sampling-method (high noise) sampling method, one of [euler, euler_a, heun, dpm2, dpm++2s_a, dpm++2m, dpm++2mv2, ipndm, ipndm_v, lcm,
124+
ddim_trailing, tcd, res_multistep, res_2s] default: euler for Flux/SD3/Wan,
125+
euler_a otherwise
123126
--scheduler denoiser sigma scheduler, one of [discrete, karras, exponential, ays, gits, smoothstep, sgm_uniform, simple,
124127
kl_optimal, lcm, bong_tangent], default: discrete
125128
--sigmas custom sigma values for the sampler, comma-separated (e.g., "14.61,7.8,3.5,0.0").

0 commit comments

Comments
 (0)