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

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.19.10.6.tar.gz (8.5 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.19.10.6.tar.gz.

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.19.10.6.tar.gz
Algorithm Hash digest
SHA256 1e7d50f78a847590d80e8a5c5a4cb7df8290a040497f095a34cc04d0ba58a7d4
MD5 4a6bab193db3c497ef5348de197ffdbd
BLAKE2b-256 ed7d18a5a9c342dad453a5714159feabdbe7733b5182612476bd19e0b4195a05

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for lightning_trainer_utils-2025.5.19.10.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c6229b5d66af05de722eb3947f8bae1517499436a2ea9f723832e0e4ba6050a1
MD5 50198129c1e0717df0dca240b6d97ccb
BLAKE2b-256 1500c82048e1289f46518b7db9ef6ef29ff971f1cac2be21512cd123ad98c3ac

See more details on using hashes here.

Provenance

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