Lightning-AI / deep-learning-project-template

Pytorch Lightning code guideline for conferences
Apache License 2.0
1.24k stars 272 forks source link

cookiecutter #6

Open dvolgyes opened 4 years ago

dvolgyes commented 4 years ago

As it was mentioned in another ticket, maybe it is time to modernize the example a bit. If/when this happens, it would be nice to consider 'cookiecutter' as a template engine, so the instructions, like 'delete this', 'make a directory', etc., could be automated nicely. E.g. similar to this template: https://github.com/jeannefukumaru/cookiecutter-ml

Borda commented 4 years ago

@dvolgyes looks nice, mind send a PR?

vv111y commented 3 years ago

Hi,
Any update on this?

MischaPanch commented 2 years ago

Hi @Borda . If you are interested in this feature, I could prepare an MR. I have done this for templates in the past so it wouldn't be too difficult.

I would also suggest to test the cookiecutter templating (including CI) and the only reliable way I know of, is to actually run it and commit the resulting project to a dedicated repo to let the CI run on the result of the template. I used this mechanism for my own template (for python libraries), where commits to https://github.com/appliedAI-Initiative/pymetrius lead to code being comitted to https://github.com/appliedAI-Initiative/pymetrius_output. Setting this up requires setting new CI variables in this project and having something like https://github.com/PyTorchLightning/deep-learning-project-template_output.

What do you think?