0.2.0

We are very pleased to present you NN Template 0.2.0!

Changelog for nn-template 0.2.0 (2022-03-01)

Summary

• Cookiecutter parametrization
• CI/CD Integration via GitHub Actions
• Automate testing of your projects
• Logic decoupling thanks to nn-template-core
• Advanced restore options for trainings
• Documentation website
• Support for Python logging (with colors!)

What's Changed

• Refactor configuration by @lucmos in #8
• Refactor project to a python package by @lucmos in #10
• Add tooling configuration by @lucmos in #9
• Refactor codebase to be compliant to the pre-commits by @lucmos in #11
• Refactor the project root management by @lucmos in #12
• Added wandb to .gitignore by @Flegyas in #14
• Refactor logging by @lucmos in #15
• Enable pin-memory if not on CPU by @lucmos in #16
• Factor our PyTorch Module from the Lightning Module by @lucmos in #17
• Force the .cache folder to be in the PROJECT_ROOT by @lucmos in #19
• Add the configuration to the Lightning checkpoints by @lucmos in #20
• Use extend-ignore instead of ignore in .flake8 by @lucmos in #21
• Fix formatting by @lucmos in #22
• Log the code used in the current experiment to wandb by @lucmos in #18
• Functionalities decoupling via external library (nn-core). by @Flegyas in #23
• Add tests by @lucmos in #24
• Implement resuming behaviour by @lucmos in #25
• Refactor NNLogger usages by @lucmos in #27
• Add CI on pre-commits and tests by @lucmos in #26
• Remove some trigger from the Test Suite workflow by @lucmos in #28
• Overwrite Lightning logging configuration by @lucmos in #29
• Ensure tags are defined asking interactively for them by @lucmos in #30
• Introduce the seed index concept by @lucmos in #31
• Force execution of init.py on direct execution by @lucmos in #33
• Move functions from template to core by @lucmos in #34
• Add functionality to upload the run files in the storage to wandb by @lucmos in #35
• Move ui_utils entirely to nn-core by @lucmos in #36
• Add dynamic parametrized badges for the Test Suite and docs by @lucmos in #45
• Fix files hashing in workflow cache keys by @lucmos in #46
• Add seed_index determinism test by @lucmos in #44
• Refactor references to organization name into grok-ai by @lucmos in #48
• Push the default version in mike on release by @lucmos in #49
• Improve docs status badge to monitor the github-pages environment by @lucmos in #50
• Fix mike rebasing and pushing logic on release by @lucmos in #51
• Add a DAG in the post hook interactive setup by @lucmos in #47
• Skip test if no dataset is provided by @Flegyas in #52
• Fix remote parametrization in the README by @lucmos in #53
• Fix type hint in dataset.py by @lucmos in #55
• Improve the "add git remote" message in the post hook by @lucmos in #54
• Update nn-template-core dependency to 0.0.7 by @lucmos in #56
• Update docs by @lucmos in #57
• Add custom collate function by @Flegyas in #58
• Set metadata as a cached property in DataModule by @Flegyas in #59
• Pass run tags to the WandbLogger by @Flegyas in #60
• Feature/bump core by @Flegyas in #61
• Version 0.2.0 by @Flegyas in #62

Full Changelog: 0.1.0...0.2.0