cookiecutter-data-science/{{ cookiecutter.repo_name }}/README.md

21 lines
1023 B
Markdown
Raw Normal View History

2015-10-30 12:47:00 -07:00
{{cookiecutter.project_name}}
==============================
{{cookiecutter.description}}
Organization
------------
├── data
│   ├── external <- Data from third party sources.
│   ├── interim <- Intermediate data that has been transformed goes.
│   ├── processed <- The final, canonical data sets for modeling.
│   └── raw <- The original, immutable data dump.
├── notebooks <- Jupyter or Beaker 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 <- Reports, data dictionaries, manuals, and all other explanatory materials.
└── src <- Source code. Possible subdirectories might be `scripts` or `API` for
projects with larger codebases.