https://github.com/npurson/tmpl

⚡ A template for rapid & flexible DL experimentation development, powered by Lightning & Hydra following best practice.
https://github.com/npurson/tmpl

hydra pytorch pytorch-lightning pytorch-lightning-template

Last synced: 3 months ago
JSON representation

⚡ A template for rapid & flexible DL experimentation development, powered by Lightning & Hydra following best practice.

• Host: GitHub
• URL: https://github.com/npurson/tmpl
• Owner: npurson
• License: mit
• Created: 2022-03-01T10:57:17.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-07-25T13:01:47.000Z (6 months ago)
• Last Synced: 2025-07-25T20:06:32.451Z (6 months ago)
• Topics: hydra, pytorch, pytorch-lightning, pytorch-lightning-template
• Language: Python
• Homepage:
• Size: 1.64 MB
• Stars: 21
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ***⚡ [TmPL](): [T]()e[mpl]()ate for [P]()ytorch [L]()ightning***

![](https://img.shields.io/badge/Python-3.9%2B-blue)

![](https://img.shields.io/badge/PyTorch-2.1%2B-red)

![](https://img.shields.io/badge/Lightning-2.5-blue)

![](https://img.shields.io/badge/Hydra-1.3-lightgrey)

[![](https://img.shields.io/github/license/npurson/tmpl)](LICENSE)

![](https://img.shields.io/badge/version-v2.1-blue)

[Lightning Docs](https://lightning.ai/docs/pytorch/stable/)  • 

[Installation](#installation)  • 

[Usage](#usage)  • 

[Reference](#reference)  • 

[Contributing](#contributing)  • 

[License](#license)

A template for rapid & flexible DL experimentation development, powered by [Lightning](https://lightning.ai/) & [Hydra](https://hydra.cc/) following best practice.







## Installation

```

pip install -r requirements.txt

```

## Usage

0. **Setup**

    ```bash

    export PYTHONPATH=`pwd`:$PYTHONPATH

    ```

1. **Training**

    ```bash

    python tools/train.py [--config-name config[.yaml]] [trainer.devices=4] [data.loader.batch_size=16]

    ```

    * Specify the configuration file using `--config-name`.

    * Refer to the following for detailed information on Hydra's override syntax.

        * https://hydra.cc/docs/advanced/hydra-command-line-flags/

        * https://hydra.cc/docs/advanced/override_grammar/basic/

2. **Tips for Further Development**

    This framework is designed for flexibility and easy customization to meet users' specific needs.

    Useful comments and details on extending the framework can be found within the source code files.

## Reference

- [PyTorch Lightning Docs ↗](https://lightning.ai/docs/pytorch/stable/)

- [Hydra Docs ↗](https://hydra.cc/docs/intro/)

## Contributing

Contributions are welcome and appreciated! \

Feel free to open an issue or PR! 🎉

## License

Released under the [MIT](LICENSE) License.