ComfyUI-Autocomplete-Plus

English • 日本語

[!WARNING] This custom node is currently in beta. Features may change or bugs may occur without notice.

Overview

ComfyUI-Autocomplete-Plus is a custom node that provides multiple input assistance features for any text area in ComfyUI. Currently, it mainly supports Danbooru-style tag input.

Features

• :zap:No setup required: Automatically downloads CSV data optimized for Danbooru tags.
• :mag:Autocomplete: Displays tag suggestions in real-time based on your input as you type.
• :file_cabinet:Related Tags Display: Shows a list of tags highly related to the selected tag.
• :earth_asia:Multilingual Support: Supports input completion in Japanese, Chinese, and Korean.
• :computer_mouse:Intuitive Operation:
  • Supports both mouse and keyboard operations.
  • Natural tag insertion that considers cursor position and existing text.
• :art:Design: Supports both light and dark themes of ComfyUI.
• :pencil:User CSV: Allows users to add their own CSV files for autocomplete suggestions.
• Zero Dependencies: All input assistance processing works in the browser without external libraries.

Installation

For the beta version, you can install it using the following steps:

1. Clone or copy this repository into the custom_nodes folder of ComfyUI.
   git clone https://github.com/newtextdoc1111/ComfyUI-Autocomplete-Plus.git
2. Launch ComfyUI. The necessary CSV data will be automatically downloaded from HuggingFace on the first launch only.

Autocomplete

When you type in a text input area, tags that partially match the text are displayed in descending order of post count. You can select a tag with the up and down keys, and insert the selected tag by pressing Enter or Tab.

• Tag aliases are also included in the search. Japanese hiragana and katakana are searched without distinction.
• Tags are color-coded by category. The color-coding rules are the same as Danbooru.
• Tags that have already been entered are displayed grayed out.

Related Tags

When you select any tag in a text input area, highly related tags list are displayed. The UI's position and size are automatically adjusted based on the text area being edited.

• The display position is primarily at the bottom of the text area and automatically adjusts vertically based on available space.
  • You can switch between vertical and horizontal display positions using the "↕️|↔️" button in the header.
• You can toggle the pinned state of the displayed related tags using the "📌|🎯" button in the header. To close the UI when pinned, press the Esc key.
• Tags that have already been entered are displayed grayed out. If you try to insert a grayed-out tag, the already entered tag will instead be selected.
• You can display related tags for the cursor position by pressing Ctrl+Shift+Space.

CSV Data

Two basic CSV data files are required for operation. These are managed on HuggingFace and are automatically downloaded when ComfyUI is first launched after installation, so no setup is required.
Since the basic CSV files are based on the Danbooru dataset publicly available on HuggingFace, the post counts and related tag information may differ from the Danbooru website.

[!IMPORTANT] The basic CSV contains both SFW and NSFW tags.

danbooru_tags.csv

This is a tag information CSV file for autocomplete, containing tag names, categories, post counts, and aliases (including Japanese, Chinese, and Korean). The column structure is the same as that used in DominikDoom/a1111-sd-webui-tagcomplete.

Tag information is filtered under the following conditions:

• Post count of 100 or more
• Image score of 5 or more
• Category is general, character, or copyright
• Tag name does not contain (cosplay)

danbooru_tags_cooccurrence.csv

This is a CSV file for related tag calculation, recording tag pairs and their co-occurrence counts.

Tag pairs are further filtered from the tag information CSV under the following conditions:

• Co-occurrence count of 100 or more

User CSV

Users can also use their own CSV files. For example, frequently used meta tags can be added to the autocomplete suggestions by placing a file named danbooru_tags_meta.csv in the data folder. A header row is not required. A browser reload is necessary to apply the changes.

Example of meta tags:

tag,category,count,alias
masterpiece,5,9999999,
best_quality,5,9999999,
high_quality,5,9999999,
normal_quality,5,9999999,
low_quality,5,9999999,
worst_quality,5,9999999,

[!NOTE] If there are multiple user CSV files, they are loaded in alphabetical order. If the same tag exists in multiple files, the one loaded first is retained. The basic CSV is loaded last.

Settings

Autocomplete

• Enable Autocomplete: Enable/disable the autocomplete feature.
• Max suggestions: Maximum number of autocomplete suggestions to display.

Related Tags

• Enable Related Tags: Enable/disable the related tags feature.
• Max related tags: Maximum number of related tags to display.
• Default Display Position: Default display position when ComfyUI starts.
• Related Tags Trigger Mode: Trigger for displaying related tags (click, Ctrl+click).

Known Issues

Performance

• Due to the large size of the CSV files, browser startup time may be longer.
• It consumes memory to operate quickly in the browser. This should not be an issue on machines with specs capable of running ComfyUI.

Autocomplete

Related Tags

• When the UI is pinned, some keys other than specific ones may be entered into the text area during keyboard input.

Credits

• ComfyUI-Custom-Node
  • Referenced for implementing the autocomplete function.
• DominikDoom/a1111-sd-webui-tagcomplete
  • Referenced for autocomplete function and CSV specifications.