Skip to main content
Module

x/stable_diffusion_client/mod.ts>SDModels.Options

stable-diffusion-webui Client writen in Deno
interface SDModels.Options
import { type SDModels } from "https://deno.land/x/stable_diffusion_client@0.0.2/mod.ts";
const { Options } = SDModels;

Options

Properties

optional
samples_save: boolean

Samples Save Always save all generated images default Value true

optional
samples_format: string

Samples Format File format for images default Value "png"

optional
samples_filename_pattern: string

Samples Filename Pattern Images filename pattern default Value ""

optional
save_images_add_number: boolean

Save Images Add Number Add number to filename when saving default Value true

optional
grid_save: boolean

Grid Save Always save all generated image grids default Value true

optional
grid_format: string

Grid Format File format for grids default Value "png"

optional
grid_extended_filename: boolean

Grid Extended Filename Add extended info (seed, prompt) to filename when saving grid default Value false

optional
grid_only_if_multiple: boolean

Grid Only If Multiple Do not save grids consisting of one picture default Value true

optional
grid_prevent_empty_spots: boolean

Grid Prevent Empty Spots Prevent empty spots in grid (when set to autodetect) default Value false

optional
n_rows: number

N Rows Grid row count; use -1 for autodetect and 0 for it to be same as batch size default Value -1

optional
enable_pnginfo: boolean

Enable Pnginfo Save text information about generation parameters as chunks to png files default Value true

optional
save_txt: boolean

Save Txt Create a text file next to every image with generation parameters. default Value false

optional
save_images_before_face_restoration: boolean

Save Images Before Face Restoration Save a copy of image before doing face restoration. default Value false

optional
save_images_before_highres_fix: boolean

Save Images Before Highres Fix Save a copy of image before applying highres fix. default Value false

optional
save_images_before_color_correction: boolean

Save Images Before Color Correction Save a copy of image before applying color correction to img2img results default Value false

optional
jpeg_quality: number

Jpeg Quality Quality for saved jpeg images default Value 80

optional
export_for_4chan: boolean

Export For 4Chan If PNG image is larger than 4MB or any dimension is larger than 4000, downscale and save copy as JPG default Value true

optional
use_original_name_batch: boolean

Use Original Name Batch Use original name for output filename during batch process in extras tab default Value false

optional
save_selected_only: boolean

Save Selected Only When using 'Save' button, only save a single selected image default Value true

optional
do_not_add_watermark: boolean

Do Not Add Watermark Do not add watermark to images default Value false

optional
temp_dir: string

Temp Dir Directory for temporary images; leave empty for default default Value ""

optional
clean_temp_dir_at_start: boolean

Clean Temp Dir At Start Cleanup non-default temporary directory when starting webui default Value false

optional
outdir_samples: string

Outdir Samples Output directory for images; if empty, defaults to three directories below default Value ""

optional
outdir_txt2img_samples: string

Outdir Txt2Img Samples Output directory for txt2img images default Value "outputs/txt2img-images"

optional
outdir_img2img_samples: string

Outdir Img2Img Samples Output directory for img2img images default Value "outputs/img2img-images"

optional
outdir_extras_samples: string

Outdir Extras Samples Output directory for images from extras tab default Value "outputs/extras-images"

optional
outdir_grids: string

Outdir Grids Output directory for grids; if empty, defaults to two directories below default Value ""

optional
outdir_txt2img_grids: string

Outdir Txt2Img Grids Output directory for txt2img grids default Value "outputs/txt2img-grids"

optional
outdir_img2img_grids: string

Outdir Img2Img Grids Output directory for img2img grids default Value "outputs/img2img-grids"

optional
outdir_save: string

Outdir Save Directory for saving images using the Save button default Value "log/images"

optional
save_to_dirs: boolean

Save To Dirs Save images to a subdirectory default Value false

optional
grid_save_to_dirs: boolean

Grid Save To Dirs Save grids to a subdirectory default Value false

optional
use_save_to_dirs_for_ui: boolean

Use Save To Dirs For Ui When using "Save" button, save images to a subdirectory default Value false

optional
directories_filename_pattern: string

Directories Filename Pattern Directory name pattern default Value ""

optional
directories_max_prompt_words: number

Directories Max Prompt Words Max prompt words for [prompt_words] pattern default Value 8

optional
ESRGAN_tile: number

Esrgan Tile Tile size for ESRGAN upscalers. 0 = no tiling. default Value 192

optional
ESRGAN_tile_overlap: number

Esrgan Tile Overlap Tile overlap, in pixels for ESRGAN upscalers. Low values = visible seam. default Value 8

optional
realesrgan_enabled_models: string[]

Realesrgan Enabled Models Select which Real-ESRGAN models to show in the web UI. (Requires restart) default Value ["R-ESRGAN 4x+","R-ESRGAN 4x+ Anime6B"]

optional
upscaler_for_img2img: null

Upscaler For Img2Img Upscaler for img2img

optional
use_scale_latent_for_hires_fix: boolean

Use Scale Latent For Hires Fix Upscale latent space image when doing hires. fix default Value false

optional
ldsr_steps: number

Ldsr Steps LDSR processing steps. Lower = faster default Value 100

optional
SWIN_tile: number

Swin Tile Tile size for all SwinIR. default Value 192

optional
SWIN_tile_overlap: number

Swin Tile Overlap Tile overlap, in pixels for SwinIR. Low values = visible seam. default Value 8

optional
face_restoration_model: null

Face Restoration Model Face restoration model

optional
code_former_weight: number

Code Former Weight CodeFormer weight parameter; 0 = maximum effect; 1 = minimum effect default Value 0.5

optional
face_restoration_unload: boolean

Face Restoration Unload Move face restoration model from VRAM into RAM after processing default Value false

optional
memmon_poll_rate: number

Memmon Poll Rate VRAM usage polls per second during generation. Set to 0 to disable. default Value 8

optional
samples_log_stdout: boolean

Samples Log Stdout Always print all generation info to standard output default Value false

optional
multiple_tqdm: boolean

Multiple Tqdm Add a second progress bar to the console that shows progress for an entire job. default Value true

optional
unload_models_when_training: boolean

Unload Models When Training Move VAE and CLIP to RAM when training if possible. Saves VRAM. default Value false

optional
pin_memory: boolean

Pin Memory Turn on pin_memory for DataLoader. Makes training slightly faster but can increase memory usage. default Value false

optional
save_optimizer_state: boolean

Save Optimizer State Saves Optimizer state as separate *.optim file. Training can be resumed with HN itself and matching optim file. default Value false

optional
dataset_filename_word_regex: string

Dataset Filename Word Regex Filename word regex default Value ""

optional
dataset_filename_join_string: string

Dataset Filename Join String Filename join string default Value " "

optional
training_image_repeats_per_epoch: number

Training Image Repeats Per Epoch Number of repeats for a single input image per epoch; used only for displaying epoch number default Value 1

optional
training_write_csv_every: number

Training Write Csv Every Save an csv containing the loss to log directory every N steps, 0 to disable default Value 500

optional
training_xattention_optimizations: boolean

Training Xattention Optimizations Use cross attention optimizations while training default Value false

optional
sd_model_checkpoint: string

Sd Model Checkpoint Stable Diffusion checkpoint

optional
sd_checkpoint_cache: number

Sd Checkpoint Cache Checkpoints to cache in RAM default Value 0

optional
sd_vae: string

Sd Vae SD VAE default Value "auto"

optional
sd_vae_as_default: boolean

Sd Vae As Default Ignore selected VAE for stable diffusion checkpoints that have their own .vae.pt next to them default Value false

optional
sd_hypernetwork: string

Sd Hypernetwork Hypernetwork default Value "None"

optional
sd_hypernetwork_strength: number

Sd Hypernetwork Strength Hypernetwork strength default Value 1

optional
inpainting_mask_weight: number

Inpainting Mask Weight Inpainting conditioning mask strength default Value 1

optional
img2img_color_correction: boolean

Img2Img Color Correction Apply color correction to img2img results to match original colors. default Value false

optional
img2img_fix_steps: boolean

Img2Img Fix Steps With img2img, do exactly the amount of steps the slider specifies (normally you'd do less with less denoising). default Value false

optional
enable_quantization: boolean

Enable Quantization Enable quantization in K samplers for sharper and cleaner results. This may change existing seeds. Requires restart to apply. default Value false

optional
enable_emphasis: boolean

Enable Emphasis Emphasis: use (text) to make model pay more attention to text and [text] to make it pay less attention default Value true

optional
use_old_emphasis_implementation: boolean

Use Old Emphasis Implementation Use old emphasis implementation. Can be useful to reproduce old seeds. default Value false

optional
enable_batch_seeds: boolean

Enable Batch Seeds Make K-diffusion samplers produce same images in a batch as when making a single image default Value true

optional
comma_padding_backtrack: number

Comma Padding Backtrack Increase coherency by padding from the last comma within n tokens when using more than 75 tokens default Value 20

optional
filter_nsfw: boolean

Filter Nsfw Filter NSFW content default Value false

optional
CLIP_stop_at_last_layers: number

Clip Stop At Last Layers Clip skip default Value 1

optional
random_artist_categories: string[]

Random Artist Categories Allowed categories for random artists selection when using the Roll button default Value []

optional
interrogate_keep_models_in_memory: boolean

Interrogate Keep Models In Memory Interrogate: keep models in VRAM default Value false

optional
interrogate_use_builtin_artists: boolean

Interrogate Use Builtin Artists Interrogate: use artists from artists.csv default Value true

optional
interrogate_return_ranks: boolean

Interrogate Return Ranks Interrogate: include ranks of model tags matches in results (Has no effect on caption-based interrogators). default Value false

optional
interrogate_clip_num_beams: number

Interrogate Clip Num Beams Interrogate: num_beams for BLIP default Value 1

optional
interrogate_clip_min_length: number

Interrogate Clip Min Length Interrogate: minimum description length (excluding artists, etc..) default Value 24

optional
interrogate_clip_max_length: number

Interrogate Clip Max Length Interrogate: maximum description length default Value 48

optional
interrogate_clip_dict_limit: number

Interrogate Clip Dict Limit CLIP: maximum number of lines in text file (0 = No limit) default Value 1500

optional
interrogate_deepbooru_score_threshold: number

Interrogate Deepbooru Score Threshold Interrogate: deepbooru score threshold default Value 0.5

optional
deepbooru_sort_alpha: boolean

Deepbooru Sort Alpha Interrogate: deepbooru sort alphabetically default Value true

optional
deepbooru_use_spaces: boolean

Deepbooru Use Spaces use spaces for tags in deepbooru default Value false

optional
deepbooru_escape: boolean

Deepbooru Escape escape () brackets in deepbooru (so they are used as literal brackets and not for emphasis) default Value true

optional
show_progressbar: boolean

Show Progressbar Show progressbar default Value true

optional
show_progress_every_n_steps: number

Show Progress Every N Steps Show image creation progress every N sampling steps. Set to 0 to disable. Set to -1 to show after completion of batch. default Value 0

optional
show_progress_grid: boolean

Show Progress Grid Show previews of all images generated in a batch as a grid default Value true

optional
return_grid: boolean

Return Grid Show grid in results for web default Value true

optional
do_not_show_images: boolean

Do Not Show Images Do not show any images in results for web default Value false

optional
add_model_hash_to_info: boolean

Add Model Hash To Info Add model hash to generation information default Value true

optional
add_model_name_to_info: boolean

Add Model Name To Info Add model name to generation information default Value false

optional
disable_weights_auto_swap: boolean

Disable Weights Auto Swap When reading generation parameters from text into UI (from PNG info or pasted text), do not change the selected model/checkpoint. default Value false

optional
send_seed: boolean

Send Seed Send seed when sending prompt or image to other interface default Value true

optional
font: string

Font Font for image grids that have text default Value ""

optional
js_modal_lightbox: boolean

Js Modal Lightbox Enable full page image viewer default Value true

optional
js_modal_lightbox_initially_zoomed: boolean

Js Modal Lightbox Initially Zoomed Show images zoomed in by default in full page image viewer default Value true

optional
show_progress_in_title: boolean

Show Progress In Title Show generation progress in window title. default Value true

optional
quicksettings: string

Quicksettings Quicksettings list default Value "sd_model_checkpoint"

optional
localization: string

Localization Localization (requires restart) default Value "None"

optional
hide_samplers: string[]

Hide Samplers Hide samplers in user interface (requires restart) default Value []

optional
eta_ddim: number

Eta Ddim eta (noise multiplier) for DDIM default Value 0

optional
eta_ancestral: number

Eta Ancestral eta (noise multiplier) for ancestral samplers default Value 1

optional
ddim_discretize: string

Ddim Discretize img2img DDIM discretize default Value "uniform"

optional
s_churn: number

S Churn sigma churn default Value 0

optional
s_tmin: number

S Tmin sigma tmin default Value 0

optional
s_noise: number

S Noise sigma noise default Value 1

optional
eta_noise_seed_delta: number

Eta Noise Seed Delta Eta noise seed delta default Value 0

optional
disabled_extensions: string[]

Disabled Extensions Disable those extensions default Value []