cookiecutter-data-science/{{ cookiecutter.repo_name }}
Isaac Slavitt 1f06e5779f Replace | with │ 🚲🏠 2016-03-19 18:18:31 -04:00
..
data Force add data directories 2015-10-30 15:22:43 -04:00
docs Add Sphinx documentation template 2015-10-30 16:05:20 -04:00
models Add models and reports directories 2015-10-30 17:37:47 -04:00
notebooks Add other directories 📁 2015-10-30 15:23:59 -04:00
references Add other directories 📁 2015-10-30 15:23:59 -04:00
reports Update to structure 2016-03-19 16:49:01 -04:00
src Keep /src/data/ where scripts are 2016-03-19 17:42:47 -04:00
.env Add python-dotenv and default .env file 2015-11-02 09:25:23 -05:00
.gitignore Add license options 2016-03-19 17:46:54 -04:00
LICENSE Add license options 2016-03-19 17:46:54 -04:00
Makefile Make s3 bucket variable work 2015-11-03 13:58:35 -05:00
README.md Replace | with │ 🚲🏠 2016-03-19 18:18:31 -04:00
requirements.txt Add support for .env loading 2015-11-02 09:09:45 -05:00
tox.ini Add flake8 linting 2015-11-02 09:02:49 -05:00

README.md

{{cookiecutter.project_name}}

{{cookiecutter.description}}

Project Organization

├── LICENSE
├── Makefile           <- Makefile with commands like `make data` or `make train`
├── README.md          <- The top-level README for developers using this project.
├── 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.
│
├── docs               <- A default Sphinx project; see sphinx-doc.org for details
│
├── models             <- trained and serialized models, model predictions, or model summaries
│
├── 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`
│
├── src                <- Source code for use in this project.
│   ├── __init__.py    <- Makes src 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 train models and then use trained models to make
│       │                 predictions
│       ├── predict_model.py
│       └── train_model.py
│
└── tox.ini           <- tox file with settings for running tox; see tox.testrun.org