Welcome to dgenerate’s documentation!
This is the library documentation for dgenerate.
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
BatchProcessErrorDgenerateHelpExceptionDgenerateUsageErrorFrameStartOutOfBoundsImageProcessorArgumentErrorImageProcessorNotFoundErrorImageSeedErrorInvalidModelFileErrorInvalidModelUriErrorInvalidSchedulerNameErrorMediaIdentificationErrorModelNotFoundErrorModelUriLoadErrorModuleFileNotFoundErrorNonHFModelDownloadErrorOutOfMemoryErrorPluginArgumentErrorPluginNotFoundErrorRenderLoopConfigErrorUnknownMimetypeErrorUnsupportedPipelineConfigErrorAnimationETAEventAnimationFileFinishedEventAnimationFinishedEventConfigRunnerConfigRunnerPluginConfigRunnerPluginLoaderDataTypeDgenerateArgumentsImageFileSavedEventImageGeneratedEventModelTypePipelineTypePromptRenderLoopRenderLoopConfigStartingAnimationEventStartingAnimationFileEventStartingGenerationStepEventgen_seeds()invoke_dgenerate()invoke_dgenerate_events()main()parse_args()
- dgenerate submodules
- dgenerate.arguments module
- dgenerate.batchprocess module
- dgenerate.renderloop module
- dgenerate.filecache module
- dgenerate.filelock module
- dgenerate.files module
- dgenerate.image module
- dgenerate.image_process module
- dgenerate.invoker module
- dgenerate.mediainput module
- dgenerate.mediaoutput module
- dgenerate.memoize module
- dgenerate.memory module
- dgenerate.messages module
- dgenerate.pipelinewrapper module
- dgenerate.plugin module
- dgenerate.pygments module
- dgenerate.imageprocessors module
- dgenerate.prompt module
- dgenerate.textprocessing module
- dgenerate.types module
- dgenerate.webcache module
Command Line Manual
- Overview
- Windows Install
- Linux or WSL Install
- Basic Usage
- Negative Prompt
- Multiple Prompts
- Image Seed
- Inpainting
- Per Image Seed Resizing
- Animated Output
- Animation Slicing
- Inpainting Animations
- Deterministic Output
- Specifying a specific GPU for CUDA
- Specifying a Scheduler (sampler)
- Specifying a VAE
- VAE Tiling and Slicing
- Specifying a UNet
- Specifying an SDXL Refiner
- Specifying a Stable Cascade Decoder
- Specifying LoRAs
- Specifying Textual Inversions
- Specifying Control Nets
- Specifying Text Encoders
- Utilizing CivitAI links and Other Hosted Models
- Specifying Generation Batch Size
- Image Processors
- Upscaling with Diffusion Upscaler Models
- Sub Commands (image-process)
- Upscaling with chaiNNer Compatible Upscaler Models
- Writing and Running Configs
- Basic config syntax
- Built in template variables and functions
- Directives, and applying templating
- Setting template variables, in depth
- Globbing and path manipulation
- The \print and \echo directive
- The \image_process directive
- The \exec directive
- The \download directive
- The download() template function
- The \exit directive
- Running configs from the command line
- Config argument injection
- Console UI
- Writing Plugins
- File Cache Control