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.20.10.20.tar.gz (8.7 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.20.10.20.tar.gz.

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.20.10.20.tar.gz
Algorithm Hash digest
SHA256 bab37bdf26159b31e1961474a8df445f52c5efbd0712e1c2fe27eecf47cf8e8e
MD5 bd489e842a581be110671f7d475a12f9
BLAKE2b-256 3c670c435694b06ee36f9e774dc9e3efbf2d69876c1e168eed4face4648bae90

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightning_trainer_utils-2025.5.20.10.20.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.20.10.20-py3-none-any.whl.

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.20.10.20-py3-none-any.whl
Algorithm Hash digest
SHA256 b3ec343a56518ff1e69eba2d0f085304da5e1501080d0ab723b4ac844d96a852
MD5 704cffa05446a20103e81cffc7e74107
BLAKE2b-256 1863f015e52d4c119104ea3bba44a8584c70ab1f75e21a6c653bb246765cb532

See more details on using hashes here.

Provenance

The following attestation bundles were made for lightning_trainer_utils-2025.5.20.10.20-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