Skip to content

A cookiecutter project template for simple, competitive data science projects

License

Notifications You must be signed in to change notification settings

jlehrer1/cookiecutter-minimal-datascience

Repository files navigation

Cookiecutter: Minimal Datascience

Similar to the default provided by DrivenData, but simplified for casual project usage.

To use, run

cookiecutter https://github.com/jlehrer1/cookiecutter-minimal-datascience

I highly recommend aliasing the above command.

The structure of your project will be as follows

├── LICENSE
├── 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.
│
├── 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`.
│
├── requirements.txt   <- The requirements file for reproducing the analysis environment, e.g.
│                         created with "conda env export > environment.yml"
│
├── run.py             <- Script for running the full analysis 
│                         
├── 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
    │
    └── visualization  <- Scripts to create exploratory and results oriented visualizations
        └── visualize.py

About

A cookiecutter project template for simple, competitive data science projects

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published