Skip to main content
Module

x/stable_diffusion_client/mod.ts>SDModels.Flags

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

Flags

Properties

optional
config: string

Config path to config which constructs model default Value "[set_fullPath]v1-inference.yaml"

optional
ckpt: string

Ckpt path to checkpoint of stable diffusion model; if specified, this checkpoint will be added to the list of checkpoints and loaded default Value "[set_fullPath]model.ckpt"

optional
ckpt_dir: string

Ckpt Dir Path to directory with stable diffusion checkpoints

optional
gfpgan_dir: string

Gfpgan Dir GFPGAN directory default Value "./GFPGAN"

optional
gfpgan_model: string

Gfpgan Model GFPGAN model file name

optional
no_half: boolean

No Half do not switch the model to 16-bit floats default Value false

optional
no_half_vae: boolean

No Half Vae do not switch the VAE model to 16-bit floats default Value false

optional
no_progressbar_hiding: boolean

No Progressbar Hiding do not hide progressbar in gradio UI (we hide it because it slows down ML if you have hardware acceleration in browser) default Value false

optional
max_batch_count: number

Max Batch Count maximum batch count value for the UI

optional
embeddings_dir: string

Embeddings Dir embeddings directory for textual inversion (default: embeddings) default Value "[set_fullPath]embeddings"

optional
hypernetwork_dir: string

Hypernetwork Dir hypernetwork directory default Value "[set_fullPath]models\hypernetworks"

optional
localizations_dir: string

Localizations Dir localizations directory default Value "[set_fullPath]localizations"

optional
allow_code: boolean

Allow Code allow custom script execution from webui default Value false

optional
medvram: boolean

Medvram enable stable diffusion model optimizations for sacrificing a little speed for low VRM usage default Value false

optional
lowvram: boolean

Lowvram enable stable diffusion model optimizations for sacrificing a lot of speed for very low VRM usage default Value false

optional
lowram: boolean

Lowram load stable diffusion checkpoint weights to VRAM instead of RAM default Value false

optional
always_batch_cond_uncond: boolean

Always Batch Cond Uncond disables cond/uncond batching that is enabled to save memory with --medvram or --lowvram default Value false

optional
unload_gfpgan: boolean

Unload Gfpgan does not do anything. default Value false

optional
precision: string

Precision evaluate at this precision default Value "autocast"

optional
share: boolean

Share use share=True for gradio and make the UI accessible through their site default Value false

optional
ngrok: string

Ngrok ngrok authtoken, alternative to gradio --share

optional
ngrok_region: string

Ngrok Region The region in which ngrok should start. default Value "us"

optional
enable_insecure_extension_access: boolean

Enable Insecure Extension Access enable extensions tab regardless of other options default Value false

optional
codeformer_models_path: string

Codeformer Models Path Path to directory with codeformer model file(s). default Value "[set_fullPath]models\Codeformer"

optional
gfpgan_models_path: string

Gfpgan Models Path Path to directory with GFPGAN model file(s). default Value "[set_fullPath]models\GFPGAN"

optional
esrgan_models_path: string

Esrgan Models Path Path to directory with ESRGAN model file(s). default Value "[set_fullPath]models\ESRGAN"

optional
bsrgan_models_path: string

Bsrgan Models Path Path to directory with BSRGAN model file(s). default Value "[set_fullPath]models\BSRGAN"

optional
realesrgan_models_path: string

Realesrgan Models Path Path to directory with RealESRGAN model file(s). default Value "[set_fullPath]models\RealESRGAN"

optional
clip_models_path: string

Clip Models Path Path to directory with CLIP model file(s).

optional
xformers: boolean

Xformers enable xformers for cross attention layers default Value false

optional
force_enable_xformers: boolean

Force Enable Xformers enable xformers for cross attention layers regardless of whether the checking code thinks you can run it; do not make bug reports if this fails to work default Value false

optional
deepdanbooru: boolean

Deepdanbooru does not do anything default Value false

optional
opt_split_attention: boolean

Opt Split Attention force-enables Doggettx's cross-attention layer optimization. By default, it's on for torch cuda. default Value false

optional
opt_split_attention_invokeai: boolean

Opt Split Attention Invokeai force-enables InvokeAI's cross-attention layer optimization. By default, it's on when cuda is unavailable. default Value false

optional
opt_split_attention_v1: boolean

Opt Split Attention V1 enable older version of split attention optimization that does not consume all the VRAM it can find default Value false

optional
disable_opt_split_attention: boolean

Disable Opt Split Attention force-disables cross-attention layer optimization default Value false

optional
use_cpu: string[]

Use Cpu use CPU as torch device for specified modules default Value []

optional
listen: boolean

Listen launch gradio with 0.0.0.0 as server name, allowing to respond to network requests default Value false

optional
port: string

Port launch gradio with given server port, you need root/admin rights for ports < 1024, defaults to 7860 if available

optional
show_negative_prompt: boolean

Show Negative Prompt does not do anything default Value false

optional
ui_config_file: string

Ui Config File filename to use for ui configuration default Value "[set_fullPath]ui-config.json"

optional
hide_ui_dir_config: boolean

Hide Ui Dir Config hide directory configuration from webui default Value false

optional
freeze_settings: boolean

Freeze Settings disable editing settings default Value false

optional
ui_settings_file: string

Ui Settings File filename to use for ui settings default Value "[set_fullPath]config.json"

optional
gradio_debug: boolean

Gradio Debug launch gradio with --debug option default Value false

optional
gradio_auth: string

Gradio Auth set gradio authentication like "username:password"; or comma-delimit multiple like "u1:p1,u2:p2,u3:p3"

optional
gradio_img2img_tool: string

Gradio Img2Img Tool gradio image uploader tool: can be either editor for ctopping, or color-sketch for drawing default Value "editor"

optional
gradio_inpaint_tool: string

Gradio Inpaint Tool gradio inpainting editor: can be either sketch to only blur/noise the input, or color-sketch to paint over it default Value "sketch"

optional
opt_channelslast: boolean

Opt Channelslast change memory type for stable diffusion to channels last default Value false

optional
styles_file: string

Styles File filename to use for styles default Value "[set_fullPath]styles.csv"

optional
autolaunch: boolean

Autolaunch open the webui URL in the system's default browser upon launch default Value false

optional
theme: string

Theme launches the UI with light or dark theme

optional
use_textbox_seed: boolean

Use Textbox Seed use textbox for seeds in UI (no up/down, but possible to input long seeds) default Value false

optional
disable_console_progressbars: boolean

Disable Console Progressbars do not output progressbars to console default Value false

optional
enable_console_prompts: boolean

Enable Console Prompts print prompts to console when generating with txt2img and img2img default Value false

optional
vae_path: string

Vae Path Path to Variational Autoencoders model

optional
disable_safe_unpickle: boolean

Disable Safe Unpickle disable checking pytorch models for malicious code default Value false

optional
api: boolean

Api use api=True to launch the API together with the webui (use --nowebui instead for only the API) default Value false

optional
api_auth: string

Api Auth Set authentication for API like "username:password"; or comma-delimit multiple like "u1:p1,u2:p2,u3:p3"

optional
nowebui: boolean

Nowebui use api=True to launch the API instead of the webui default Value false

optional
ui_debug_mode: boolean

Ui Debug Mode Don't load model to quickly launch UI default Value false

optional
device_id: string

Device Id Select the default CUDA device to use (export CUDA_VISIBLE_DEVICES=0,1,etc might be needed before)

optional
administrator: boolean

Administrator Administrator rights default Value false

optional
cors_allow_origins: string

Cors Allow Origins Allowed CORS origin(s) in the form of a comma-separated list (no spaces)

optional
cors_allow_origins_regex: string

Cors Allow Origins Regex Allowed CORS origin(s) in the form of a single regular expression

optional
tls_keyfile: string

Tls Keyfile Partially enables TLS, requires --tls-certfile to fully function

optional
tls_certfile: string

Tls Certfile Partially enables TLS, requires --tls-keyfile to fully function

optional
server_name: string

Server Name Sets hostname of server

optional
dreambooth_models_path: string

Dreambooth Models Path Path to directory to store Dreambooth model file(s).

optional
ckptfix: boolean

Ckptfix (Dreambooth) Enable fix for OOM errors when extracting checkpoints. default Value false

optional
ldsr_models_path: string

Ldsr Models Path Path to directory with LDSR model file(s). default Value "[set_fullPath]models\LDSR"

optional
scunet_models_path: string

Scunet Models Path Path to directory with ScuNET model file(s). default Value "[set_fullPath]models\ScuNET"

optional
swinir_models_path: string

Swinir Models Path Path to directory with SwinIR model file(s). default Value "[set_fullPath]models\SwinIR"