Documentation Template for Hecate Tagger

Table of Contents

1. Overview
2. Main Tabs
   • Database Tools
   • View Databases
   • Dataset Cleaning
   • Global Database
   • Image Tools
   • Statistics
   • Settings
3. Sub Tabs
   • Database Creation Tool
   • Database Edit Tools
   • Checkpoint Tools
4. Page Descriptions
5. How to Use

Overview

Hecate Tagger is an application designed to simplify the creation of image-tag datasets, primarily for use with Stable Diffusion. It includes several integrated autotaggers, tag retrieval via API, fast image loading, a responsive tag management UI, color-coded tags, tag filtering, simple statistics, and many other features to assist users in creating, managing, and exporting tags and captions.

Main Tabs

Database Tools

This tab allows users to interact with databases. It includes functionalities for loading databases, adding new images, creating new databases, and saving databases.

View Databases

This tab provides options to view and explore existing databases.

Dataset Cleaning

This tab offers tools to clean and organize datasets by removing duplicates and unwanted data.

Global Database

This tab is used for managing the global database settings and configurations.

Image Tools

This tab includes various tools for image manipulation and management.

Statistics

This tab displays statistical information about the datasets, including tag usage and image counts.

Settings

This tab allows users to configure the application settings according to their preferences.

Sub Tabs

Database Creation Tool

This sub-tab under Database Tools is used for creating new databases. Users can input the database path, apply settings, and configure external tag sources, automatic tagging tools, and pre/post tagging options.

Database Edit Tools

This sub-tab under Database Tools is used for editing existing databases. Users can modify tags, update images, and apply various editing tools.

Checkpoint Tools

This sub-tab under Database Tools provides functionalities for managing and using checkpoints.

Page Descriptions

Database Tools

• Load Database: Load an existing database from a specified path.
• Add New Images: Add new images to the currently loaded database.
• Create Database: Create a new database with the specified configurations.
• Save Database: Save the current state of the database.

External Tag Sources

• Retrieve Tags Via API: Configure API settings to retrieve tags from various sources like danbooru, gelbooru, and rule34.xxx.

Tags from Files

• Enable: Enable tag extraction from files.
• Search for files with both the image extension and without: Configure search settings for tag files.

Captions from Files

• Enable: Enable caption extraction from files.
• Search for files with both the image extension and without: Configure search settings for caption files.

Automatic Tagging Tools

• Use taggers: Enable the use of integrated autotaggers.
• Use aesthetic scorer: Enable the use of an aesthetic scorer.
• Use classifier: Enable the use of a classifier.

PrePost Tagging Options

• Rename Images to MD5: Rename images to their MD5 hash values.
• Convert Images to PNG: Convert images to PNG format.
• Move duplicate images out of folder: Move duplicate images out of the current folder.
• Create groups following folder structure: Organize images into groups based on their folder structure.

How to Use

1. Load an Existing Database:

   • Navigate to the Database Tools tab.
   • Enter the database path in the provided field.
   • Click "Load Database".

2. Add New Images:

   • Click "Add New Images" and select the images to be added.
   • Configure any additional settings if needed.

3. Create a New Database:

   • Enter the desired database path.
   • Configure the settings in the External Tag Sources, Tags from Files, and Captions from Files sections.
   • Click "Create Database".

4. Save the Database:

   • After making changes or adding new images, click "Save Database" to save the current state.

5. Retrieve Tags via API:

   • Check the desired sources (e.g., danbooru, gelbooru, rule34.xxx).
   • Apply any filters as necessary.
   • Enable "Retrieve Tags Via API" to fetch tags automatically.

6. Automatic Tagging Tools:

   • Enable the desired tools such as taggers, aesthetic scorers, and classifiers.

7. PrePost Tagging Options:

   • Configure options to rename images, convert formats, move duplicates, and create groups based on folder structure.

This template provides a structured overview of the Hecate Tagger application, including its main features, functionalities, and usage instructions.