lightning-template 1.12.4
A template wrapper for pytorch-lightning.
License: MIT License
Requires Python: <3.13,>=3.8

# Lightning Template

[![platform](https://img.shields.io/badge/platform-Linux%7CWindows%7CmacOS-blue)](https://lightning-template.readthedocs.io)
[![PyPI](https://img.shields.io/pypi/v/lightning-template)](https://pypi.org/project/lightning-template)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lightning-template)](https://pypi.org/project/lightning-template/)
[![license](https://img.shields.io/pypi/l/lightning_template)](https://github.com/shenmishajing/lightning_template/blob/master/LICENSE)
[![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/lightning_template)](https://pypi.org/project/lightning_template/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter)
[![Google Style](https://img.shields.io/badge/%20style-google-3666d6.svg)](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings)
[![codecov](https://codecov.io/gh/shenmishajing/lightning_template/branch/main/graph/badge.svg)](https://codecov.io/gh/shenmishajing/lightning_template)
[![Contributors](https://img.shields.io/github/contributors/shenmishajing/lightning_template.svg)](https://github.com/shenmishajing/lightning_template/graphs/contributors)
[![Publish status](https://github.com/shenmishajing/lightning_template/actions/workflows/release.yml/badge.svg)](https://github.com/shenmishajing/lightning_template/actions/workflows/release.yml)
[![pre_commit_hooks status](https://github.com/shenmishajing/lightning_template/actions/workflows/check_pre_commit_hooks.yml/badge.svg)](https://github.com/shenmishajing/lightning_template/actions/workflows/check_pre_commit_hooks.yml)
[![Pytest status](https://github.com/shenmishajing/lightning_template/actions/workflows/test.yml/badge.svg)](https://github.com/shenmishajing/lightning_template/actions/workflows/test.yml)
[![Documentation Status](https://readthedocs.org/projects/lightning-template/badge/?version=latest)](https://lightning-template.readthedocs.io/en/latest/?badge=latest)

[📘Documentation](https://lightning-template.readthedocs.io) |
[🛠️Installation](https://lightning-template.readthedocs.io/en/latest/get_started/installation.html) |
[🤔Reporting Issues](https://github.com/shenmishajing/lightning_template/issues)

Lightning Template is a generic project template lib based on [pytorch lightning](https://pytorch-lightning.readthedocs.io/en/stable/) for [project-template](https://github.com/shenmishajing/project_template). See the [documentation](https://lightning-template.readthedocs.io) for more details.

## Installation

```bash
pip install lightning-template
```

See [installation docs](docs/get_started/installation.md) for details.

## Contribution

See [contribution docs](docs/get_started/contribution.md) for details.

## Release versions

We use [setuptools_scm](https://github.com/pypa/setuptools_scm/) for versioning. For the versions available, see the [tags](https://github.com/shenmishajing/lightning_template/tags) on this repository.

## License

This project is licensed under the MIT License.

## Star History

<picture>
  <source
    media="(prefers-color-scheme: dark)"
    srcset="
      https://api.star-history.com/svg?repos=shenmishajing/lightning_template&type=Date&theme=dark
    "
  />
  <source
    media="(prefers-color-scheme: light)"
    srcset="
      https://api.star-history.com/svg?repos=shenmishajing/lightning_template&type=Date
    "
  />
  <img
    alt="Star History Chart"
    src="https://api.star-history.com/svg?repos=shenmishajing/lightning_template&type=Date"
  />
</picture>