add categories to settings (f0f100e6) · Commits · github_fork / Stable Diffusion Webui

javascript/settings.js

+25 −0

Original line number	Diff line number	Diff line
		@@ -44,3 +44,28 @@ onUiLoaded(function() {

		buttonShowAllPages.addEventListener("click", settingsShowAllTabs);
		});


		onOptionsChanged(function() {
		if (gradioApp().querySelector('#settings .settings-category')) return;

		var sectionMap = {};
		gradioApp().querySelectorAll('#settings > div > button').forEach(function(x) {
		sectionMap[x.textContent.trim()] = x;
		});

		opts._categories.forEach(function(x) {
		var section = x[0];
		var category = x[1];

		var span = document.createElement('SPAN');
		span.textContent = category;
		span.className = 'settings-category';

		var sectionElem = sectionMap[section];
		if (!sectionElem) return;

		sectionElem.parentElement.insertBefore(span, sectionElem);
		});
		});

modules/options.py

+68 −7

Original line number	Diff line number	Diff line
		import json
		import sys
		from dataclasses import dataclass

		import gradio as gr

		@@ -8,13 +9,14 @@ from modules.shared_cmd_options import cmd_opts


		class OptionInfo:
		def __init__(self, default=None, label="", component=None, component_args=None, onchange=None, section=None, refresh=None, comment_before='', comment_after='', infotext=None, restrict_api=False):
		def __init__(self, default=None, label="", component=None, component_args=None, onchange=None, section=None, refresh=None, comment_before='', comment_after='', infotext=None, restrict_api=False, category_id=None):
		self.default = default
		self.label = label
		self.component = component
		self.component_args = component_args
		self.onchange = onchange
		self.section = section
		self.category_id = category_id
		self.refresh = refresh
		self.do_not_save = False

		@@ -63,7 +65,11 @@ class OptionHTML(OptionInfo):

		def options_section(section_identifier, options_dict):
		for v in options_dict.values():
		if len(section_identifier) == 2:
		v.section = section_identifier
		elif len(section_identifier) == 3:
		v.section = section_identifier[0:2]
		v.category_id = section_identifier[2]

		return options_dict

		@@ -206,6 +212,17 @@ class Options:
		d = {k: self.data.get(k, v.default) for k, v in self.data_labels.items()}
		d["_comments_before"] = {k: v.comment_before for k, v in self.data_labels.items() if v.comment_before is not None}
		d["_comments_after"] = {k: v.comment_after for k, v in self.data_labels.items() if v.comment_after is not None}

		item_categories = {}
		for item in self.data_labels.values():
		category = categories.mapping.get(item.category_id)
		category = "Uncategorized" if category is None else category.label
		if category not in item_categories:
		item_categories[category] = item.section[1]

		# _categories is a list of pairs: [section, category]. Each section (a setting page) will get a special heading above it with the category as text.
		d["_categories"] = [[v, k] for k, v in item_categories.items()] + [["Defaults", "Other"]]

		return json.dumps(d)

		def add_option(self, key, info):
		@@ -214,15 +231,40 @@ class Options:
		self.data[key] = info.default

		def reorder(self):
		"""reorder settings so that all items related to section always go together"""
		"""Reorder settings so that:
		- all items related to section always go together
		- all sections belonging to a category go together
		- sections inside a category are ordered alphabetically
		- categories are ordered by creation order

		Category is a superset of sections: for category "postprocessing" there could be multiple sections: "face restoration", "upscaling".

		This function also changes items' category_id so that all items belonging to a section have the same category_id.
		"""

		category_ids = {}
		section_categories = {}

		section_ids = {}
		settings_items = self.data_labels.items()
		for _, item in settings_items:
		if item.section not in section_ids:
		section_ids[item.section] = len(section_ids)
		if item.section not in section_categories:
		section_categories[item.section] = item.category_id

		for _, item in settings_items:
		item.category_id = section_categories.get(item.section)

		for category_id in categories.mapping:
		if category_id not in category_ids:
		category_ids[category_id] = len(category_ids)

		self.data_labels = dict(sorted(settings_items, key=lambda x: section_ids[x[1].section]))
		def sort_key(x):
		item: OptionInfo = x[1]
		category_order = category_ids.get(item.category_id, len(category_ids))
		section_order = item.section[1]

		return category_order, section_order

		self.data_labels = dict(sorted(settings_items, key=sort_key))

		def cast_value(self, key, value):
		"""casts an arbitrary to the same type as this setting's value with key
		@@ -245,3 +287,22 @@ class Options:
		value = expected_type(value)

		return value


		@dataclass
		class OptionsCategory:
		id: str
		label: str

		class OptionsCategories:
		def __init__(self):
		self.mapping = {}

		def register_category(self, category_id, label):
		if category_id in self.mapping:
		return category_id

		self.mapping[category_id] = OptionsCategory(category_id, label)


		categories = OptionsCategories()

modules/shared_options.py

+28 −21

Original line number	Diff line number	Diff line
		@@ -3,7 +3,7 @@ import gradio as gr
		from modules import localization, ui_components, shared_items, shared, interrogate, shared_gradio_themes
		from modules.paths_internal import models_path, script_path, data_path, sd_configs_path, sd_default_config, sd_model_file, default_sd_model_file, extensions_dir, extensions_builtin_dir # noqa: F401
		from modules.shared_cmd_options import cmd_opts
		from modules.options import options_section, OptionInfo, OptionHTML
		from modules.options import options_section, OptionInfo, OptionHTML, categories

		options_templates = {}
		hide_dirs = shared.hide_dirs
		@@ -21,7 +21,14 @@ restricted_opts = {
		"outdir_init_images"
		}

		options_templates.update(options_section(('saving-images', "Saving images/grids"), {
		categories.register_category("saving", "Saving images")
		categories.register_category("sd", "Stable Diffusion")
		categories.register_category("ui", "User Interface")
		categories.register_category("system", "System")
		categories.register_category("postprocessing", "Postprocessing")
		categories.register_category("training", "Training")

		options_templates.update(options_section(('saving-images', "Saving images/grids", "saving"), {
		"samples_save": OptionInfo(True, "Always save all generated images"),
		"samples_format": OptionInfo('png', 'File format for images'),
		"samples_filename_pattern": OptionInfo("", "Images filename pattern", component_args=hide_dirs).link("wiki", "https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Custom-Images-Filename-Name-and-Subdirectory"),
		@@ -67,7 +74,7 @@ options_templates.update(options_section(('saving-images', "Saving images/grids"
		"notification_volume": OptionInfo(100, "Notification sound volume", gr.Slider, {"minimum": 0, "maximum": 100, "step": 1}).info("in %"),
		}))

		options_templates.update(options_section(('saving-paths', "Paths for saving"), {
		options_templates.update(options_section(('saving-paths', "Paths for saving", "saving"), {
		"outdir_samples": OptionInfo("", "Output directory for images; if empty, defaults to three directories below", component_args=hide_dirs),
		"outdir_txt2img_samples": OptionInfo("outputs/txt2img-images", 'Output directory for txt2img images', component_args=hide_dirs),
		"outdir_img2img_samples": OptionInfo("outputs/img2img-images", 'Output directory for img2img images', component_args=hide_dirs),
		@@ -79,7 +86,7 @@ options_templates.update(options_section(('saving-paths', "Paths for saving"), {
		"outdir_init_images": OptionInfo("outputs/init-images", "Directory for saving init images when using img2img", component_args=hide_dirs),
		}))

		options_templates.update(options_section(('saving-to-dirs', "Saving to a directory"), {
		options_templates.update(options_section(('saving-to-dirs', "Saving to a directory", "saving"), {
		"save_to_dirs": OptionInfo(True, "Save images to a subdirectory"),
		"grid_save_to_dirs": OptionInfo(True, "Save grids to a subdirectory"),
		"use_save_to_dirs_for_ui": OptionInfo(False, "When using \"Save\" button, save images to a subdirectory"),
		@@ -87,21 +94,21 @@ options_templates.update(options_section(('saving-to-dirs', "Saving to a directo
		"directories_max_prompt_words": OptionInfo(8, "Max prompt words for [prompt_words] pattern", gr.Slider, {"minimum": 1, "maximum": 20, "step": 1, **hide_dirs}),
		}))

		options_templates.update(options_section(('upscaling', "Upscaling"), {
		options_templates.update(options_section(('upscaling', "Upscaling", "postprocessing"), {
		"ESRGAN_tile": OptionInfo(192, "Tile size for ESRGAN upscalers.", gr.Slider, {"minimum": 0, "maximum": 512, "step": 16}).info("0 = no tiling"),
		"ESRGAN_tile_overlap": OptionInfo(8, "Tile overlap for ESRGAN upscalers.", gr.Slider, {"minimum": 0, "maximum": 48, "step": 1}).info("Low values = visible seam"),
		"realesrgan_enabled_models": OptionInfo(["R-ESRGAN 4x+", "R-ESRGAN 4x+ Anime6B"], "Select which Real-ESRGAN models to show in the web UI.", gr.CheckboxGroup, lambda: {"choices": shared_items.realesrgan_models_names()}),
		"upscaler_for_img2img": OptionInfo(None, "Upscaler for img2img", gr.Dropdown, lambda: {"choices": [x.name for x in shared.sd_upscalers]}),
		}))

		options_templates.update(options_section(('face-restoration', "Face restoration"), {
		options_templates.update(options_section(('face-restoration', "Face restoration", "postprocessing"), {
		"face_restoration": OptionInfo(False, "Restore faces", infotext='Face restoration').info("will use a third-party model on generation result to reconstruct faces"),
		"face_restoration_model": OptionInfo("CodeFormer", "Face restoration model", gr.Radio, lambda: {"choices": [x.name() for x in shared.face_restorers]}),
		"code_former_weight": OptionInfo(0.5, "CodeFormer weight", gr.Slider, {"minimum": 0, "maximum": 1, "step": 0.01}).info("0 = maximum effect; 1 = minimum effect"),
		"face_restoration_unload": OptionInfo(False, "Move face restoration model from VRAM into RAM after processing"),
		}))

		options_templates.update(options_section(('system', "System"), {
		options_templates.update(options_section(('system', "System", "system"), {
		"auto_launch_browser": OptionInfo("Local", "Automatically open webui in browser on startup", gr.Radio, lambda: {"choices": ["Disable", "Local", "Remote"]}),
		"enable_console_prompts": OptionInfo(shared.cmd_opts.enable_console_prompts, "Print prompts to console when generating with txt2img and img2img."),
		"show_warnings": OptionInfo(False, "Show warnings in console.").needs_reload_ui(),
		@@ -116,13 +123,13 @@ options_templates.update(options_section(('system', "System"), {
		"dump_stacks_on_signal": OptionInfo(False, "Print stack traces before exiting the program with ctrl+c."),
		}))

		options_templates.update(options_section(('API', "API"), {
		options_templates.update(options_section(('API', "API", "system"), {
		"api_enable_requests": OptionInfo(True, "Allow http:// and https:// URLs for input images in API", restrict_api=True),
		"api_forbid_local_requests": OptionInfo(True, "Forbid URLs to local resources", restrict_api=True),
		"api_useragent": OptionInfo("", "User agent for requests", restrict_api=True),
		}))

		options_templates.update(options_section(('training', "Training"), {
		options_templates.update(options_section(('training', "Training", "training"), {
		"unload_models_when_training": OptionInfo(False, "Move VAE and CLIP to RAM when training if possible. Saves VRAM."),
		"pin_memory": OptionInfo(False, "Turn on pin_memory for DataLoader. Makes training slightly faster but can increase memory usage."),
		"save_optimizer_state": OptionInfo(False, "Saves Optimizer state as separate *.optim file. Training of embedding or HN can be resumed with the matching optim file."),
		@@ -137,7 +144,7 @@ options_templates.update(options_section(('training', "Training"), {
		"training_tensorboard_flush_every": OptionInfo(120, "How often, in seconds, to flush the pending tensorboard events and summaries to disk."),
		}))

		options_templates.update(options_section(('sd', "Stable Diffusion"), {
		options_templates.update(options_section(('sd', "Stable Diffusion", "sd"), {
		"sd_model_checkpoint": OptionInfo(None, "Stable Diffusion checkpoint", gr.Dropdown, lambda: {"choices": shared_items.list_checkpoint_tiles(shared.opts.sd_checkpoint_dropdown_use_short)}, refresh=shared_items.refresh_checkpoints, infotext='Model hash'),
		"sd_checkpoints_limit": OptionInfo(1, "Maximum number of checkpoints loaded at the same time", gr.Slider, {"minimum": 1, "maximum": 10, "step": 1}),
		"sd_checkpoints_keep_in_cpu": OptionInfo(True, "Only keep one model on device").info("will keep models other than the currently used one in RAM rather than VRAM"),
		@@ -154,14 +161,14 @@ options_templates.update(options_section(('sd', "Stable Diffusion"), {
		"hires_fix_refiner_pass": OptionInfo("second pass", "Hires fix: which pass to enable refiner for", gr.Radio, {"choices": ["first pass", "second pass", "both passes"]}, infotext="Hires refiner"),
		}))

		options_templates.update(options_section(('sdxl', "Stable Diffusion XL"), {
		options_templates.update(options_section(('sdxl', "Stable Diffusion XL", "sd"), {
		"sdxl_crop_top": OptionInfo(0, "crop top coordinate"),
		"sdxl_crop_left": OptionInfo(0, "crop left coordinate"),
		"sdxl_refiner_low_aesthetic_score": OptionInfo(2.5, "SDXL low aesthetic score", gr.Number).info("used for refiner model negative prompt"),
		"sdxl_refiner_high_aesthetic_score": OptionInfo(6.0, "SDXL high aesthetic score", gr.Number).info("used for refiner model prompt"),
		}))

		options_templates.update(options_section(('vae', "VAE"), {
		options_templates.update(options_section(('vae', "VAE", "sd"), {
		"sd_vae_explanation": OptionHTML("""
		<abbr title='Variational autoencoder'>VAE</abbr> is a neural network that transforms a standard <abbr title='red/green/blue'>RGB</abbr>
		image into latent space representation and back. Latent space representation is what stable diffusion is working on during sampling
		@@ -176,7 +183,7 @@ For img2img, VAE is used to process user's input image before the sampling, and
		"sd_vae_decode_method": OptionInfo("Full", "VAE type for decode", gr.Radio, {"choices": ["Full", "TAESD"]}, infotext='VAE Decoder').info("method to decode latent to image"),
		}))

		options_templates.update(options_section(('img2img', "img2img"), {
		options_templates.update(options_section(('img2img', "img2img", "sd"), {
		"inpainting_mask_weight": OptionInfo(1.0, "Inpainting conditioning mask strength", gr.Slider, {"minimum": 0.0, "maximum": 1.0, "step": 0.01}, infotext='Conditional mask weight'),
		"initial_noise_multiplier": OptionInfo(1.0, "Noise multiplier for img2img", gr.Slider, {"minimum": 0.0, "maximum": 1.5, "step": 0.001}, infotext='Noise multiplier'),
		"img2img_extra_noise": OptionInfo(0.0, "Extra noise multiplier for img2img and hires fix", gr.Slider, {"minimum": 0.0, "maximum": 1.0, "step": 0.01}, infotext='Extra noise').info("0 = disabled (default); should be lower than denoising strength"),
		@@ -192,7 +199,7 @@ options_templates.update(options_section(('img2img', "img2img"), {
		"img2img_batch_show_results_limit": OptionInfo(32, "Show the first N batch img2img results in UI", gr.Slider, {"minimum": -1, "maximum": 1000, "step": 1}).info('0: disable, -1: show all images. Too many images can cause lag'),
		}))

		options_templates.update(options_section(('optimizations', "Optimizations"), {
		options_templates.update(options_section(('optimizations', "Optimizations", "sd"), {
		"cross_attention_optimization": OptionInfo("Automatic", "Cross attention optimization", gr.Dropdown, lambda: {"choices": shared_items.cross_attention_optimizations()}),
		"s_min_uncond": OptionInfo(0.0, "Negative Guidance minimum sigma", gr.Slider, {"minimum": 0.0, "maximum": 15.0, "step": 0.01}).link("PR", "https://github.com/AUTOMATIC1111/stable-diffusion-webui/pull/9177").info("skip negative prompt for some steps when the image is almost ready; 0=disable, higher=faster"),
		"token_merging_ratio": OptionInfo(0.0, "Token merging ratio", gr.Slider, {"minimum": 0.0, "maximum": 0.9, "step": 0.1}, infotext='Token merging ratio').link("PR", "https://github.com/AUTOMATIC1111/stable-diffusion-webui/pull/9256").info("0=disable, higher=faster"),
		@@ -203,7 +210,7 @@ options_templates.update(options_section(('optimizations', "Optimizations"), {
		"batch_cond_uncond": OptionInfo(True, "Batch cond/uncond").info("do both conditional and unconditional denoising in one batch; uses a bit more VRAM during sampling, but improves speed; previously this was controlled by --always-batch-cond-uncond comandline argument"),
		}))

		options_templates.update(options_section(('compatibility', "Compatibility"), {
		options_templates.update(options_section(('compatibility', "Compatibility", "sd"), {
		"use_old_emphasis_implementation": OptionInfo(False, "Use old emphasis implementation. Can be useful to reproduce old seeds."),
		"use_old_karras_scheduler_sigmas": OptionInfo(False, "Use old karras scheduler sigmas (0.1 to 10)."),
		"no_dpmpp_sde_batch_determinism": OptionInfo(False, "Do not make DPM++ SDE deterministic across different batch sizes."),
		@@ -228,7 +235,7 @@ options_templates.update(options_section(('interrogate', "Interrogate"), {
		"deepbooru_filter_tags": OptionInfo("", "deepbooru: filter out those tags").info("separate by comma"),
		}))

		options_templates.update(options_section(('extra_networks', "Extra Networks"), {
		options_templates.update(options_section(('extra_networks', "Extra Networks", "sd"), {
		"extra_networks_show_hidden_directories": OptionInfo(True, "Show hidden directories").info("directory is hidden if its name starts with \".\"."),
		"extra_networks_hidden_models": OptionInfo("When searched", "Show cards for models in hidden directories", gr.Radio, {"choices": ["Always", "When searched", "Never"]}).info('"When searched" option will only show the item when the search string has 4 characters or more'),
		"extra_networks_default_multiplier": OptionInfo(1.0, "Default multiplier for extra networks", gr.Slider, {"minimum": 0.0, "maximum": 2.0, "step": 0.01}),
		@@ -245,7 +252,7 @@ options_templates.update(options_section(('extra_networks', "Extra Networks"), {
		"sd_hypernetwork": OptionInfo("None", "Add hypernetwork to prompt", gr.Dropdown, lambda: {"choices": ["None", *shared.hypernetworks]}, refresh=shared_items.reload_hypernetworks),
		}))

		options_templates.update(options_section(('ui', "User interface"), {
		options_templates.update(options_section(('ui', "User interface", "ui"), {
		"localization": OptionInfo("None", "Localization", gr.Dropdown, lambda: {"choices": ["None"] + list(localization.localizations.keys())}, refresh=lambda: localization.list_localizations(cmd_opts.localizations_dir)).needs_reload_ui(),
		"gradio_theme": OptionInfo("Default", "Gradio theme", ui_components.DropdownEditable, lambda: {"choices": ["Default"] + shared_gradio_themes.gradio_hf_hub_themes}).info("you can also manually enter any of themes from the <a href='https://huggingface.co/spaces/gradio/theme-gallery'>gallery</a>.").needs_reload_ui(),
		"gradio_themes_cache": OptionInfo(True, "Cache gradio themes locally").info("disable to update the selected Gradio theme"),
		@@ -280,7 +287,7 @@ options_templates.update(options_section(('ui', "User interface"), {
		}))


		options_templates.update(options_section(('infotext', "Infotext"), {
		options_templates.update(options_section(('infotext', "Infotext", "ui"), {
		"add_model_hash_to_info": OptionInfo(True, "Add model hash to generation information"),
		"add_model_name_to_info": OptionInfo(True, "Add model name to generation information"),
		"add_user_name_to_info": OptionInfo(False, "Add user name to generation information when authenticated"),
		@@ -295,7 +302,7 @@ options_templates.update(options_section(('infotext', "Infotext"), {

		}))

		options_templates.update(options_section(('ui', "Live previews"), {
		options_templates.update(options_section(('ui', "Live previews", "ui"), {
		"show_progressbar": OptionInfo(True, "Show progressbar"),
		"live_previews_enable": OptionInfo(True, "Show live previews of the created image"),
		"live_previews_image_format": OptionInfo("png", "Live preview file format", gr.Radio, {"choices": ["jpeg", "png", "webp"]}),
		@@ -308,7 +315,7 @@ options_templates.update(options_section(('ui', "Live previews"), {
		"live_preview_fast_interrupt": OptionInfo(False, "Return image with chosen live preview method on interrupt").info("makes interrupts faster"),
		}))

		options_templates.update(options_section(('sampler-params', "Sampler parameters"), {
		options_templates.update(options_section(('sampler-params', "Sampler parameters", "sd"), {
		"hide_samplers": OptionInfo([], "Hide samplers in user interface", gr.CheckboxGroup, lambda: {"choices": [x.name for x in shared_items.list_samplers()]}).needs_reload_ui(),
		"eta_ddim": OptionInfo(0.0, "Eta for DDIM", gr.Slider, {"minimum": 0.0, "maximum": 1.0, "step": 0.01}, infotext='Eta DDIM').info("noise multiplier; higher = more unpredictable results"),
		"eta_ancestral": OptionInfo(1.0, "Eta for k-diffusion samplers", gr.Slider, {"minimum": 0.0, "maximum": 1.0, "step": 0.01}, infotext='Eta').info("noise multiplier; currently only applies to ancestral samplers (i.e. Euler a) and SDE samplers"),
		@@ -330,7 +337,7 @@ options_templates.update(options_section(('sampler-params', "Sampler parameters"
		'uni_pc_lower_order_final': OptionInfo(True, "UniPC lower order final", infotext='UniPC lower order final'),
		}))

		options_templates.update(options_section(('postprocessing', "Postprocessing"), {
		options_templates.update(options_section(('postprocessing', "Postprocessing", "postprocessing"), {
		'postprocessing_enable_in_main_ui': OptionInfo([], "Enable postprocessing operations in txt2img and img2img tabs", ui_components.DropdownMulti, lambda: {"choices": [x.name for x in shared_items.postprocessing_scripts()]}),
		'postprocessing_operation_order': OptionInfo([], "Postprocessing operation order", ui_components.DropdownMulti, lambda: {"choices": [x.name for x in shared_items.postprocessing_scripts()]}),
		'upscaling_max_images_in_cache': OptionInfo(5, "Maximum number of images in upscaling cache", gr.Slider, {"minimum": 0, "maximum": 10, "step": 1}),

style.css

+9 −0

Original line number	Diff line number	Diff line
		@@ -462,6 +462,15 @@ div.toprow-compact-tools{
		padding: 4px;
		}

		#settings > div.tab-nav .settings-category{
		display: block;
		margin: 1em 0 0.25em 0;
		font-weight: bold;
		text-decoration: underline;
		cursor: default;
		user-select: none;
		}

		#settings_result{
		height: 1.4em;
		margin: 0 1.2em;

Admin message