Struct ConfigBuilder

pub struct ConfigBuilder { /* private fields */ }

Builder for Config.

Implementations

impl ConfigBuilder

pub fn model<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to full model

pub fn diffusion_model<VALUE: Into<CLibPath>>( &mut self, value: VALUE, ) -> &mut Self

Path to the standalone diffusion model

pub fn clip_l<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

path to the clip-l text encoder

pub fn clip_g<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

path to the clip-g text encoder

pub fn t5xxl<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to the t5xxl text encoder

pub fn vae<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to vae

pub fn taesd<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to taesd. Using Tiny AutoEncoder for fast decoding (low quality)

pub fn control_net<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to control net model

pub fn embeddings<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to embeddings

pub fn stacked_id_embd<VALUE: Into<CLibPath>>( &mut self, value: VALUE, ) -> &mut Self

Path to PHOTOMAKER stacked id embeddings

pub fn input_id_images<VALUE: Into<CLibPath>>( &mut self, value: VALUE, ) -> &mut Self

Path to PHOTOMAKER input id images dir

pub fn normalize_input<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Normalize PHOTOMAKER input id images

pub fn upscale_model<VALUE: Into<CLibPath>>( &mut self, value: VALUE, ) -> &mut Self

Path to esrgan model. Upscale images after generate, just RealESRGAN_x4plus_anime_6B supported by now

pub fn upscale_repeats<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

Run the ESRGAN upscaler this many times (default 1)

pub fn weight_type<VALUE: Into<WeightType>>( &mut self, value: VALUE, ) -> &mut Self

Weight type. If not specified, the default is the type of the weight file

pub fn init_img<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to the input image, required by img2img

pub fn control_image<VALUE: Into<CLibPath>>( &mut self, value: VALUE, ) -> &mut Self

Path to image condition, control net

pub fn output<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

Path to write result image to (default: ./output.png)

pub fn prompt<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The prompt to render

pub fn negative_prompt<VALUE: Into<CLibString>>( &mut self, value: VALUE, ) -> &mut Self

The negative prompt (default: “”)

pub fn cfg_scale<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

Unconditional guidance scale (default: 7.0)

pub fn guidance<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

Guidance (default: 3.5)

pub fn strength<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

Strength for noising/unnoising (default: 0.75)

pub fn style_ratio<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

Strength for keeping input identity (default: 20%)

pub fn control_strength<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

Strength to apply Control Net (default: 0.9) 1.0 corresponds to full destruction of information in init

pub fn height<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

Image height, in pixel space (default: 512)

pub fn width<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

Image width, in pixel space (default: 512)

pub fn sampling_method<VALUE: Into<SampleMethod>>( &mut self, value: VALUE, ) -> &mut Self

Sampling-method (default: EULER_A)

pub fn steps<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

Number of sample steps (default: 20)

pub fn rng<VALUE: Into<RngFunction>>(&mut self, value: VALUE) -> &mut Self

RNG (default: CUDA)

pub fn seed<VALUE: Into<i64>>(&mut self, value: VALUE) -> &mut Self

RNG seed (default: 42, use random seed for < 0)

pub fn batch_count<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

Number of images to generate (default: 1)

pub fn schedule<VALUE: Into<Schedule>>(&mut self, value: VALUE) -> &mut Self

Denoiser sigma schedule (default: DEFAULT)

pub fn clip_skip<VALUE: Into<ClipSkip>>(&mut self, value: VALUE) -> &mut Self

Ignore last layers of CLIP network; 1 ignores none, 2 ignores one layer (default: -1) <= 0 represents unspecified, will be 1 for SD1.x, 2 for SD2.x

pub fn vae_tiling<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Process vae in tiles to reduce memory usage (default: false)

pub fn vae_on_cpu<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Keep vae in cpu (for low vram) (default: false)

pub fn clip_on_cpu<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

keep clip in cpu (for low vram) (default: false)

pub fn control_net_cpu<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Keep controlnet in cpu (for low vram) (default: false)

pub fn canny<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Apply canny preprocessor (edge detection) (default: false)

pub fn flash_attenuation<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

Use flash attention in the diffusion model (for low vram). Might lower quality, since it implies converting k and v to f16. This might crash if it is not supported by the backend.

pub fn slg_scale<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

skip layer guidance (SLG) scale, only for DiT models: (default: 0) 0 means disabled, a value of 2.5 is nice for sd3.5 medium

pub fn skip_layer<VALUE: Into<Vec<i32>>>(&mut self, value: VALUE) -> &mut Self

Layers to skip for SLG steps: (default: [7,8,9])

pub fn skip_layer_start<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

SLG enabling point: (default: 0.01)

pub fn skip_layer_end<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

SLG disabling point: (default: 0.2)

pub fn build(&self) -> Result<Config, ConfigBuilderError>

Builds a new Config.

Errors

If a required field has not been initialized.

impl ConfigBuilder

pub fn lora_model(&mut self, lora_model: &Path) -> &mut Self

pub fn n_threads(&mut self, value: i32) -> &mut Self

Trait Implementations

impl Clone for ConfigBuilder

fn clone(&self) -> ConfigBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<PresetConfig> for ConfigBuilder

type Error = ApiError

The type returned in the event of a conversion error.

fn try_from(value: PresetConfig) -> Result<Self, Self::Error>

Performs the conversion.