Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
starik222 authored Nov 2, 2023
1 parent 9e50a74 commit 5f9c8dc
Showing 1 changed file with 38 additions and 8 deletions.
46 changes: 38 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ You need a dataset like the following:

In the program, select "File->Load folder" and specify the directory with the dataset.

![](https://user-images.githubusercontent.com/1236582/230425218-7718cc79-ba36-48c9-b08f-c36d72633eee.png)
![](https://github.com/starik222/BooruDatasetTagManager/assets/1236582/4d5a1a31-5909-4706-a3d1-980f82d58c6a)

In the left column, tags are edited for the selected image, in the right column, tags are edited for all images of the dataset.
The left pane displays images from the dataset. The central panel displays tags for the selected images, which you can edit. The right panel has two tabs. The first tab displays all (or common) tags present in the dataset. In the second tab you can generate tags using the built-in service (interrogator_rpc).

After editing, you will select "File->Save all changes".

You can select multiple images at once in a dataset. This will allow you to easily edit tags for images of the same type.

![](https://user-images.githubusercontent.com/1236582/230428077-a1e3a724-d5fc-4cf6-a187-e7090c381762.png)
![bdtm03](https://github.com/starik222/BooruDatasetTagManager/assets/1236582/72a450dd-93d9-4cef-9a73-8460c77e9b7d)

Through the "file" menu, you can open the settings window to customize the application for yourself. Users who have Google Translate blocked can change the translation service to Chinese.
Through the "Setting" menu, you can open the settings window to customize the application for yourself. Users who have Google Translate blocked can change the translation service to Chinese. On the "UI" tab, you can select a color scheme, and on the "Hotkeys" tab, configure the key layout that is convenient for you.

![](https://user-images.githubusercontent.com/1236582/230429522-9ae76b82-f8d7-4f24-81e4-8c7072bd412c.png)
![bdtm04](https://github.com/starik222/BooruDatasetTagManager/assets/1236582/2adb081f-b11c-480e-b137-1cb801d0474f)

# Tag translation

Expand All @@ -34,13 +34,43 @@ From the "view" menu, select "Translate tags" to display columns with translated
Translation file example:
```bash
//Translation format: <original>=<translation>
black hair=÷åðíûå âîëîñû
*solo=Ñîëî
1girl=1 äåâóøêà
black hair=÷åðíûå âîëîñû
*solo=Ñîëî
1girl=1 äåâóøêà
```

Currently, the manual translation filter can only be used in tag autocompletion (with the option enabled in the settings). But in the future, it can be used somewhere else.

# Tag list for autocomplete

The application supports loading tags from csv files of the format used in "[Booru tag autocompletion for A1111](https://github.com/DominikDoom/a1111-sd-webui-tagcomplete)". You can also create your own txt files with a list of tags (line by line). But since loading data from these files takes a long time, the program converts them to its own format and loads data from it. Therefore, if you change the list of tags, be prepared to wait quite a long time. All files with tags are located in the "Tags" folder.

# AutoTagger (interrogator_rpc)

You can generate tags for images directly in the program. To do this, you need to configure and run the "interrogator_rpc" service. Python must be installed for it to work.
To configure interrogator_rpc, run the command:
```bash
pip install -r requirements.txt
```
To start the service run
```bash
python main.py
```
After launching the service, in the editor itself you can generate tags for all images using the "Tools" menu, generate tags for selected images using ![](https://github.com/starik222/BooruDatasetTagManager/assets/1236582/230f47f9-5cef-49bc-8b44-a67890433c42) icon, and also generate tags in a separate tab "AutoTagger preview window". To configure generation parameters, you can use the corresponding generation menu item, or the "Settings" -> "Auto tagger settings..." menu.

![bdtm06](https://github.com/starik222/BooruDatasetTagManager/assets/1236582/88c3ab34-b96e-411c-b0b9-2a92729b822c)

The generator allows you to select several models at once and specify a method for combining the results.

# Weighted tags

The editor supports working with weighted tags. When loading tags, brackets are automatically converted to weights. To change the weight of a tag, you need to select it and move the "weight" track bar to the required number of positions. One position equals one bracket.

# Color scheme

Currently, the program offers two color schemes (Classic and Dark). You can create or change the color scheme yourself. There is no window-based color scheme editor yet, but you can open the ColorScheme.json file using a text editor and make the necessary changes.

# Other

Using the "View" menu you can hide panels you don't need.
In the "Tools" menu there is a function to automatically replace the transparent background with the color you need.

0 comments on commit 5f9c8dc

Please sign in to comment.