Skip to content

Commit 0a59f36

Browse files
committed
update help message in readme
1 parent f7b53e5 commit 0a59f36

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

examples/cli/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Options:
3232
-o, --output <string> path to write result image to (default: ./output.png)
3333
-p, --prompt <string> the prompt to render
3434
-n, --negative-prompt <string> the negative prompt (default: "")
35+
--preview-path <string> path to write preview image to (default: ./preview.png)
3536
--upscale-model <string> path to esrgan model.
3637
-t, --threads <int> number of threads to use during computation (default: -1). If threads <= 0, then threads will be set to the number of
3738
CPU physical cores
@@ -48,6 +49,8 @@ Options:
4849
--fps <int> fps (default: 24)
4950
--timestep-shift <int> shift timestep for NitroFusion models (default: 0). recommended N for NitroSD-Realism around 250 and 500 for
5051
NitroSD-Vibrant
52+
--preview-interval <int> interval in denoising steps between consecutive updates of the image preview file (default is 1, meaning updating at
53+
every step)
5154
--cfg-scale <float> unconditional guidance scale: (default: 7.0)
5255
--img-cfg-scale <float> image guidance scale for inpaint or instruct-pix2pix models: (default: same as --cfg-scale)
5356
--guidance <float> distilled guidance scale for models with guidance input (default: 3.5)
@@ -86,6 +89,7 @@ Options:
8689
--chroma-enable-t5-mask enable t5 mask for chroma
8790
--increase-ref-index automatically increase the indices of references images based on the order they are listed (starting with 1).
8891
--disable-auto-resize-ref-image disable auto resize of ref images
92+
--taesd-preview-only prevents usage of taesd for decoding the final image. (for use with --preview tae)
8993
-M, --mode run mode, one of [img_gen, vid_gen, upscale, convert], default: img_gen
9094
--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
9195
type of the weight file
@@ -107,4 +111,5 @@ Options:
107111
--vae-tile-size tile size for vae tiling, format [X]x[Y] (default: 32x32)
108112
--vae-relative-tile-size relative tile size for vae tiling, format [X]x[Y], in fraction of image size if < 1, in number of tiles per dim if >=1
109113
(overrides --vae-tile-size)
114+
--preview preview method. must be one of the following [none, proj, tae, vae] (default is none)
110115
```

0 commit comments

Comments
 (0)