Data Science Cookie Cutter

What is this?

This repository is a template for a data science project. It is based on khuyentran1401's cookiecutter data science template.

Feel free to look at these resources for a detailed explanation of khuyentran1401's original template:

• Article
• Video

Why?

It is important to structure your data science project based on a certain standard so that your teammates can easily maintain and modify your project.

This repository provides a template that incorporates best practices to create a maintainable and reproducible data science project.

Tools used in this project

• hydra: Manage configuration files - article
• sphinx: Automatically create an API documentation for your project
• pre-commit plugins: Automate code reviewing formatting
• Poetry: Dependency management - article

How to use this project

Install Cookiecutter:

pip install cookiecutter

Create a project based on the template:

cookiecutter https://github.com/5TuX/data-science-template/