Skip to content

Latest commit

 

History

1,730 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NeuralDBG

Training failed? NeuralDBG tells you why. It hooks into your PyTorch training loop, detects what went wrong (vanishing gradients, exploding gradients, data anomalies), and pinpoints the exact layer and step — so you fix it in seconds, not hours.

License: MIT Python 3.11+ PyPI CI Security: Bandit Open In Colab GitHub Pages Lightning W&B

NeuralDBG Workflow

Overview

NeuralDBG treats training as a semantic trace of learning dynamics rather than a black box. It extracts meaningful events and provides causal hypotheses about training failures, enabling researchers to:

  • Identify gradient health transitions (stable -> vanishing/saturated)
  • Detect activation regime shifts (normal -> saturated/dead)
  • Detect optimizer instability (loss plateaus, spikes, divergence)
  • Catch data anomalies (NaN, Inf, distribution shifts)
  • Track propagation of instabilities through network layers
  • Generate ranked causal explanations for training failures

Unlike traditional monitoring tools (TensorBoard, Weights & Biases), NeuralDBG focuses on causal inference rather than metric tracking.

Neural Suite

Component Availability Role
NeuralDBG Public (PyPI) Causal diagnostics in your training loop
Diagnostic Workspace Private beta Visual causal graphs and hypothesis explorer
Neural Agent Private beta Auto-remediation from causal hypotheses

Request early access: open an issue with label suite-access.

Try it in 60 seconds (Colab)

Open In Colab

Or locally: python examples/quickstart_interactive.py

Public benchmark

Reproducible causal accuracy on synthetic failures (details):

python -m benchmark_public.run

Latest results: benchmark_public/results.json

Vanishing Gradient Detection

Why NeuralDBG?

Feature TensorBoard / W&B NeuralDBG
What it shows Graphs of loss/accuracy over time Why the loss spiked or vanished
Diagnosis Manual inspection of curves Automated causal hypotheses
Actionable? You guess the fix Suggests root causes (LR, Init, Data)
Integration Separate dashboard One line of code in your loop
Privacy Data sent to cloud 100% Local (unless you opt-in)

"TensorBoard tells you when it failed. NeuralDBG tells you why."

Latest: v1.5.0 (July 5, 2026)

  • Tier 1 Black-Swan detection: 96% — GNN 88%, MoE 100%, Diffusion 100% (104/108 bugs detected)
  • Tier 2 Black-Swan detection: 94% — FlashAttention 100%, Neural ODE 100%, Quantized 83% (102/108)
  • 200-architecture validation — 99.4% detection (1,193/1,200 bug injections) across 6 families (MLP/CNN/RNN/Transformer/Hybrid/Black-Swan); canonical numbers in paper_number_audit.md
  • NeuralPrune v0.1 — Non-destructive redundancy diagnostic: dead neurons, low-rank weights, quantization opportunities
  • LSTM/GRU support — Forward hooks unwrap RNN output tuples. Per-gate gradient tracking (input/forget/cell/output)
  • Architecture fuzzer — 0 crashes, 19/20 injected bugs detected (1 documented asymptomatic: LayerNorm neutralizes fp16 overflow); deterministic (seed 42, audit §2.2)
  • Stress test suite — 15/15 tests pass: 10x gradients, NaN/Inf, fp16, 100-layer depth, 1K token attention
  • GPU classifier — Qwen2-0.5B + LoRA (v5, 108 examples, 6 families); changelog "93.7% accuracy" withdrawn — re-verification scored 13.9% (15/108) with category collapse (audit §2.7)
  • Aquarium web dashboard — Zero-dependency HTML causal viewer. Open Aquarium
  • 2 upstream diagnostic test PRs — svdvals NaN (#188053) + gradient health tests (#188923); F.normalize retiré (comportement voulu confirmé par albanD)
  • 100% detection on DeepMLP (6/6 bugs) | 96% Tier 1 black-swans | 94% Tier 2 black-swans
  • 2 upstream PRs (open) to PyTorch | CI benchmark workflow on GitHub Actions
  • E2E RNN pipeline — detect→diagnose→fix→validate on LSTM. 2/4 bugs auto-fixed.

Key Features

  • Semantic Event Extraction: Detects meaningful transitions in training dynamics
  • Causal Compression: Identifies first occurrences and propagation patterns
  • Post-Mortem Reasoning: Provides ranked hypotheses about failure causes
  • Optimizer Instability Detection: Tracks loss plateaus, spikes, and divergence
  • Data Anomaly Detection: Catches NaN, Inf, and distribution shifts in inputs
  • Event Collapsing: Merges sequential events into summary traces
  • Compiler-Aware: Operates at module boundaries to survive torch.compile
  • Non-Invasive: Wraps existing PyTorch training loops without code changes
  • Minimal API: Focused on explanations, not raw data dumps
  • Diagnostic package export: JSON export for the Neural Suite visualizer (private beta)

Quick Start

Installation

pip install neuraldbg

Basic Usage

import torch
import torch.nn as nn
from neuraldbg import NeuralDbg

# Your existing model and training setup
model = nn.Sequential(nn.Linear(10, 5), nn.ReLU(), nn.Linear(5, 1))
optimizer = torch.optim.SGD(model.parameters(), lr=0.01)
criterion = nn.MSELoss()

# Wrap your training loop
with NeuralDbg(model) as dbg:
    for step, (inputs, targets) in enumerate(dataloader):
        optimizer.zero_grad()

        outputs = model(inputs)
        loss = criterion(outputs, targets)
        loss.backward()
        dbg.record_loss(loss.item())
        optimizer.step()

# After training failure (or anytime), query for explanations
explanations = dbg.explain_failure()
if explanations:
    print(explanations[0])  # "Gradient vanishing originated in layer 'linear1' at step 234..."
else:
    print("No failure detected — training looks healthy.")

Inference API

# Get ranked causal hypotheses for the failure
hypotheses = dbg.get_causal_hypotheses()

# Query specific causal chains
chain = dbg.trace_causal_chain('vanishing_gradients')

# Check for coupled failures
couplings = dbg.detect_coupled_failures()

# Export diagnostic package (JSON) for Neural Suite visualizer
dbg.export_aquarium_package('debug_session.json')

Optimizer Instability Detection

with NeuralDbg(model) as dbg:
    for step in range(num_steps):
        dbg.step = step
        output = model(inputs)
        loss = criterion(output, targets)
        loss.backward()
        dbg.record_loss(loss.item())
        optimizer.step()

# Detect loss plateaus, spikes, or divergence
hypotheses = dbg.explain_failure("optimizer_instability")
for h in hypotheses:
    print(h.description)

Data Anomaly Detection

Data anomalies (NaN, Inf, distribution shifts) are detected automatically from layer inputs during the forward pass:

with NeuralDbg(model) as dbg:
    # ... training loop ...
    pass

hypotheses = dbg.explain_failure("data_anomaly")
for h in hypotheses:
    print(h.description)  # "NaN values detected in input to layer 'linear1'..."

Supported Architectures

Validated on 200 architectures, 1,200 bug injections (combinatorial sweep, 2026-08-13 run; canonical, artifact-verifiable figures per paper_number_audit.md) plus 4 out-of-sample production architectures.

Family Configs Detection Status
MLP (deep, residual, bottleneck) 38 100% (228/228)
CNN (Conv2d, varying kernel/depth/norm) 33 99.5% (197/198)
Transformer (encoder, varying heads/depth) 33 100% (198/198)
RNN (LSTM/GRU, varying depth/width/bidir) 33 100% (198/198)
Hybrid 30 100% (180/180)
Black-Swan (GNN, MoE, Diffusion, RL, RAG, FlashAttn, NeuralODE) 33 97% (192/198)
Overall 200 99.4% (1,193/1,200)

RNN reached 100% (2026-08-13) after fixing a builder artifact: out[:, -1, :] zeroed the reverse-direction W_hh gradient on bidirectional LSTM (last reverse step = first step from h0=0), so healthy bi-LSTMs looked "vanishing" (baseline 40 events) and pushed buggy runs under threshold. Fix: temporal mean pooling + family-adaptive thresholds (audit §2.1d). Remaining 7/1200: 1 CNN gelu zero_init and 6 FlashAttn zero_init/nan_data, masked by the engine's absolute-bound saturation heuristic (|x|>0.95) firing on unbounded Linear outputs — a documented engine limitation (P2b, audit §2.1d item 4). FlashAttn improved 9/18 → 12/18 via register_composite_hook on nn.MultiheadAttention. Hybrid reached 100% after fixing a generator bug: the 18 RNN-composite configs crashed at step 0 (LSTM shape misuse) and were previously counted as undetected — not a detection limit (paper §5.2 note i, audit §2.1b).

By Bug Type (200 configs each)

Bug Detection Difficulty
Optimizer divergence 100% Easy
Vanishing gradients 97.5% Easy
Exploding gradients 96.5% Easy
Dead activations (bias) 94.5% Moderate
NaN in data 90.5% Moderate
Zero initialization 80% Moderate

Out-of-Sample (4 production architectures, never seen in calibration)

ResNet-18 6/6 · ViT-Tiny 6/6 · EfficientNet-B0 6/6 · Mamba-Mini 6/6 (all 6 bugs genuinely injected via arch-agnostic injectors; 0 crashes, 0 false positives — healthy baselines: 1/2/0/0 events). Overall 24/24 (100%)python validate_oos.py. History: an initial "Mamba 0/6 crash" verdict was a builder bug (torch.silu, removed in torch ≥2.13), fixed and re-run; the 21/24 run used ResNet-only injectors that were no-ops on the other architectures; see paper_number_audit.md §2.5b–2.5c.

Reproduce: python validate_combinatorial.py --full (200 configs, ~4 min on CPU).

Detailed results: combinatorial_results.json |

Supported Failure Types

Failure Type Description
vanishing_gradients Root cause + saturation coupling
exploding_gradients First layer to explode
dead_neurons Neuron death in activation layers
saturated_activations Activation saturation patterns
optimizer_instability Loss plateaus, spikes, divergence
data_anomaly NaN/Inf/distribution shift in inputs

Architecture

Core Components

  • Semantic Event Extractor: Detects meaningful transitions in learning dynamics
  • Causal Compressor: Identifies patterns and propagation in training failures
  • Post-Mortem Reasoner: Generates ranked hypotheses about failure causes
  • Compiler-Aware Monitor: Operates at safe boundaries for optimization compatibility

Event Types

Event Type Source Detects
gradient_health_transition Backward hooks Vanishing, exploding, saturated gradients
activation_regime_shift Forward hooks Dead neurons, saturated activations
optimizer_instability record_loss() Loss plateaus, spikes, divergence
data_anomaly Forward hooks (inputs) NaN, Inf, distribution shifts

Editions

Edition Package License Features
Core pip install neuraldbg MIT Hooks, events, export JSON, basic heuristics
Engine pip install neuraldbg-engine Proprietary Full causal inference, detailed hypotheses, coupling detection

The Core edition works standalone with basic heuristic fallbacks. Install the Engine for advanced causal reasoning.

Target Users

  • ML Researchers seeking causal explanations for training failures
  • PhD Students analyzing learning dynamics in novel architectures
  • Research Engineers understanding optimization instabilities

Limitations

  • PyTorch only
  • Focus on semantic events, not tensor inspection

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new functionality
  4. Ensure all tests pass
  5. Submit a pull request

Developer Setup

make bootstrap
source .venv/bin/activate  # Linux/macOS
# or
.venv\Scripts\activate     # Windows

Release Methodology

Versioning: SemVer (MAJOR.MINOR.PATCH). Changelog in CHANGELOG.md (Keep a Changelog). Cadence: Monthly minor releases; patches as needed for fixes/security. Process: git tag vX.Y.Z.github/workflows/publish.yml → PyPI (neuraldbg) + GitHub Release. Support: latest minor (1.5.x) actively maintained; see SECURITY.md and GOVERNANCE.md. Governance: GOVERNANCE.md (2 maintainers), CONTRIBUTING.md, CODE_OF_CONDUCT.md, .github/CODEOWNERS.

License

MIT License - see LICENSE.md for details.

Documentation

Citation

If you use NeuralDBG in your research, please cite:

@misc{neuraldbg2026,
  title={NeuralDBG: A Causal Inference Engine for Deep Learning Training Dynamics},
  author={SENOUVO Jacques-Charles Gad},
  year={2026},
  url={https://github.com/LambdaSection/NeuralDBG}
}

About

Causal debugger for PyTorch training: tells you WHY it failed (vanishing/exploding gradients, NaN, dead neurons) with layer+step root cause. One line in your loop.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

24 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages