6.8 KiB
e621tagger Documentation Index
Comprehensive documentation for agents working with the e621tagger codebase.
Overview
e621tagger is a web-based tool that automatically generates relevant tags for furry artwork using the JTP-3 Hydra model by Project RedRocket. The system accepts image uploads, processes them through a deep learning model, and returns tag predictions with confidence scores.
Documentation Map
| Document | Purpose | Audience | Key Topics |
|---|---|---|---|
| APP.md | app.py reference, all methods/variables | Backend agents | Flask routes, endpoints, runtime |
| JS.md | JavaScript reference, all functions/variables | Frontend agents | UI logic, event handlers, API calls |
| ARCHITECTURE.md | System overview, component relationships, data flow | All agents | Layers, data flow, security |
| API.md | Flask endpoints, request/response contracts | API integration agents | Endpoints, rate limits, errors |
| MODEL.md | JTP-3 Hydra architecture, NaFlexVit details | ML/inference agents | Model architecture, inference |
| TAGGING.md | Tag classification, implications, categories | Content handling agents | Categories, thresholds, output |
| CONFIG.md | Environment variables, configuration options | Deployment agents | Env vars, Docker, Gunicorn |
| DEPLOYMENT.md | Docker setup, self-hosting guide | DevOps agents | Docker, compose, production |
| CI_CD.md | GitHub Actions workflow, CI/CD pipeline | CI/CD agents | Build, deploy, versioning |
| COMPOSE.md | Docker Compose configurations | DevOps agents | Compose files, networking |
| PWA.md | Service worker, manifest, offline support | Frontend agents | PWA, caching, offline |
| CSS.md | Frontend styles, themes, responsive design | Frontend agents | Styling, themes, components |
Quick Reference
Core Endpoints
GET / - Main UI page
POST /predict - Image classification (rate limited: 20/min)
GET /health - Health check
GET /favicon.ico - Favicon
GET /robots.txt - Robots exclusion rules
GET /sitemap.xml - XML sitemap
GET /service-worker.js - PWA service worker
GET /static/<path> - Static assets
Environment Variables
Note: For
GUNICORN_WORKERSandGUNICORN_TIMEOUT, see CONFIG.md - these are passed to Gunicorn via command-line arguments, not read as environment variables by app.py.
| Variable | Default | Description |
|---|---|---|
MODEL_PATH |
models/hydra-3.5.safetensors |
Model file path |
DEVICE |
cuda (fallback: cpu) |
PyTorch device |
MAX_SEQ_LEN |
1024 |
Maximum sequence length |
APP_VERSION |
test |
Application version |
SAVE_UPLOADS |
false |
Save uploaded images |
UPLOAD_DIR |
/app/uploads |
Upload save directory |
USE_PROXY |
false |
Trust reverse proxy headers |
Note:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24is used internally in the CI/CD pipeline and does not need to be set for normal operation.
Docker Image
ghcr.io/fenrir784/e621tagger:latest
Key Files
| File | Purpose |
|---|---|
app.py |
Flask application, API endpoints, rate limiting, subcategory display names |
hydra/ |
Model library (HydraPool, NaFlexVit, head, labels, image processing) |
hydra/_subcat.py |
_SUBCATEGORY_MAP — 6,263 general tags mapped to 12 subcategories |
hydra/label.py |
Label.subcategory property using the subcategory map |
utils/ |
Utilities (multi-process Loader, WorkQueue) |
Supported Image Formats
- JPEG, PNG, GIF, WebP, BMP, TIFF
- Maximum file size: 20MB
Tag Categories
Tags are organized into e621 categories with numeric IDs:
| ID | Category | Description |
|---|---|---|
| 0 | General | General tags (includes sub-categories 100-111) |
| 1 | Artist | Artist tags |
| 2 | Contributor | Contributor tags |
| 3 | Copyright | Copyright/series tags |
| 4 | Character | Character tags |
| 5 | Species | Species tags |
| 6 | Invalid | Invalid tags |
| 7 | Meta | Meta tags (rating, resolution) |
| 8 | Lore | Lore-related tags |
| 100 | Accessories, Items, Clothing | Clothing and accessories |
| 101 | Actions, Positions, State | Actions and poses |
| 102 | Body Color | Body color tags |
| 103 | Body Features | Body feature tags |
| 104 | Effects, Fluids | Effects and fluids |
| 105 | Fetishes, Specifics, Interactions | Fetish and adult tags |
| 106 | Genders, Demographics | Gender and demographic tags |
| 107 | Locations, Backgrounds, Setting | Location and background tags |
| 108 | Poses, Scenarios, Situations | Pose and scenario tags |
| 109 | Style, Perspective | Style and perspective tags |
| 110 | Text, Symbols, UI, Vocalization | Text and UI tags |
| 111 | Other | Tags from unrecognized categories |
Note: General tags are further classified into 12 fine-grained subcategories via the
_SUBCATEGORY_MAPinhydra/_subcat.py. See TAGGING.md for details.
Common Tasks
Run locally with Docker
docker run -p 5000:5000 ghcr.io/fenrir784/e621tagger:latest
Query health endpoint
curl https://tagger.fenrir784.app/health
Submit image for tagging
curl -X POST -F "[email protected]" https://tagger.fenrir784.app/predict
Model Information
- Architecture: naflexvit_so400m_patch16_siglip + rr_hydra2
- Base Model: SigLIP-400m
- Tags: 8,888 (Hydra 3.5 model)
- General tags with subcategories: 6,263
- Input: Image patches (16x16)
- Sequence Length: Up to 1024 patches
- Model Source: HuggingFace
RedRocket/Hydra
Note: General tags are further classified into 12 fine-grained subcategories via the
_SUBCATEGORY_MAPinhydra/_subcat.py. See TAGGING.md for details.
Security Headers
The application sets the following security headers on all responses:
Strict-Transport-Security: max-age=31536000; includeSubDomainsX-Frame-Options: DENYX-Content-Type-Options: nosniffReferrer-Policy: strict-origin-when-cross-originPermissions-Policy: geolocation=(), microphone=(), camera=()Content-Security-Policy: default-src 'self'; img-src 'self' data: blob:; script-src 'self'; style-src 'self' 'unsafe-inline'; connect-src 'self' https://e621.net; object-src 'none'; base-uri 'self';
Rate Limits
/predict: 20 requests per minute (additional limit)- All endpoints: 500 requests per hour (global default limit)
- Unauthenticated access only
Note: The 500/hour limit applies to all endpoints. The
/predictendpoint has an additional stricter limit of 20/minute.
Support
- GitHub: https://github.com/Fenrir784/e621tagger
- Telegram: https://t.me/fenrir784
- Live Instance: https://tagger.fenrir784.app