a1111-sd-webui-tagcomplete

# Description Tag Autocomplete is an extension for the popular [AUTOMATIC1111 web UI](https://github.com/AUTOMATIC1111/stable-diffusion-webui) for Stable Diffusion. You can install it using the inbuilt available extensions list, clone the files manually as described [below](#-installation), or use a pre-packaged version from [Releases](https://github.com/DominikDoom/a1111-sd-webui-tagcomplete/releases). It displays autocompletion hints for recognized tags from "image booru" boards such as Danbooru, which are primarily used for browsing Anime-style illustrations. Since most custom Stable Diffusion models were trained using this information or merged with ones that did, using exact tags in prompts can often improve composition and consistency, even if the model itself has a photorealistic style. Disclaimer: The default tag lists contain NSFW terms, please use them responsibly.
# ✨ Features - Instant completion hints while typing (under normal circumstances) - ⌨️ Keyboard navigation - Dark & Light mode support - ️ Many [settings](#%EF%B8%8F-settings) and customizability - [Translation support](#translations) for tags, with optional live preview for the full prompt - **Note:** Translation files are provided by the community, see [here](#list-of-translations) for a list of translations I know of. Tag autocomplete supports built-in completion for: - ️ **Danbooru & e621 tags** (Top 100k by post count, as of November 2022) - ✳️ [**Wildcards**](#wildcards) - ➕ [**Extra network**](#extra-networks-embeddings-hypernets-lora-) filenames, including - Textual Inversion embeddings [(jump to readme section)] - Hypernetworks - LoRA - LyCORIS / LoHA - [**Chants**](#chants) (custom format for longer prompt presets) - ️ "[**Extra file**](#extra-file)", one set of customizable extra tags Additionally, some support for other third party extensions exists: Click to expand - [Image Browser][image-browser-url] - Filename & EXIF keyword search - [Multidiffusion Upscaler][multidiffusion-url] - Regional Prompts - [Dataset Tag Editor][tag-editor-url] - Caption, Interrogate Result, Edit Tags & Edit Caption - [WD 1.4 Tagger][wd-tagger-url] - Additional & Excluded tags - [Umi AI][umi-url] - Completion for YAML wildcards
# ️ Screenshots & Demo videos Click to expand Basic usage (with keyboard navigation): https://user-images.githubusercontent.com/34448969/200128020-10d9a8b2-cea6-4e3f-bcd2-8c40c8c73233.mp4 Wildcard script support: https://user-images.githubusercontent.com/34448969/200128031-22dd7c33-71d1-464f-ae36-5f6c8fd49df0.mp4 Extra Network preview support: https://github.com/DominikDoom/a1111-sd-webui-tagcomplete/assets/34448969/3c0cad84-fb5f-436d-b05a-28db35860d13 Dark and Light mode supported, including tag colors:
# Installation ## Using the built-in extension list 1. Open the `Extensions` tab 2. Open the `Available` sub-tab 3. Click **Load from** 4. Find **Booru tag autocompletion** in the list - The extension was one of the first available, so selecting "oldest first" will show it high up in the list. - Alternatively, use CRTL + F to search for the text on the page 5. Click **Install** on the right side ## Manual clone ```bash git clone "https://github.com/DominikDoom/a1111-sd-webui-tagcomplete.git" extensions/tag-autocomplete ``` (The second argument specifies the name of the folder, you can choose whatever you like).
# ❇️ Additional completion support ## Wildcards Autocompletion also works with wildcard files used by https://github.com/AUTOMATIC1111/stable-diffusion-webui-wildcards or other similar scripts/extensions. Completion is triggered by typing `__` (double underscore). It will first show a list of your wildcard files, and upon choosing one, the replacement options inside that file. This enables you to either insert categories to be replaced by the script, or directly choose one and use wildcards as a sort of categorized custom tag system. Wildcards are searched for in every extension folder, as well as the `scripts/wildcards` folder to support legacy versions. This means that you can combine wildcards from multiple extensions. Nested folders are also supported if you have grouped your wildcards in that way. ## Extra networks (Embeddings, Hypernets, LoRA, ...) Completion for these types is triggered by typing `<`. By default it will show them all mixed together, but further filtering can be done in the following way: - ` Image example 2. Through the model-keyword UI: - One issue with this method is that it has no official support for the Lycoris extension and doesn't scan its folder for files, so to add them through the UI you will have to temporarily move them into the Lora model folder to be able to select them in model-keywords dropdown. Some are already included in the default list though, so trying it out first is advisable. - After having added your custom keywords, you will need to either restart the UI or use the "Refresh TAC temp files" setting button. - Image example Sometimes the inserted keywords can be wrong due to a hash collision, however model-keyword and tag autocomplete take the name of the file into account too if the collision is known. If it still inserts something wrong or you simply don't want the keywords added that time, you can undo / redo it directly after as often as you want, until you type something else (It uses the default undo/redo action of the browser, so CTRL + Z, context menu and mouse macros should all work). ### Embedding type filtering Embeddings trained for Stable Diffusion 1.x or 2.x models respectively are incompatible with the other type. To make it easier to find valid embeds, they are categorized by "v1 Embedding" and "v2 Embedding", including a slight color difference. You can also filter your search to include only v1 or v2 embeddings by typing ` Chant format (click to expand) ``` … ```
The file can then be selected using the "Chant file" settings dropdown if it is located inside the extension's `tags` folder. A chant object has four fields: - `name` - Display name - `terms` - Search terms - `content` - The actual prompt content - `color` - Color, using the same category color system as normal tags ## Umi AI tags https://github.com/Klokinator/Umi-AI is a feature-rich wildcard extension similar to Unprompted or Dynamic Wildcards. In recent releases, it uses YAML-based wildcard tags to enable a complex chaining system,for example `<[preset][--female][sfw][species]>` will choose the preset category, exclude female related tags, further narrow it down with the following categories, and then choose one random fill-in matching all these criteria at runtime. Completion is triggered by `<[` and then each following new unclosed bracket, e.g. `<[xyz][`, until closed by `>`. Tag Autocomplete can recommend these options in a smart way, meaning while you continue to add category tags, it will only show results still matching what comes before. It also shows how many fill-in tags are available to choose from for that combo in place of the tag post count, enabling a quick overview and filtering of the large initial set. Most of the credit goes to [@ctwrs](https://github.com/ctwrs) here, they contributed a lot as one of the Umi developers. # ️ Settings The extension has a large amount of configuration & customizability built in. Most should be self-explanatory, but for a detailed description click on a section below. Tag filename The main tag file the script uses. Included by default are `danbooru.csv` and `e621.csv`. While you can add custom tags here, the vast majority of models are not trained on anything other than these two (mostly danbooru), so it will not have much benefit. You can also set it to `None` if you want to use other functionality of the extension (e.g. Wildcard or LoRA completion), but aren't interested in the normal tags. "Active in" settings Specifies where tag autocomplete should attach itself to and listen for changes. Negative prompts follow the settings for txt2img & img2img, so they will only be active if their "parent" is active. Black / Whitelist While the above options can turn off tag autocomplete globally, sometimes you might want to enable or disable it only for specific models. For example, if most of your models are Anime ones, you could add your photorealistic models, that weren't trained on booru tags and don't benefit from it, to the blacklist, which will automatically disable it after you switch to these models. You can use both the model name (including file extension) and their webui hashes (both short and