Skip to content

Commit 47635d5

Browse files
docs: Update user CSV instructions with naming conventions and console log details
1 parent 4415e22 commit 47635d5

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,12 @@ Also, displaying related tags is not supported.
9292

9393
### User CSV
9494

95-
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.
95+
Users can also use their own CSV files. CSV files should be placed in the `data` folder according to the following naming convention:
96+
97+
- **CSV for Autocomplete**: `<danbooru | e621>_tags*.csv`
98+
- **CSV for Related Tags**: `<danbooru | e621>_tags_cooccurrence*.csv`
99+
100+
For example, you can add frequently used meta tags to the autocomplete suggestions by placing a file named `danbooru_tags_meta.csv` in the `data` folder.
96101
A header row is not required. A browser reload is necessary to apply the changes.
97102

98103
**Example of meta tags:**
@@ -106,6 +111,15 @@ low_quality,5,9999999,
106111
worst_quality,5,9999999,
107112
```
108113

114+
When the browser is reloaded, you can check the list of loaded CSV files in the ComfyUI console log. If a file is not included in the log output, please verify that the file name follows the naming convention.
115+
116+
**Example of ComfyUI console log output:**
117+
```
118+
[Autocomplete-Plus] CSV file status:
119+
* Danbooru -> base: True, extra: danbooru_tags_meta.csv // If displayed here, meta tags can be autocompleted
120+
* E621 -> base: False, extra:
121+
```
122+
109123
>[!NOTE]
110124
> 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.
111125

docs/README_jp.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,12 @@
9090

9191
### ユーザーCSV
9292

93-
ユーザーが自身で用意した CSV を使用することも可能です。例として、よく使うメタタグを `danbooru_tags_meta.csv` の名前で `data` フォルダーに配置することでオートコンプリート候補に追加できます。
93+
ユーザーが自身で用意した CSV を使用することも可能です。 CSV ファイルは以下の命名規則に従って `data` フォルダーに配置してください。
94+
95+
- **オートコンプリート用 CSV**: <danbooru | e621>_tags*.csv
96+
- **関連タグ用 CSV**: <danbooru | e621>_tags_cooccurrence*.csv
97+
98+
例として、よく使うメタタグを `danbooru_tags_meta.csv` の名前で `data` フォルダーに配置することでオートコンプリート候補に追加できます。
9499
ヘッダー行はなくても構いません。反映にはブラウザのリロードが必要です。
95100

96101
**メタタグの例**
@@ -104,6 +109,15 @@ low_quality,5,9999999,
104109
worst_quality,5,9999999,
105110
```
106111

112+
ブラウザリロード時、ロードされる CSV ファイル一覧をComfyUIのコンソールのログで確認出来ます。ログ出力に含まれていない場合はファイル名が命名規則に沿っているか確認してください。
113+
114+
**ComfyUIコンソールログ出力の例:**
115+
```
116+
[Autocomplete-Plus] CSV file status:
117+
* Danbooru -> base: True, extra: danbooru_tags_meta.csv // ここに表示されていればメタタグを入力補完できます
118+
* E621 -> base: False, extra:
119+
```
120+
107121
>[!NOTE]
108122
> ユーザー CSV が複数ある場合アルファベット順に読み込まれます。同じタグが複数のファイルに存在する場合は先に読み込まれた方が保持されます。基本 CSV は最後にロードされます。
109123

0 commit comments

Comments
 (0)