📄 Description

Tag Autocomplete is an extension for the popular AUTOMATIC1111 web UI for Stable Diffusion.

It displays autocompletion hints for recognized tags from "image booru" boards such as Danbooru, which are primarily used for browsing Anime-style illustrations. Since some Stable Diffusion models were trained using this information, for example Waifu Diffusion and many of the NAI-descendant models or merges, using exact tags in prompts can often improve composition and consistency.

You can install it using the inbuilt available extensions list, clone the files manually as described below, or use a pre-packaged version from Releases.

✨ Features

• 🚀 Instant completion hints while typing (under normal circumstances)
• ⌨️ Keyboard navigation
• 🌒 Dark & Light mode support
• 🛠️ Many settings and customizability
• 🌍 Translation support for tags, with optional live preview for the full prompt
  • Note: Translation files are provided by the community, see here 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
• ➕ Extra network filenames, including
  • Textual Inversion embeddings [(jump to readme section)]
  • Hypernetworks
  • LoRA
  • LyCORIS / LoHA
• 🪄 Chants (custom format for longer prompt presets)
• 🏷️ "Extra file", one set of customizable extra tags

Additionally, some support for other third party extensions exists:

🖼️ Screenshots & Demo videos

📦 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

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:

• <e: will only show embeddings
• <l: will only show LoRA and LyCORIS
  • Or <lora: and <lyco: respectively for the long form
• <h: or <hypernet: will only show Hypernetworks

Live previews

Tag Autocomplete will now also show the preview images used for the cards in the Extra Networks menu in a small window next to the regular popup. This enables quick comparisons and additional info for unclear filenames without having to stop typing to look it up in the webui menu. It works for all supported extra network types that use preview images (Loras/Lycos, Embeddings & Hypernetworks). The preview window will stay hidden for normal tags or if no preview was found.

Lora / Lyco trigger word completion

This feature will try to add known trigger words on autocompleting a Lora/Lyco.

It primarily uses the list provided by the model-keyword extension, which thus needs to be installed to use this feature. The list is also regularly updated through it. However, once installed, you can deactivate it if you want, since tag autocomplete only needs the local keyword lists it ships with, not the extension itself. The used files are lora-keyword.txt and lora-keyword-user.txt in the model-keyword installation folder. If the main file isn't found, the feature will simply deactivate itself, everything else should work normally.

Note:

As of v1.5.0, the webui provides a native method to add activation keywords for Lora through the Extra networks config UI. These trigger words will always be preferred over the model-keyword ones and can be used without needing to install the model-keyword extension. This will however, obviously, be limited to those manually added keywords. For automatic discovery of keywords, you will still need the big list provided by model-keyword.

Custom trigger words can be added through two methods:

1. Using the extra networks UI (recommended):

   • Only works with webui version v1.5.0 upwards, but much easier to use and works without the model-keyword extension

   • This method requires no manual refresh

   • 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 <v1/2 or <e:v1/2 followed by the actual search term.

For example:

Chants

Chants are longer prompt presets. The name is inspired by some early prompt collections from Chinese users, which often were called along the lines of "Spellbook", "Codex", etc. The prompt snippets from such documents were fittingly called spells or chants for this reason.

Similar to embeddings and loras, this feature is triggered by typing the <, <c: or <chant: commands. For instance, when you enter <c:HighQuality in the prompt box and select it, the following prompt text will be inserted:

(masterpiece, best quality, high quality, highres, ultra-detailed),

Chants can be added in JSON files following this format:

[
    {
        "name": "Basic-NegativePrompt",
        "terms": "Negative,Low,Quality",
        "content": "(worst quality, low quality, normal quality)",
        "color": 3
    },
    {
        "name": "Basic-HighQuality",
        "terms": "Best,High,Quality",
        "content": "(masterpiece, best quality, high quality, highres, ultra-detailed)",
        "color": 1
    },
    {
        "name": "Basic-Start",
        "terms": "Basic, Start, Simple, Demo",
        "content": "(masterpiece, best quality, high quality, highres), 1girl, extremely beautiful detailed face, ...",
        "color": 5
    }
]

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 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.

Translations

An additional file can be added in the translation section, which will be used to translate both tags and aliases and also enables searching by translation. This file needs to be a CSV in the format <English tag/alias>,<Translation>. Some older files use a three column format, which requires a compatibility setting to be activated. You can find it under Settings > Tag autocomplete > Translation filename > Translation file uses old 3-column translation format instead of the new 2-column one. With it on, the second column will be unused and skipped during parsing.

Example with Chinese translation:

List of translations

• 🇨🇳 Chinese tags by @HalfMAI, using machine translation and manual correction for the most common tags (uses legacy format)
• 🇨🇳 Chinese tags by @sgmklp, smaller set of manual translations based on https://github.com/zcyzcy88/TagTable

🫵 I need your help!

Translations are a community effort. If you have translated a tag file or want to create one, please open a Pull Request or Issue so your link can be added here. Please make sure the quality is alright though, machine translation gets a lot of stuff wrong even for the most common tags.

Live preview

⚠️ Warning:

This feature is still experimental, you might encounter some bugs when using it.

This will show a live preview of all detected tags in the prompt, both correctly separated by commas as well as in a longer sentence. It can detect up to three-word pairs in natural sentences, preferring perfect multi-word matches over single tags.

Above the detected tags will be their translation from the translation file, so if you aren't sure what the English tag means, you can easily find it there even after they have been inserted into the prompt (instead of just in the popup during completion).

The option defaults to off, but you can activate it by choosing a translation file and checking "Show live tag translation below prompt". It will not affect the normal functionality if it is off.

Example with Chinese translation:

Clicking on a detected tag will also select it in the prompt for quick editing.

⚠️ Known issues with live translation:

The translation updates when the user types or pastes text, but not if the action happens programmatically (e.g. applying a style or loading from PNG Info / Image Browser). This can be worked around by typing something manually after the programmatic edit.

Extra file

An extra file can be used to add new / custom tags not included in the main set. The format is identical to the normal tag format shown in CSV tag data below, with one exception: Since custom tags likely have no count, column three (or two if counting from zero) is instead used for the gray meta text displayed next to the tag. If left empty, it will instead show "Custom tag".

An example with the included (very basic) extra-quality-tags.csv file:

Whether the custom tags should be added before or after the normal tags can be chosen in the settings.

CSV tag data

The script expects a CSV file with tags saved in the following way:

<name>,<type>,<postCount>,"<aliases>"

Example:

1girl,0,4114588,"1girls,sole_female"
solo,0,3426446,"female_solo,solo_female"
highres,5,3008413,"high_res,high_resolution,hires"
long_hair,0,2898315,longhair
commentary_request,5,2610959,

Notably, it does not expect column names in the first row and both count and aliases are technically optional, although count is always included in the default data. Multiple aliases need to be comma separated as well, but encased in string quotes to not break the CSV parsing.

The numbering system follows the tag API docs of Danbooru:

or similarly for e621:

The tag type is used for coloring entries in the result list.

⚠️ Common Problems & Known Issues:

• Depending on your browser settings, sometimes an old version of the script can get cached. Try CTRL + F5 to force-reload the site without cache if e.g. a new feature doesn't appear for you after an update.
• If the prompt popup has broken styling for you or doesn't appear at all (like this), make sure to update your openpose-editor extension if you have it installed. It is known to cause issues with other extensions in older versions.