trainpulse 0.2.0__tar.gz

trainpulse-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[cli]"
+          pip install pytest ruff mypy
+
+      - name: Lint with ruff
+        run: ruff check src/ tests/
+
+      - name: Type check with mypy
+        run: mypy src/trainpulse/
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short

trainpulse-0.2.0/.gitignore

@@ -0,0 +1,22 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+*.so
+.venv/
+venv/
+env/
+.env
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+*.log
+.DS_Store
+Thumbs.db

trainpulse-0.2.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-04-10
+
+### Added
+- Add Weights & Biases callback integration
+- Add early stopping recommendation engine
+- Add example scripts for training monitoring
+
+## [0.1.0] - 2026-04-10
+
+### Added
+- Initial release: lightweight training health monitor
+

trainpulse-0.2.0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

trainpulse-0.2.0/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: trainpulse
+Version: 0.2.0
+Summary: Lightweight training health monitor. Detect loss spikes, gradient explosions, and NaN — 2 lines of code, no server, no signup.
+Project-URL: Homepage, https://github.com/stef41/trainpulse
+Project-URL: Repository, https://github.com/stef41/trainpulse
+Project-URL: Issues, https://github.com/stef41/trainpulse/issues
+Author: Zacharie Bhatti
+License: Apache-2.0
+License-File: LICENSE
+Keywords: deep-learning,gradient,health-check,loss,machine-learning,monitoring,pytorch,training
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: all
+Requires-Dist: click>=8.0; extra == 'all'
+Requires-Dist: rich>=13.0; extra == 'all'
+Requires-Dist: torch>=2.0; extra == 'all'
+Provides-Extra: cli
+Requires-Dist: click>=8.0; extra == 'cli'
+Requires-Dist: rich>=13.0; extra == 'cli'
+Provides-Extra: torch
+Requires-Dist: torch>=2.0; extra == 'torch'
+Description-Content-Type: text/markdown
+
+# trainpulse
+
+[![CI](https://github.com/stef41/trainpulse/actions/workflows/ci.yml/badge.svg)](https://github.com/stef41/trainpulse/actions/workflows/ci.yml)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
+
+Lightweight training health monitor. Detect loss spikes, gradient explosions, NaN/Inf, and plateaus — 2 lines of code, no server, no signup.
+
+<p align="center">
+  <img src="assets/report.svg" width="700" alt="trainpulse report" />
+</p>
+
+## Why trainpulse?
+
+| Feature | W&B / Neptune | TensorBoard | **trainpulse** |
+|---|---|---|---|
+| Setup | Account + API key | TF dependency | `pip install trainpulse` |
+| NaN/Inf detection | Manual | No | **Automatic** |
+| Loss spike alerts | Manual | No | **Automatic** |
+| Gradient monitoring | Manual | Manual | **Automatic** |
+| Plateau detection | No | No | **Automatic** |
+| Zero dependencies | No | No | **Yes** |
+| Works offline | No | Yes | **Yes** |
+
+## Install
+
+```bash
+pip install trainpulse
+```
+
+With PyTorch integration:
+
+```bash
+pip install trainpulse[torch]
+```
+
+With CLI:
+
+```bash
+pip install trainpulse[cli]
+```
+
+## Quick Start
+
+### Minimal — 2 lines
+
+```python
+from trainpulse import Monitor
+
+monitor = Monitor()
+for step in range(num_steps):
+    loss = train_step()
+    monitor.log("loss", step, loss)
+
+report = monitor.report()
+print(f"Health: {report.health_score:.0%}")
+```
+
+### Full training loop
+
+```python
+from trainpulse import Monitor, MonitorConfig
+
+config = MonitorConfig(
+    loss_spike_threshold=5.0,    # Alert if loss > 5x rolling average
+    grad_norm_threshold=100.0,   # Alert if gradient norm > 100
+    plateau_patience=200,        # Alert after 200 steps without improvement
+)
+
+monitor = Monitor(config)
+
+for step in range(num_steps):
+    monitor.step_start()
+
+    loss = train_step()
+    grad_norm = get_grad_norm()
+    lr = scheduler.get_last_lr()[0]
+
+    monitor.log("loss", step, loss)
+    monitor.log("grad_norm", step, grad_norm)
+    monitor.log("learning_rate", step, lr)
+    monitor.step_end(step)
+
+report = monitor.report()
+```
+
+### Callback API
+
+```python
+from trainpulse import TrainingCallback
+
+cb = TrainingCallback()
+for step in range(num_steps):
+    cb.on_step_begin(step)
+    loss = train_step()
+    cb.on_step_end(step, loss=loss, grad_norm=grad_norm, lr=lr)
+
+report = cb.report()
+```
+
+### Real-time alerts
+
+```python
+def my_alert_handler(alert):
+    print(f"⚠ {alert}")
+    # Or send to Slack, Discord, email...
+
+config = MonitorConfig(alert_callbacks=[my_alert_handler])
+monitor = Monitor(config)
+```
+
+<p align="center">
+  <img src="assets/alerts.svg" width="700" alt="trainpulse alerts" />
+</p>
+
+## Detectors
+
+| Detector | What it catches | Default threshold |
+|---|---|---|
+| **NaN/Inf** | NaN or Inf in any metric | Always on |
+| **Loss spike** | Sudden loss increase vs rolling average | 5x |
+| **Gradient explosion** | Gradient norm too large | 100.0 |
+| **Gradient vanishing** | Gradient norm too small | 1e-7 |
+| **LR anomaly** | Learning rate jumps | 10x change |
+| **Plateau** | No loss improvement | 100 steps |
+| **Step time** | Unusually slow steps | 3x average |
+
+## CLI
+
+Analyze training logs (JSONL format):
+
+```bash
+trainpulse analyze train.jsonl
+trainpulse analyze train.jsonl --json-out report.json
+trainpulse show report.json
+```
+
+Expected JSONL format:
+```json
+{"step": 0, "loss": 2.5, "grad_norm": 1.2, "learning_rate": 0.001}
+{"step": 1, "loss": 2.3, "grad_norm": 1.1, "learning_rate": 0.001}
+```
+
+## Health Score
+
+The health score (0.0–1.0) is computed from alert severity:
+
+- **Critical** alerts (NaN, gradient explosion): −0.15 each
+- **Warning** alerts (spikes, plateaus): −0.05 each
+- **Info** alerts: −0.01 each
+
+A score above 0.80 generally indicates healthy training.
+
+## API Reference
+
+### `Monitor(config=None)`
+
+Main class. Call `.log(name, step, value)` to record metrics.
+
+### `MonitorConfig`
+
+| Parameter | Default | Description |
+|---|---|---|
+| `loss_spike_threshold` | 5.0 | Multiplier over rolling average |
+| `loss_spike_window` | 50 | Rolling window size |
+| `grad_norm_threshold` | 100.0 | Max acceptable gradient norm |
+| `grad_vanish_threshold` | 1e-7 | Min acceptable gradient norm |
+| `check_nan` | True | Enable NaN/Inf detection |
+| `lr_change_threshold` | 10.0 | Max LR change ratio per step |
+| `plateau_patience` | 100 | Steps without improvement |
+| `plateau_min_delta` | 1e-5 | Minimum improvement delta |
+| `step_time_spike_threshold` | 3.0 | Step time spike multiplier |
+| `alert_callbacks` | [] | Functions called on each alert |
+
+### `TrainingReport`
+
+| Property | Type | Description |
+|---|---|---|
+| `.health_score` | float | 0.0 (terrible) to 1.0 (perfect) |
+| `.is_healthy` | bool | True if no critical alerts |
+| `.n_warnings` | int | Number of warning alerts |
+| `.n_critical` | int | Number of critical alerts |
+| `.alerts` | list[Alert] | All triggered alerts |
+| `.metrics_summary` | dict | Per-metric min/max/mean/last |
+
+## See Also
+
+Part of the **stef41 LLM toolkit** — open-source tools for every stage of the LLM lifecycle:
+
+| Project | What it does |
+|---------|-------------|
+| [tokonomics](https://github.com/stef41/tokonomics) | Token counting & cost management for LLM APIs |
+| [datacrux](https://github.com/stef41/datacrux) | Training data quality — dedup, PII, contamination |
+| [castwright](https://github.com/stef41/castwright) | Synthetic instruction data generation |
+| [datamix](https://github.com/stef41/datamix) | Dataset mixing & curriculum optimization |
+| [toksight](https://github.com/stef41/toksight) | Tokenizer analysis & comparison |
+| [ckpt](https://github.com/stef41/ckpt) | Checkpoint inspection, diffing & merging |
+| [quantbench](https://github.com/stef41/quantbench) | Quantization quality analysis |
+| [infermark](https://github.com/stef41/infermark) | Inference benchmarking |
+| [modeldiff](https://github.com/stef41/modeldiff) | Behavioral regression testing |
+| [vibesafe](https://github.com/stef41/vibesafe) | AI-generated code safety scanner |
+| [injectionguard](https://github.com/stef41/injectionguard) | Prompt injection detection |
+
+## License
+
+Apache-2.0