Skip to main content

A Python package for using PyTorch Lightning with custom callbacks and model wrappers.

Project description

PyPI version

PyTorch Lightning Trainer Utilities

Installation

pip install lightning-trainer-utils

ML Model Assumptions

forward

  • The model wrapper uses the forward function as follows:
    output = self.model(**x, **self.forward_kwargs)
    return ModelOuput(**output)

It expects batch as dict and returns a dict with keys [loss, report, output].

return

  • ML model should return a dict with the following keys:
    • loss
    • report
    • output [optional]

Trainer

Global Step

batch_step = num_samples / (batch_size * num_devices) trainer_global_step = num_samples / (batch_size * num_devices * grad_accumulation) SaveCheckpoint also use trainer_global_step.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lightning_trainer_utils-2025.5.26.15.18.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file lightning_trainer_utils-2025.5.26.15.18.tar.gz.

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.26.15.18.tar.gz
Algorithm Hash digest
SHA256 96ae5d8e5e71dbd07dc266f882833137729e8374ca92caf9673bc1c407f5b5e6
MD5 abd2bc9ebfa2c0bad073f5a2d84665bd
BLAKE2b-256 5a5dd4726212883dcad19cc4f0ce6810ea6ac251ecb86afa7c471fe25b55dfd2

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightning_trainer_utils-2025.5.26.15.18.tar.gz:

Publisher: workflow.yaml on manavmahan/lightning-trainer-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lightning_trainer_utils-2025.5.26.15.18-py3-none-any.whl.

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.26.15.18-py3-none-any.whl
Algorithm Hash digest
SHA256 8ef3280afa08b51dcdaee63a1367512b9dcd85fe36a6f2588f698210964dee42
MD5 0f699ff642515f316825dac98ac8e697
BLAKE2b-256 cd976851282a82c869ba02a33ade28ecff4f8bbe6a249e38ac10dbe7a909f201

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightning_trainer_utils-2025.5.26.15.18-py3-none-any.whl:

Publisher: workflow.yaml on manavmahan/lightning-trainer-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page