Metadata-Version: 2.1
Name: lightning-template
Version: 1.12.1
Summary: A template wrapper for pytorch-lightning.
Author-email: shenmishajing <shenmishajing@gmail.com>
License: MIT License
Project-URL: Homepage, https://github.com/shenmishajing/lightning_template
Project-URL: Repository, https://github.com/shenmishajing/lightning_template
Project-URL: Documentation, https://lightning-template.readthedocs.io
Project-URL: Issues, https://github.com/shenmishajing/lightning_template/issues
Project-URL: Changelog, https://github.com/shenmishajing/lightning_template/blob/main/docs/get_started/changelog.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: GPU :: NVIDIA CUDA
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Natural Language :: English
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lightning>=2.0.0
Requires-Dist: jsonargparse[argcomplete,fsspec,ruyaml,signatures,urls]
Requires-Dist: scikit-learn
Provides-Extra: optional
Requires-Dist: wandb; extra == "optional"
Requires-Dist: rich; extra == "optional"
Requires-Dist: thop; extra == "optional"
Provides-Extra: deps
Requires-Dist: lightning-template[optional]; extra == "deps"
Provides-Extra: dev-commit
Requires-Dist: pre-commit; extra == "dev-commit"
Requires-Dist: commitizen; extra == "dev-commit"
Provides-Extra: dev-doc
Requires-Dist: sphinx; extra == "dev-doc"
Requires-Dist: sphinx-autobuild; extra == "dev-doc"
Requires-Dist: sphinx-book-theme; extra == "dev-doc"
Requires-Dist: sphinx-autoapi; extra == "dev-doc"
Requires-Dist: myst-parser; extra == "dev-doc"
Requires-Dist: sphinx_design; extra == "dev-doc"
Provides-Extra: dev-build
Requires-Dist: build; extra == "dev-build"
Provides-Extra: dev-test
Requires-Dist: tox; extra == "dev-test"
Requires-Dist: pytest; extra == "dev-test"
Requires-Dist: pytest-cov; extra == "dev-test"
Provides-Extra: dev-profile
Requires-Dist: torch_tb_profiler; extra == "dev-profile"
Provides-Extra: dev-core
Requires-Dist: lightning-template[dev-commit]; extra == "dev-core"
Provides-Extra: dev
Requires-Dist: lightning-template[dev-build,dev-core,dev-doc,dev-profile,dev-test]; extra == "dev"
Provides-Extra: all
Requires-Dist: lightning-template[deps,dev]; extra == "all"

# 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>
