Ethanfel/Comfyui-Nodes-Stats
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README for model tracking feature

Browse Source 
Document new Models tab, /nodes-stats/models endpoint, model_usage
table, updated How It Works diagram, and file structure.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Ethanfel
2026-04-09 18:43:21 +02:00
parent 9477777124
commit 777e4890ae
1 changed files with 46 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+46 -32
View File
@@ -4,14 +4,16 @@
<img src="docs/logo.svg" width="120" alt="Node Stats logo"> <img src="docs/logo.svg" width="120" alt="Node Stats logo">
</p> </p>
A ComfyUI custom node package that silently tracks which nodes and packages you actually use. Helps identify unused packages that are safe to remove — keeping your ComfyUI install lean. A ComfyUI custom node package that silently tracks which nodes, packages, and model files you actually use. Helps identify unused packages and models that are safe to remove — keeping your ComfyUI install lean.
## Features ## Features
- **Silent tracking** — hooks into every prompt submission, zero config needed - **Silent tracking** — hooks into every prompt submission, zero config needed
- **Node & model tracking** — tracks custom node packages and model files (checkpoints, VAEs, ControlNets, etc.) separately
- **Per-package classification** — packages are sorted into tiers based on usage recency - **Per-package classification** — packages are sorted into tiers based on usage recency
- **Smart aging** — packages gradually move from "recently unused" to "safe to remove" over time - **Per-model classification** — models grouped by type (checkpoints, vae, …) with the same recency tiers
- **Uninstall detection** — removed packages are flagged separately, historical data preserved - **Smart aging** — items gradually move from "recently unused" to "safe to remove" over time
- **Uninstall detection** — removed packages/models are flagged separately, historical data preserved
- **Expandable detail** — click any package to see individual node-level stats - **Expandable detail** — click any package to see individual node-level stats
- **Non-blocking** — DB writes happen in a background thread, no impact on workflow execution - **Non-blocking** — DB writes happen in a background thread, no impact on workflow execution
@@ -55,11 +57,17 @@ Restart ComfyUI. Tracking starts immediately and silently.
### UI ### UI
Click the **Node Stats** button (bar chart icon) in the ComfyUI top menu bar. A dialog shows: Click the **Node Stats** button (bar chart icon) in the ComfyUI top menu bar. A dialog opens with two tabs:
- **Summary bar** with counts for each classification tier **Nodes tab**
- **Sections** for each tier, sorted from most actionable to least - Summary bar with counts for each classification tier
- **Expandable rows** — click any package to see per-node execution counts and timestamps - Sections for each tier, sorted from most actionable to least
- Expandable rows — click any package to see per-node execution counts and timestamps
**Models tab**
- Summary bar with counts for each tier across all model types
- Sections per model type (checkpoints, vae, controlnet, …)
- Per-model table showing execution count, last used date, and status
### API ### API
@@ -67,6 +75,7 @@ Click the **Node Stats** button (bar chart icon) in the ComfyUI top menu bar. A
|----------|--------|-------------| |----------|--------|-------------|
| `/nodes-stats/packages` | GET | Per-package aggregated stats with classification | | `/nodes-stats/packages` | GET | Per-package aggregated stats with classification |
| `/nodes-stats/usage` | GET | Raw per-node usage data | | `/nodes-stats/usage` | GET | Raw per-node usage data |
| `/nodes-stats/models` | GET | Per-type model stats with classification |
| `/nodes-stats/reset` | POST | Clear all tracked data | | `/nodes-stats/reset` | POST | Clear all tracked data |
```bash ```bash
@@ -114,42 +123,46 @@ curl http://localhost:8188/nodes-stats/packages | python3 -m json.tool
## How It Works ## How It Works
``` ```
Queue Prompt ──> Prompt Handler ──> Extract class_types ──> Background Thread Queue Prompt ──> Prompt Handler ──> Extract class_types + prompt ──> Background Thread
│ │
┌─────────────────────────┘ ┌───────────────────────────────┘
▼ ▼
SQLite DB SQLite DB
usage_stats.db usage_stats.db
┌──────────┐ ┌─────────────┐
│node_usage │ per-node counts & timestamps │ node_usage │ per-node counts & timestamps
│prompt_log │ full node list per prompt │ prompt_log │ full node list per prompt
└──────────┘ │ model_usage │ per-model counts & timestamps
│ └─────────────┘
GET /nodes-stats/packages ◄──┘ │
│ GET /nodes-stats/packages ◄─────────┤
▼ GET /nodes-stats/models ◄─────────┘
Mapper merges DB data │
with NODE_CLASS_MAPPINGS ▼
│ Merge DB data with installed
▼ nodes/models, classify by recency
Classify by recency ──> JSON response ──> UI Dialog │
▼
JSON response ──> UI Dialog (Nodes tab / Models tab)
``` ```
1. Registers a prompt handler via `PromptServer.instance.add_on_prompt_handler()` 1. Registers a prompt handler via `PromptServer.instance.add_on_prompt_handler()`
2. On every prompt submission, extracts `class_type` from each node in the workflow 2. On every prompt submission, extracts `class_type` from each node and the full prompt dict
3. Offloads recording to a background thread (non-blocking) 3. Offloads recording to a background thread (non-blocking)
4. Maps each class_type to its source package using `RELATIVE_PYTHON_MODULE` 4. Maps each class_type to its source package using `RELATIVE_PYTHON_MODULE`
5. Upserts per-node counts and timestamps into SQLite 5. Detects model file selections by introspecting each node's `INPUT_TYPES()` for folder-dropdown inputs, then resolves filenames via `folder_paths`
6. On stats request, merges DB data with current node registry and classifies by recency 6. Upserts per-node and per-model counts and timestamps into SQLite
7. On stats request, merges DB data with current node registry / installed models and classifies by recency
## Data Storage ## Data Storage
All data is stored in `usage_stats.db` in the package directory. All data is stored in `<ComfyUI user dir>/nodes_stats/usage_stats.db` (survives extension reinstalls).
| Table | Contents | | Table | Contents |
|-------|----------| |-------|----------|
| `node_usage` | Per-node: class_type, package, execution count, first/last seen | | `node_usage` | Per-node: class_type, package, execution count, first/last seen |
| `prompt_log` | Per-prompt: timestamp, JSON array of all class_types used | | `prompt_log` | Per-prompt: timestamp, JSON array of all class_types used |
| `model_usage` | Per-model: filename, type, execution count, first/last seen |
Use `POST /nodes-stats/reset` to clear all data and start fresh. Use `POST /nodes-stats/reset` to clear all data and start fresh.
@@ -157,8 +170,9 @@ Use `POST /nodes-stats/reset` to clear all data and start fresh.
``` ```
__init__.py Entry point: prompt handler, API routes __init__.py Entry point: prompt handler, API routes
mapper.py class_type → package name mapping mapper.py class_type → package mapping; model filename → type mapping
tracker.py SQLite persistence and stats aggregation tracker.py SQLite persistence and stats aggregation
js/nodes_stats.js Frontend: menu button + stats dialog js/nodes_stats.js Frontend: menu button + stats dialog (Nodes/Models tabs)
pyproject.toml Package metadata pyproject.toml Package metadata
tests/ Unit tests for tracker and mapper
``` ```