Skip to content

autotrainer 0.14.0

Choose a tag to compare

@github-actions github-actions released this 31 Jul 20:12
13506d5

[0.14.0] - 2026-07-31

Added

  • Unified autotrainer.train() 1-Line API. Single-function execution across PyTorch, Scikit-Learn, XGBoost, LightGBM, CatBoost, and TensorFlow/Keras. Automatically infers loss/optimizer/scheduler, configures thread/replica batch scaling, executes training, serializes model checkpoints, and reports performance summary.

  • Model Checkpoint save_path= Parameter. Added save_path parameter to train(), fit(), and tune(), enabling direct model serialization (.pt, .joblib, .keras, .json) without requiring separate save0() or joblib.dump() code lines.

  • Automatic Summary & Process Group Cleanup. train(), fit(), and tune() now automatically trigger finish(checkpoint=save_path) on exit, eliminating separate autotrainer.finish() calls.

  • autotrainer.finish(checkpoint=...) & SummaryTracker API across all backends. One-line post-training summary reporter and cleanup helper across all supported frameworks (torch, sklearn, xgboost/lightgbm, and tensorflow/keras). Displays formatted summary box with cluster hardware, topology, VRAM usage %, training throughput (samples/sec), loss metrics, active optimizations, and health triage, then automatically destroys process groups on exit.

  • Model Parameter Count & Executive Summary Formatting. SummaryTracker now calculates total trainable model parameters (Model Parameters), formats learning rates cleanly (lr=4.21e-05), detects active LR schedulers (LR Schedule), and renders Autotrainer Active Optimizations cleanly after Artifacts & Checkpoint.

  • Top-level autotrainer.log_epoch() and autotrainer.step() functions. Exported in __all__ for recording epoch metrics and step losses directly into the active summary.

  • Auto-managed DDP Epoch Shuffling (_AutoEpochDataLoader). autotrainer.prepare() now auto-wraps DataLoaders to advance DistributedSampler.set_epoch(epoch) automatically on every epoch loop iteration, eliminating the need for explicit autotrainer.set_epoch() calls.

  • Dynamic Plain-English Optimizations Catalog. Summary engine dynamically detects active optimizations across 25 supported methods (TF32, AMP, FlashAttention SDPA, cuDNN benchmark, DDP, FSDP, CPU parameter offloading, CUDA allocator tuning, DataLoader workers, SLURM scratch, etc.) and prints human-readable explanations.

  • Framework Diagnostics in autotrainer doctor. Enhanced autotrainer doctor to print exact version strings for installed ML libraries (torch v2.12.1+cpu, sklearn v1.9.0, lightgbm v4.6.0, etc.).

  • CI Example Test Job (test-examples). Added automated workflow job running all 8 example scripts (pytorch_auto, pytorch_fit, pytorch_tune, pytorch_ddp, pytorch_optimize, sklearn_example, xgboost_example, tensorflow_example) on PRs and releases.

  • Internal Architecture Catalog & Market Positioning. Documented all 25 optimization methods in docs/internal/architecture.md and positioning vs PyTorch Lightning/Accelerate in docs/internal/market-positioning.md.

  • Unit Test Coverage. Added tests/test_summary.py covering SummaryTracker, finish(), and dynamic optimization text detection. Updated pretend_cuda fixture in tests/conftest.py with max_memory_allocated.

  • Prerelease channel. A version that is not exactly X.Y.Z (an rc, a,
    b, .dev, or .post suffix) is now published to TestPyPI and marked as a
    prerelease on GitHub, instead of going to production PyPI. This exists so the
    SLURM validation runbook can pip install and exercise a real wheel before
    the version number is spent - PyPI versions are immutable, so validating
    against a production release means any defect found costs a new version. The
    routing tests for == 'false' rather than == 'true', so only an explicit
    "this is stable" reaches PyPI; anything unexpected goes to TestPyPI.

  • Release notes for a prerelease fall back to the [Unreleased] changelog
    section, since an RC has no section of its own. An empty or missing section
    is still a hard failure.

  • cuda-watchdog CI job. When the self-hosted GPU runner is offline,
    test-cuda sits queued indefinitely and GPU coverage silently drops to zero
    while the run still looks green - timeout-minutes does not help, because it
    only starts counting once a runner accepts the job. The watchdog notices and
    annotates the run.

  • tests/test_docs.py: checks that relative doc links and heading anchors
    resolve, that everything in __all__ is mentioned in the docs, and that no
    message promises a version that has not shipped. Every one of these
    corresponds to a real defect found by hand in this release.

  • .github/scripts/ is now linted and format-checked in CI; it writes the
    release notes and was previously unchecked.

Fixed

  • The TypeError raised for the removed tune(train_loader=...)/val_loader=
    aliases said they "were removed in 1.0". 1.0 has not shipped - they were
    removed in 0.12. The message pointed users at a release that does not exist.
  • Excluded yanked PyPI package build==1.5.1 from pyproject.toml dev dependencies (build!=1.5.1) and updated uv.lock.

Changed

  • Automatically register get_active_summary() when backend entry points (prepare() and scope()) are invoked.
  • Documentation restructured. The README was 551 lines with 59% of it under a
    single ## Use heading nested four levels deep; it is now a ~220-line
    entry point (pitch, install, quickstart, an entry-point table, and how
    autotrainer differs from Lightning / Accelerate / Ray / Optuna), with the
    reference material moved to docs/guide/. Also fixes two sections titled
    "auto batch size" 244 lines apart covering different features, and a
    paragraph that continued the quickstart 220 lines after it was interrupted.
  • docs/README.md claimed to list everything in autotrainer.__all__ but
    omitted TrainingMonitor (added 0.12) and augment_batch (added 0.13).