Welcome to dgenerate’s documentation!

This is the library documentation for dgenerate.

dgenerate is a scriptable command line tool for generating images and animation sequences using stable diffusion and related techniques, with an accompanying UI scripting environment.

For library usage examples see the Library Usage Examples folder under the examples folder in the github repository.

For command line usage documentation see the Command Line Manual or the Examples Folder in the github repository.

Library Documentation

dgenerate module

Diffusion Model Feature Support Table

--model-type torch (SD 1.5 - SD 2.*)

--model-type torch-pix2pix (SD 1.5 - SD 2.* - Pix2Pix)

--model-type torch-sdxl (Stable Diffusion XL)

--model-type torch-if (Deep Floyd Stage 1)

--model-type torch-ifs (Deep Floyd Stage 2)

--model-type torch-if-img2img (Deep Floyd Stage 2 - Img2Img)

--model-type torch-sdxl-pix2pix (Stable Diffusion XL - Pix2Pix)

--model-type torch-upscaler-x2 (Stable Diffusion x2 Upscaler)

--model-type torch-upscaler-x4 (Stable Diffusion x4 Upscaler)

--model-type torch-s-cascade (Stable Cascade)

--model-type torch-sd3 (Stable Diffusion 3)

--model-type torch-flux (Flux.1)

Supported Features by `--model-type`
Model Type	Txt2Img	Img2Img	Inpainting	LoRA	Textual Inversions	ControlNet	T2I Adapter	IP Adapter	sd-embed Prompt Weighting	compel Prompt Weighting
`torch`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
`torch-pix2pix`	❌	✅	❌	✅	✅	❌	❌	✅	✅	✅
`torch-sdxl`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
`torch-if`	✅	✅	✅	❌	❌	❌	❌	❌	❌	❌
`torch-ifs`	❌	✅	✅	❌	❌	❌	❌	❌	❌	❌
`torch-ifs-img2img`	❌	✅	✅	❌	❌	❌	❌	❌	❌	❌
`torch-sdxl-pix2pix`	❌	✅	❌	✅	✅	❌	❌	❌	✅	✅
`torch-upscaler-x2`	❌	✅	❌	❌	❌	❌	❌	❌	❌	❌
`torch-upscaler-x4`	❌	✅	❌	❌	✅	❌	❌	❌	✅	✅
`torch-s-cascade`	✅	✅	❌	❌	❌	❌	❌	❌	✅	✅
`torch-sd3`	✅	✅	✅	✅	❌	✅	❌	❌	✅	❌
`torch-flux`	✅	❌	❌	✅	❌	❌	❌	❌	✅	❌

Command Line Manual

Indices and tables