Flow-based Diagnostics for Embedding Systems & Compression
Project description
🌊 GradTracer
Flow-based Diagnostics for Embedding Systems & Compression
Installation • Core Focus • AI Agent Integration
GradTracer is a specialized diagnostic library designed for Embedding-heavy Recommendation Systems (RecSys) and Model Compression.
Rather than competing with general-purpose loggers like TensorBoard or Weights & Biases, GradTracer tracks step-by-step training dynamics (dG/dt)—such as embedding drift, gradient oscillation, and exposure frequency—to diagnose silent failures (e.g., representation collapse) that traditional scalar metrics miss.
Crucially, every GradTracer module exports its findings as standardized causal JSON, allowing AI coding assistants (Cursor, Copilot, Antigravity) and custom IDE Extensions to automatically parse the diagnosis and apply statistically backed prescriptions.
🎯 Core Focus: RecSys & Compression
1. Embedding Dynamics Tracker & Bayesian Auto-Fix (v0.6+)
General DL diagnostics often fail for RecSys because embedding tables are highly sparse and suffer from popularity bias. EmbeddingTracker identifies:
- Zombie Embeddings: Items with high update velocity but oscillating gradient directions (failing to generalize).
- Dead Embeddings: Items suffering from severe cold-start or broken negative sampling.
- Popularity Bias: Exposure distribution skew (Gini/Entropy) that hurts long-tail coverage.
- Frequency-Aware Saliency: Normalizes update velocity by exposure frequency to identify truly important embeddings for pruning.
- ⚡ [NEW] Bayesian Auto-Fix: Pass
auto_fix=Trueto let GradTracer actively intercept and dynamically scale gradients for Zombie embeddings during the backward pass based on SNR and global loss posteriors. - 🌍 [NEW] DDP Support: Automatically handles
torch.distributed.all_reduceto aggregate embedding stats across multiple GPUs. - 🛡️ [NEW] White-Glass Audit: Complete transparency. The
AutoFixAuditLoggersaves every causal intervention locally to.gradtracer/audit.jsonlto ensure perfect reproducibility.
2. Production Hardening & Ecosystem (v0.7)
- 🏎️ Zero-Overhead Tracking: Lazy evaluation with
track_intervaland strictly GPU-bound tensor operations guarantee< 5%performance overhead even on massive 1M+ parameter embedding tables (Verified inexamples/benchmark.py). - 🌉 Weights & Biases Bridge: Use
log_to_wandb(tracker)to seamlessly stream GradTracer's diagnostics (zombie ratios, health scores, Popularity Gini) directly into your existing W&B dashboards. - 🤖 Universal JSON Export: Replaced legacy XML with standard causal JSON output for flawless integration with modern LLM coding agents.
3. Auto-Compression Suite & IDE Extension (v0.7)
Instead of blindly pruning based on weight magnitude, GradTracer uses training dynamics to guide compression:
- [NEW] 🥇 Auto-Compression Recipe (
RecipeGenerator): The Holy Grail of compression. Analyzes dynamic health and SNR to automatically output an optimal mixed-precision (FP16/INT8/INT4) and joint structural pruning recipe (e.g., "INT4 + 80% Prune"). - [NEW] 💻 VS Code Extension: Integrates directly into your IDE. Hover over Python layer definitions to see real-time GradTracer diagnostic popups and 1-click apply compression recipes.
4. Deep Tree Dynamics (v0.6)
- Node-Level GBDT Tracking (
TreeDynamicsTracker): Unlike basic feature importance, GradTracer unpacks the raw tree structure to track Leaf Velocity (Variance) and Feature Split Concentration. Evaluates mathematically if trees are stagnating or exploding. - [NEW] Broad Support: Now fully supports
XGBoost,LightGBM, andCatBoost.
5. Complex Architectures (v0.6)
FlowManager: Centralized multi-tracker hub designed for Two-Tower, GNN, or Sequential architectures to calculate cross-layer correlations (e.g., User Tower vs. Item Tower).
🤖 AI Agent JSON Export
GradTracer serves as a "Decision Layer" for AI coding assistants. By calling AgentExporter.export_embedding(), models receive exact logic and prescriptions.
from gradtracer.agent import AgentExporter
from gradtracer.analyzers.embedding import EmbeddingTracker
tracker = EmbeddingTracker(model.item_emb, auto_fix=True, track_interval=100)
# ... training loop (tracker.step()) ...
print(AgentExporter.export_embedding(tracker))
{
"gradtracer_embedding_report": {
"layer": "item_emb",
"embedding_stats": {
"num_embeddings": 1000000,
"active_coverage_pct": 20.4,
"popularity_gini": 0.85
},
"diagnostics": [
{
"type": "POPULARITY_BIAS",
"premise": "Exposure distribution is highly skewed (Gini coefficient: 0.85 > 0.8).",
"implies": "Model is predominantly optimizing for top-popular items. Long-tail embeddings will suffer from inadequate learning.",
"action": "APPLY_LOG_Q_CORRECTION_OR_INVERSE_FREQUENCY_SAMPLING",
"expected_effect": "Debias the softmax logits and improve long-tail recommendation coverage.",
"confidence": 0.95
}
]
}
}
📊 Mathematical & Statistical Validation
GradTracer's recommendations are backed by formal statistical tests. As demonstrated in our Validation Notebooks, our Auto-Fix logic and embedding prescriptions yield Statistically Significant Improvements mathematically guaranteed via:
- NDCG@10 & Hit Rate@10 Paired t-tests demonstrating statistically rigorous ranking improvements when Auto-Fix intercepts oscillatory parameters in MovieLens-100K MF baselines.
- Cosine Similarity Tracking guaranteeing true oscillatory embeddings rather than in-sample noise.
🚀 Quick Start
pip install gradtracer
🧩 Experimental Modules
While optimized for RecSys and Compression, GradTracer still includes its original Python dynamics modules:
FlowTracker: General PyTorch training stability (SNR, Stagnation).FeatureAnalyzer: VIF-filtered interaction suggestions.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gradtracer-0.7.1.tar.gz.
File metadata
- Download URL: gradtracer-0.7.1.tar.gz
- Upload date:
- Size: 74.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
526543e9baa3df66167828eec347d501fcaf197dcc5d46230ea3cb835c9cf63c
|
|
| MD5 |
0a9e1901deb7c08f256e3925f854d3f6
|
|
| BLAKE2b-256 |
d9679f5a8dae87be059aead64002eb6e1cfad1d3529a8968af0029577a6b69ce
|
Provenance
The following attestation bundles were made for gradtracer-0.7.1.tar.gz:
Publisher:
publish.yml on hw01931/GradTracer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gradtracer-0.7.1.tar.gz -
Subject digest:
526543e9baa3df66167828eec347d501fcaf197dcc5d46230ea3cb835c9cf63c - Sigstore transparency entry: 1002753927
- Sigstore integration time:
-
Permalink:
hw01931/GradTracer@f3edb3c8edbe501eb7c8c830b4124843dddf8aa1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/hw01931
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f3edb3c8edbe501eb7c8c830b4124843dddf8aa1 -
Trigger Event:
push
-
Statement type:
File details
Details for the file gradtracer-0.7.1-py3-none-any.whl.
File metadata
- Download URL: gradtracer-0.7.1-py3-none-any.whl
- Upload date:
- Size: 72.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa84879a5f6bb1f78ce4670e1b7b60040fe88c1375eac60924cece1a7b3d7b11
|
|
| MD5 |
7ea32943c38089e91c0e7612717bc843
|
|
| BLAKE2b-256 |
fbf00c36d7c0b16388c0e6fd087159a7898c046d04b3e87ab9f6caa9cfc62405
|
Provenance
The following attestation bundles were made for gradtracer-0.7.1-py3-none-any.whl:
Publisher:
publish.yml on hw01931/GradTracer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gradtracer-0.7.1-py3-none-any.whl -
Subject digest:
fa84879a5f6bb1f78ce4670e1b7b60040fe88c1375eac60924cece1a7b3d7b11 - Sigstore transparency entry: 1002753945
- Sigstore integration time:
-
Permalink:
hw01931/GradTracer@f3edb3c8edbe501eb7c8c830b4124843dddf8aa1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/hw01931
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f3edb3c8edbe501eb7c8c830b4124843dddf8aa1 -
Trigger Event:
push
-
Statement type: