Skip to main content

PyTorch Lightning extension for faster model development.

Project description

Lightning-Boost

PyPI PyPI - Python Version codecov CI Status Documentation Status License

Extension of the PyTorch Lightning framework to develop deep learning models in PyTorch even faster.

PyTorch Lightning already saves its versed users a lot of time, as large chunks of the PyTorch code being necessary to train deep neural networks are actually boilerplate. However, with parts of the structure and code still being shared by most not too exotic projects, there is potential for further optimization.

In essence, Lightning-Boost was born out of the need to not create a codebase from scratch for every deep learning project. It provides three key features that help users to develop their models not only faster, but also in a more structured way:

Command Line Interface and Configuration Files

Powered by the Lightning CLI, Lightning-Boost unifies the configuration of deep learning models and their training process. This is accompanied by YAML-based configuration files that can be generated automatically and be used instead of mile-long parametrizations in run-scripts calls. And the best: A single line of code in the run-script is sufficient, extensive ArgumentParser definitions are now a thing of the past.

Standardized Project Structure

Lightning-Boost also unifies the structure of a deep learning project in a highly modularized fashion. It provides a clear logical separation between a model, which takes a well-defined input and produces -- as a function -- an equally well-defined output, and a system, which operates on one or more models, given data, and manages the whole training process, as already recommended by PyTorch Lightning. Moreover, Lightning-Boost suggests a directory structure that does not necessarily have to be used, but perfectly fits into this logical framework and helps to stay on top of things.

Base Classes for Common Functionality

As both the management of the training process and datasets share some common functionality across projects, respectively, Lightning-Boost comes with two base classes for the corresponding concepts of a system and a datemodule. Analogously, further base classes are provided for models, datasets and many other components. When developing for a new project, users need to implement only a small number of methods that contain the exact functionality specific to their tasks.

Installation

Simply install via pip:

pip install lightning-boost

Getting started

For newcomers, it is recommended to work through the tutorials. Basic knowledge of PyTorch and PyTorch Lightning is assumed.

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_boost-1.0.0.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

lightning_boost-1.0.0-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file lightning_boost-1.0.0.tar.gz.

File metadata

  • Download URL: lightning_boost-1.0.0.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.11 Linux/5.15.0-1038-azure

File hashes

Hashes for lightning_boost-1.0.0.tar.gz
Algorithm Hash digest
SHA256 754c7a057bf6ed4948edd6304202d1ab20d6fe24f5880f7880d4836ab92c9424
MD5 c3820c6f894cd10eea77fdd4ba1e8a49
BLAKE2b-256 96bc714fba5fa4fbdf5637b90019e3e942cb25bcb5a43df6ac8239b6957f8f50

See more details on using hashes here.

File details

Details for the file lightning_boost-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: lightning_boost-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.11 Linux/5.15.0-1038-azure

File hashes

Hashes for lightning_boost-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17c77a9b02f667cd6a39d752a7eceebc40c4e0a9c2b1943ee1ddc1687165554d
MD5 0b5ad465024e8b7e62d3010b320d7c48
BLAKE2b-256 21893c9de644ce041e60e9af9a8e5ed4c635f8dc8d0fcc1c62749babf493bbb8

See more details on using hashes here.

Supported by

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