Struct ModelConfigBuilder 

pub struct ModelConfigBuilder { /* private fields */ }

Builder for ModelConfig.

Implementations

impl ModelConfigBuilder

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

Place the weights in RAM to save VRAM, and automatically load them into VRAM when needed

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 upscale_tile_size<VALUE: Into<i32>>(&mut self, value: VALUE) -> &mut Self

Tile size for ESRGAN upscaler (default 128)

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 llm<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to the qwen2vl text encoder

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

Path to the qwen2vl vit

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 clip_vision<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to the clip-vision 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 photo_maker<VALUE: Into<CLibPath>>(&mut self, value: VALUE) -> &mut Self

Path to PHOTOMAKER model

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

Path to PHOTOMAKER v2 id embed

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 high_noise_diffusion_model<VALUE: Into<CLibPath>>( &mut self, value: VALUE, ) -> &mut Self

Path to the standalone high noise diffusion model

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_tile_size<VALUE: Into<(i32, i32)>>( &mut self, value: VALUE, ) -> &mut Self

Tile size for vae tiling (default: 32x32)

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

Relative tile size for vae tiling, in fraction of image size if < 1, in number of tiles per dim if >=1 (overrides vae_tile_size)

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

Tile overlap for vae tiling, in fraction of tile size (default: 0.5)

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

RNG (default: CUDA)

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

Sampler RNG. If RngFunction::RNG_TYPE_COUNT is used will default to rng value. (default: RngFunction::RNG_TYPE_COUNT)“,

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

Denoiser sigma schedule (default: Scheduler::SCHEDULER_COUNT). Will default to Scheduler::EXPONENTIAL_SCHEDULER if a denoiser is already instantiated. Otherwise, Scheduler::DISCRETE_SCHEDULER is used.

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

Prediction type override (default: PREDICTION_COUNT)

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 flash_attention<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Use flash attention to reduce memory usage (for low vram).

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

Disable dit mask for chroma

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

Enable t5 mask for chroma

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

t5 mask pad size of chroma

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

Use Conv2d direct in the diffusion model This might crash if it is not supported by the backend.

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

Use Conv2d direct in the vae model (should improve the performance) This might crash if it is not supported by the backend.

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

Force use of conv scale on sdxl vae

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

Shift value for Flow models like SD3.x or WAN (default: auto)

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

Shift timestep for NitroFusion models, default: 0, recommended N for NitroSD-Realism around 250 and 500 for NitroSD-Vibrant

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

Prevents usage of taesd for decoding the final image

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

In auto mode, if the model weights contain any quantized parameters, the at_runtime mode will be used; otherwise, immediately will be used.The immediately mode may have precision and compatibility issues with quantized parameters, but it usually offers faster inference speed and, in some cases, lower memory usage. The at_runtime mode, on the other hand, is exactly the opposite

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

Enable easycache to achieve speedup (default: false)

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

Easycache reuse threashold (default: 0.2)

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

Easycache start percent (default: 0.15)

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

Easycache end percent (default: 0.95)

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

Builds a new ModelConfig.

Errors

If a required field has not been initialized.

impl ModelConfigBuilder

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

pub fn lora_models( &mut self, lora_model_dir: &Path, specs: Vec<LoraSpec>, ) -> &mut Self

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

Trait Implementations

impl Clone for ModelConfigBuilder

fn clone(&self) -> ModelConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ModelConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<ModelConfig> for ModelConfigBuilder

fn from(value: ModelConfig) -> Self

Converts to this type from the input type.