Git Product home page Git Product logo

maknotavailable / cookiecutter-data-science Goto Github PK

View Code? Open in Web Editor NEW

This project forked from drivendataorg/cookiecutter-data-science

1.0 1.0 1.0 605 KB

Cookiecutter for the Team Data Science Process (TDSP).

Home Page: https://docs.microsoft.com/en-us/azure/machine-learning/team-data-science-process/

License: MIT License

Python 39.40% Makefile 39.74% Batchfile 20.86%
cookiecutter tdsp microsoft

cookiecutter-data-science's Introduction

Cookiecutter Data Science for TDSP

A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.

Requirements to use the cookiecutter template:


  • Python 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 cookiecutter

or

$ conda config --add channels conda-forge
$ conda install cookiecutter

To start a new project, run:


cookiecutter https://github.com/maknotavailable/cookiecutter-data-science

asciicast

The resulting directory structure


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.
    ├── assets             <- Version controlled assets, such as stopword lists. Training data should 
    │                         be stored in local data directory, outside of repository. 
    │
    ├── 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 <[Task]-[Short Description]>,
    │                         for example 'Data - Exploration'
    │
    ├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
    │
    ├── 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 code can be imported
    ├── code               <- Source code for use in this project.
    │   ├── __init__.py    <- Makes code a Python module
    │   │
    │   ├── main.py        <- Main file, later used for inference
    │   │
    │   ├── helper.py      <- Use case agnostic helper file, with common functions
    │   │   └── build_features.py
    │
    ├── tests              <- Source code for use in this project.
    │   └── test_main.py   <- Test for the main function
    └── tox.ini            <- tox file with settings for running tox; see https://tox.readthedocs.io/

Installing development requirements


pip install -r requirements.txt

More information on customizing the cookiecutter template


First steps:
https://cookiecutter.readthedocs.io/en/latest/first_steps.html

cookiecutter-data-science's People

Contributors

adamkgoldfarb avatar apollonin avatar codyrioux avatar dmitrypolo avatar drivendata avatar firasrb avatar hwartig avatar ikuo-suyama avatar isms avatar jbrambledc avatar johnpaton avatar keldlundgaard avatar kplauritzen avatar liudonghs avatar lorey avatar maknotavailable avatar midnighter avatar mkcor avatar niloch avatar ohenrik avatar pjbull avatar proinsias avatar randallrs avatar verginer avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

heorhii-bolotov

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.