fix(docs): update tile parameters in user guide
This commit is contained in:
parent
11c0ab9882
commit
a6cb630206
|
@ -41,6 +41,8 @@ $defs:
|
||||||
type: object
|
type: object
|
||||||
required: [name, source, type]
|
required: [name, source, type]
|
||||||
properties:
|
properties:
|
||||||
|
format:
|
||||||
|
$ref: "#/$defs/tensor_format"
|
||||||
label:
|
label:
|
||||||
type: string
|
type: string
|
||||||
model:
|
model:
|
||||||
|
|
|
@ -55,11 +55,13 @@ Please see [the server admin guide](server-admin.md) for details on how to confi
|
||||||
- [Seed parameter](#seed-parameter)
|
- [Seed parameter](#seed-parameter)
|
||||||
- [Batch size parameter](#batch-size-parameter)
|
- [Batch size parameter](#batch-size-parameter)
|
||||||
- [Tile size parameter](#tile-size-parameter)
|
- [Tile size parameter](#tile-size-parameter)
|
||||||
- [Overlap parameter](#overlap-parameter)
|
- [UNet overlap parameter](#unet-overlap-parameter)
|
||||||
- [25% overlap](#25-overlap)
|
- [25% overlap](#25-overlap)
|
||||||
- [50% overlap](#50-overlap)
|
- [50% overlap](#50-overlap)
|
||||||
- [UNet stride parameter](#unet-stride-parameter)
|
- [UNet tile size parameter](#unet-tile-size-parameter)
|
||||||
- [Tiled VAE parameter](#tiled-vae-parameter)
|
- [Tiled VAE parameter](#tiled-vae-parameter)
|
||||||
|
- [VAE overlap parameter](#vae-overlap-parameter)
|
||||||
|
- [VAE tile size parameter](#vae-tile-size-parameter)
|
||||||
- [Prompt parameter](#prompt-parameter)
|
- [Prompt parameter](#prompt-parameter)
|
||||||
- [Negative prompt parameter](#negative-prompt-parameter)
|
- [Negative prompt parameter](#negative-prompt-parameter)
|
||||||
- [Width and height parameters](#width-and-height-parameters)
|
- [Width and height parameters](#width-and-height-parameters)
|
||||||
|
@ -652,7 +654,7 @@ The size of each UNet tile when running [the panorama pipeline](#panorama-pipeli
|
||||||
Increasing this is a lot like increasing the image size. It will produce larger areas with consistent shapes and
|
Increasing this is a lot like increasing the image size. It will produce larger areas with consistent shapes and
|
||||||
outlines, but will increase memory. Decreasing this too far can produce deep-fried results.
|
outlines, but will increase memory. Decreasing this too far can produce deep-fried results.
|
||||||
|
|
||||||
#### Overlap parameter
|
#### UNet overlap parameter
|
||||||
|
|
||||||
The amount that each highres and VAE tile should overlap.
|
The amount that each highres and VAE tile should overlap.
|
||||||
|
|
||||||
|
@ -660,7 +662,7 @@ Increasing this will increase the number of tiles and will take longer, but will
|
||||||
between tiles. Increasing this too far will cause blurry images.
|
between tiles. Increasing this too far will cause blurry images.
|
||||||
|
|
||||||
- 0.25 is usually good for [highres](#highres-parameters)
|
- 0.25 is usually good for [highres](#highres-parameters)
|
||||||
- 0.5 is usually good for [panorama](#panorama-pipeline)
|
- 0.75 is usually good for [panorama](#panorama-pipeline)
|
||||||
|
|
||||||
_Note:_ The highres and VAE overlap parameters may be split up in the future.
|
_Note:_ The highres and VAE overlap parameters may be split up in the future.
|
||||||
|
|
||||||
|
@ -690,11 +692,12 @@ After cropping:
|
||||||
|
|
||||||
Tiles evenly fill the image and do not need to be cropped.
|
Tiles evenly fill the image and do not need to be cropped.
|
||||||
|
|
||||||
#### UNet stride parameter
|
#### UNet tile size parameter
|
||||||
|
|
||||||
The stride between UNet tiles when running [the panorama pipeline](#panorama-pipeline).
|
The size of each UNet tile when running tiled pipelines, which happens when the image dimensions are larger than
|
||||||
|
the UNet tile size or you are using [the panorama pipeline](#panorama-pipeline).
|
||||||
|
|
||||||
This behaves a lot like [the overlap parameter](#overlap-parameter) but only applies to the UNet when using [the
|
This behaves a lot like [the overlap parameter](#unet-overlap-parameter) but only applies to the UNet when using [the
|
||||||
panorama pipeline](#panorama-pipeline).
|
panorama pipeline](#panorama-pipeline).
|
||||||
|
|
||||||
_Note:_ This parameter may be combined with the overlap parameter in the future.
|
_Note:_ This parameter may be combined with the overlap parameter in the future.
|
||||||
|
@ -703,8 +706,21 @@ _Note:_ This parameter may be combined with the overlap parameter in the future.
|
||||||
|
|
||||||
Whether or not to use the tiled VAE.
|
Whether or not to use the tiled VAE.
|
||||||
|
|
||||||
The tiled VAE uses less memory and allows you to generate larger images, but may produce seams without enough
|
The tiled VAE uses less memory and allows you to generate larger images, but may produce seams without
|
||||||
[overlap](#overlap-parameter).
|
[enough overlap](#vae-overlap-parameter).
|
||||||
|
|
||||||
|
#### VAE overlap parameter
|
||||||
|
|
||||||
|
Much like the [UNet overlap parameter](#unet-overlap-parameter) but for the tiled VAE.
|
||||||
|
|
||||||
|
0.25 seems to work well for most things.
|
||||||
|
|
||||||
|
#### VAE tile size parameter
|
||||||
|
|
||||||
|
Much like the [UNet tile size parameter](#unet-tile-size-parameter) but for the tiled VAE.
|
||||||
|
|
||||||
|
Making this smaller will reduce memory usage when decoding and during highres, which can be useful when running highres
|
||||||
|
or SDXL on GPUs with limited memory.
|
||||||
|
|
||||||
#### Prompt parameter
|
#### Prompt parameter
|
||||||
|
|
||||||
|
@ -1241,6 +1257,7 @@ some common configurations in a server context.
|
||||||
- pt
|
- pt
|
||||||
- pth
|
- pth
|
||||||
- safetensors
|
- safetensors
|
||||||
|
- zip
|
||||||
- hash
|
- hash
|
||||||
- string
|
- string
|
||||||
- image_size
|
- image_size
|
||||||
|
@ -1269,6 +1286,7 @@ some common configurations in a server context.
|
||||||
- string
|
- string
|
||||||
- pipeline
|
- pipeline
|
||||||
- one of:
|
- one of:
|
||||||
|
- archive
|
||||||
- controlnet
|
- controlnet
|
||||||
- img2img
|
- img2img
|
||||||
- inpaint
|
- inpaint
|
||||||
|
@ -1276,6 +1294,7 @@ some common configurations in a server context.
|
||||||
- panorama
|
- panorama
|
||||||
- pix2pix
|
- pix2pix
|
||||||
- txt2img
|
- txt2img
|
||||||
|
- txt2img-sdxl
|
||||||
- upscaling
|
- upscaling
|
||||||
- source
|
- source
|
||||||
- string
|
- string
|
||||||
|
@ -1323,9 +1342,7 @@ some common configurations in a server context.
|
||||||
- array of additional networks
|
- array of additional networks
|
||||||
- each one has:
|
- each one has:
|
||||||
- format
|
- format
|
||||||
- one of:
|
- same formats as diffusion models
|
||||||
- ckpt
|
|
||||||
- safetensors
|
|
||||||
- model
|
- model
|
||||||
- one of:
|
- one of:
|
||||||
- concept
|
- concept
|
||||||
|
@ -1347,6 +1364,8 @@ some common configurations in a server context.
|
||||||
- array of sources
|
- array of sources
|
||||||
- strings
|
- strings
|
||||||
- additional translation strings
|
- additional translation strings
|
||||||
|
- two-letter language code
|
||||||
|
- each one is an object of strings
|
||||||
|
|
||||||
## Environment variables
|
## Environment variables
|
||||||
|
|
||||||
|
@ -1395,6 +1414,8 @@ The following environment variables are available:
|
||||||
- `ONNX_WEB_MEMORY_LIMIT`
|
- `ONNX_WEB_MEMORY_LIMIT`
|
||||||
- VRAM usage limit for CUDA devices. Defaults to none, which is no limit.
|
- VRAM usage limit for CUDA devices. Defaults to none, which is no limit.
|
||||||
|
|
||||||
|
Please see [the server admin guide](./server-admin.md#configuration) for the complete list of available variables.
|
||||||
|
|
||||||
## Known errors
|
## Known errors
|
||||||
|
|
||||||
This section attempts to cover all of the known errors and their solutions.
|
This section attempts to cover all of the known errors and their solutions.
|
||||||
|
|
Loading…
Reference in New Issue