data science template

├── LICENSE                         <- will be created if u choose
├── README.md                       <- the main readme
│
├── config                          <- often it's yaml-files with some parameters
│
├── data
│   ├── external                    <- data from third party sources
│   ├── interim                     <- intermediate data that has been transformed
│   ├── processed                   <- the final, canonical data sets for modeling
│   ├── raw                         <- the original, immutable data dump
│   └── features                    <- another
│
├── docs                            <- a default sphinx project (see sphinx-doc.org for details)
│
├── experiments                     <- for any experiments
│
├── models                          <- trained & serialized models, model predictions, or model summaries
│
├── notebooks                       <- notebooks for research
│                                      naming convention is a number (for ordering), the creator's initials, and a short `-`
│                                      delimited description, eg `1.0-jqp-initial-data-exploration`
│
├── references                      <- data dictionaries, manuals, and all other explanatory materials
│
├── tests                           <- test for project
│
├── {{ cookiecutter.repo_name }}    <- source code
│   ├── __init__.py                 <- makes src a python module eg propose generate with `mkinit`
│   │
│   ├── data                        <- scripts to download or generate data
│   │
│   ├── models                      <- scripts to train models and then use trained models to make predictions
│   │
│   └── visualization               <- scripts to create exploratory and results oriented visualizations
│
├── .gitignore                      <- default for python
│
└── .pre-commit-config.yaml         <- custom pcc with `isort`, `pre-commit-hooks`, `flake8`, `black`