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-2.0.1.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

lightning_boost-2.0.1-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lightning_boost-2.0.1.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.13 Linux/5.15.0-1041-azure

File hashes

Hashes for lightning_boost-2.0.1.tar.gz
Algorithm Hash digest
SHA256 d765210af64d97a1b8a7d4eb55da85407b29a0cd0d0d47618fdb76c0456d67ca
MD5 591a5a7f38b1f260ce95b9fc6f26b5e4
BLAKE2b-256 d05880482d21ddf314db7cf44336ff96009d99053f449c4fe0fda5adcf33cb2f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for lightning_boost-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ee6284d4596e6b6be036a0d1c98e7737cd935792f99546f95f75d319408b58ee
MD5 2811b50639f2e47a72a701b2360a8670
BLAKE2b-256 efc88ebdb22ed87c659ec90165f1c3bcbeecceaaa4850974fd2407a71a1ca512

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