Repository navigation
autotrainer 0.14.0
[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. Addedsave_pathparameter totrain(),fit(), andtune(), enabling direct model serialization (.pt,.joblib,.keras,.json) without requiring separatesave0()orjoblib.dump()code lines. -
Automatic Summary & Process Group Cleanup.
train(),fit(), andtune()now automatically triggerfinish(checkpoint=save_path)on exit, eliminating separateautotrainer.finish()calls. -
autotrainer.finish(checkpoint=...)&SummaryTrackerAPI across all backends. One-line post-training summary reporter and cleanup helper across all supported frameworks (torch,sklearn,xgboost/lightgbm, andtensorflow/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.
SummaryTrackernow calculates total trainable model parameters (Model Parameters), formats learning rates cleanly (lr=4.21e-05), detects active LR schedulers (LR Schedule), and rendersAutotrainer Active Optimizationscleanly afterArtifacts & Checkpoint. -
Top-level
autotrainer.log_epoch()andautotrainer.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 advanceDistributedSampler.set_epoch(epoch)automatically on every epoch loop iteration, eliminating the need for explicitautotrainer.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. Enhancedautotrainer doctorto 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.mdand positioning vs PyTorch Lightning/Accelerate indocs/internal/market-positioning.md. -
Unit Test Coverage. Added
tests/test_summary.pycoveringSummaryTracker,finish(), and dynamic optimization text detection. Updatedpretend_cudafixture intests/conftest.pywithmax_memory_allocated. -
Prerelease channel. A version that is not exactly
X.Y.Z(anrc,a,
b,.dev, or.postsuffix) 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 canpip installand 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-watchdogCI job. When the self-hosted GPU runner is offline,
test-cudasits queued indefinitely and GPU coverage silently drops to zero
while the run still looks green -timeout-minutesdoes 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
TypeErrorraised for the removedtune(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.1frompyproject.tomldev dependencies (build!=1.5.1) and updateduv.lock.
Changed
- Automatically register
get_active_summary()when backend entry points (prepare()andscope()) are invoked. - Documentation restructured. The README was 551 lines with 59% of it under a
single## Useheading 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 todocs/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.mdclaimed to list everything inautotrainer.__all__but
omittedTrainingMonitor(added 0.12) andaugment_batch(added 0.13).