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.21.7.24.tar.gz (8.3 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.21.7.24.tar.gz.

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.21.7.24.tar.gz
Algorithm Hash digest
SHA256 ad862e75f9044a09e7dd0bd2985f3451150962ee112ec12cb75262329d367faf
MD5 089cb38a3fa61d843aa65badd1e18334
BLAKE2b-256 063c1b0162f24709d371a2d1ddb957444927fe278b4f0eb69fe183c71aed9912

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.21.7.24-py3-none-any.whl
Algorithm Hash digest
SHA256 e0a2672a06ef11fa547139ff8b8f128bb0eb55010eb4fc9933bbbb7f39bcebc1
MD5 81c7389e9b145361305b1fef4e12b3e9
BLAKE2b-256 b2909457f50cc03d02f530443a32fd2a969f94d271e27f549107d7858ca13b56

See more details on using hashes here.

Provenance

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