lightning/examples/fabric/build_your_own_trainer
pre-commit-ci[bot] c0ec0decec
[pre-commit.ci] pre-commit suggestions (#18697)
Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jirka <jirka.borovec@seznam.cz>
Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
2023-10-03 22:07:21 +02:00
..
README.md BYOT example (#16938) 2023-03-06 10:26:18 +01:00
run.py ruff: replace isort with ruff +TPU (#17684) 2023-09-26 11:54:55 -04:00
trainer.py [pre-commit.ci] pre-commit suggestions (#18697) 2023-10-03 22:07:21 +02:00

README.md

Build Your Own Trainer (BYOT)

This example demonstrates how easy it is to build a fully customizable trainer for your LightningModule using Fabric. It is built upon lightning.fabric for hardware and training orchestration and consists of two files:

  • trainer.py contains the actual MyCustomTrainer implementation
  • run.py contains a script utilizing this trainer for training a very simple MNIST module.

Run

To run this example, call python run.py

Requirements

This example has the following requirements which need to be installed on your python environment:

  • lightning
  • torchmetrics
  • torch
  • torchvision
  • tqdm

to install them with the appropriate versions run:

pip install "lightning>=2.0" "torchmetrics>=0.11" "torchvision>=0.14" "torch>=1.13" tqdm