A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.
Base on drivendata/cookiecutter-data-science
Difference with the original repository
- add yapf, python formatter, into project structure
- add pre-commit for git hook
- change folders name that all folder names are unique within the project
- Requirements to use the cookiecutter template
- To start a new project, run:
- The resulting directory structure
- Installing development requirements
- Running the tests
- Acknowledgements
- Python 2.7 or 3.5+
- Cookiecutter Python package >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:
$ pip install cookiecutteror
$ conda config --add channels conda-forge $ conda install cookiecuttercookiecutter -c v1 https://github.com/daniel-code/machine-learning-project-template.git The directory structure of your new project looks like this:
├── LICENSE ├── Makefile <- Makefile with commands like `make data` or `make train` ├── README.md <- The top-level README for developers using this project. ├── datasets │ ├── external <- Data from third party sources. │ ├── interim <- Intermediate data that has been transformed. │ ├── final <- The final, canonical data sets for modeling. │ └── raw <- The original, immutable data dump. │ ├── model_weights <- Trained and serialized models, model predictions, or model summaries │ ├── logs <- Training logs │ ├── 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`. │ ├── references <- Data dictionaries, manuals, and all other explanatory materials. │ ├── reports <- Generated analysis as HTML, PDF, LaTeX, etc. │ └── figures <- Generated graphics and figures to be used in reporting │ ├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g. │ generated with `pip freeze > requirements.txt` │ ├── setup.py <- makes project pip installable (pip install -e .) so src can be imported │ ├── train.py <- Scripts to train models │ ├── evaluate.py <- Scripts to evaluate models │ ├── test.py <- Scripts to predict single sample via trained models │ ├── {{ cookiecutter.module_name }} <- Source code for use in this project. │ │ │ ├── __init__.py <- Makes {{ cookiecutter.module_name }} a Python module │ │ │ ├── data <- Scripts to download or generate data │ │ └── make_dataset.py │ │ │ ├── features <- Scripts to turn raw data into features for modeling │ │ └── build_features.py │ │ │ ├── models <- Scripts to construct model modules and architecture │ │ │ ├── utils <- Scripts to help train/test pipeline │ │ │ └── visualization <- Scripts to create exploratory and results oriented visualizations │ └── visualize.py │ └── tox.ini <- tox file with settings for running tox; see tox.readthedocs.io pip install -r requirements.txt py.test tests