Lightning-Hydra-Cookiecutter
A clean template to kickstart your deep learning project 🚀⚡🔥
Suggestions are always welcome!
🚀 Quickstart
If you don't already have cookiecutter installed, use either of the following tools to add it to your PATH:
python3 -m pip install --user cookiecutter
conda install -c conda-forge cookiecutter
pipx install cookiecutter
brew install cookiecutter # macOS onlyNow you can generate a new project from this template with a one-liner. Note that you will be asked for a few things like the project name, open source license, etc. to bootstrap the project.
cookiecutter https://github.com/y1zhou/lightning-hydra-cookiecutterProject Structure
The directory structure of new project looks like this:
├── docs <- A default MkDocs project; see www.mkdocs.org for details
│
├── data <- Project data
│ ├── external <- Data from third party sources.
│ ├── raw <- The original, immutable data dump.
│ ├── interim <- Intermediate data that has been transformed.
│ └── processed <- The final, canonical data sets for modeling.
│
├── references <- Data dictionaries, manuals, and all other explanatory materials.
│
├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
│ the creator's initials, and a short `-` delimited description,
│ e.g. `1.0-jqp-initial-data-exploration.ipynb`.
│
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
│ └── figures <- Generated graphics and figures to be used in reporting
│
├── configs <- Hydra configs
│ ├── callbacks <- Callbacks configs
│ ├── data <- Data configs
│ ├── debug <- Debugging configs
│ ├── experiment <- Experiment configs
│ ├── extras <- Extra utilities configs
│ ├── hparams_search <- Hyperparameter search configs
│ ├── hydra <- Hydra configs
│ ├── local <- Local configs
│ ├── logger <- Logger configs
│ ├── model <- Model configs
│ ├── paths <- Project paths configs
│ ├── trainer <- Trainer configs
│ │
│ ├── eval.yaml <- Main config for evaluation
│ └── train.yaml <- Main config for training
│
├── src <- Source code
│ ├── data <- Data scripts
│ ├── models <- Model scripts
│ ├── utils <- Utility scripts
│ │
│ ├── eval.py <- Run evaluation
│ └── train.py <- Run training
│
├── logs <- Logs generated by hydra and lightning loggers
│
├── tests <- Tests of any kind
│
├── .env.example <- Example of file for storing private environment variables
├── .gitignore <- List of files ignored by git
├── .pre-commit-config.yaml <- Configuration of pre-commit hooks for code formatting
├── .project-root <- File for inferring the position of project root directory
├── environment.yaml <- File for installing conda environment
├── Makefile <- Makefile with commands like `make train` or `make test`
├── pyproject.toml <- Configuration options for package information, testing, and linting
└── README.md
Resources
This template was inspired by: