cookiecutter-ds-docker

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

cookiecutter-ds-docker

★ 13 Open GitHub ↗

A Docker-based Data Science cookiecutter (for myself)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# cookiecutter-ds-docker

A Docker-based Data Science cookiecutter (for myself)

[![GitHub release (latest by SemVer)](https://img.shields.io/github/v/release/sertansenturk/cookiecutter-ds-docker)](https://github.com/sertansenturk/cookiecutter-ds-docker/releases/latest) [![Documentation Status](https://readthedocs.org/projects/cookiecutter-ds-docker/badge/?version=latest)](https://cookiecutter-ds-docker.readthedocs.io/en/latest/?badge=latest) [![Build Status](https://travis-ci.com/sertansenturk/cookiecutter-ds-docker.svg?branch=master)](https://travis-ci.com/sertansenturk/cookiecutter-ds-docker) [![codecov](https://codecov.io/gh/sertansenturk/cookiecutter-ds-docker/branch/master/graph/badge.svg)](https://codecov.io/gh/sertansenturk/cookiecutter-ds-docker) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-ff69b4.svg)](http://www.gnu.org/licenses/agpl-3.0) [![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-ff69b4.svg)](http://creativecommons.org/licenses/by-nc-sa/4.0/)

## Table of Contents

- [1. Introduction](#1-introduction)
- [2. Documentation](#2-documentation)
- [3. Quickstart](#3-quickstart)
- [4. Known Issues](#4-known-issues)
- [5. License](#5-license)
- [6. Authors](#6-authors)

## 1. Introduction

This repo hosts a personalized, *Docker*-based [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) template for Data Science projects.

The template consists of a docker-compose stack with the services below:

1. A customized [Jupyter](https://jupyter.org/) service with a starter *Python* package installed.
2. An [mlflow](https://mlflow.org/) tracking server to store experiments
3. A [postgresql](https://www.postgresql.org/) database, which stores mlflow tracking information

The template also comes with two standalone *Docker* image below for local usage:

1. *Python* test and development
2. Building *Sphinx* documentation

## 2. Documentation

Please refer to [Read The Docs](https://cookiecutter-ds-docker.readthedocs.io) for the documentation.

## 3. Quickstart

First, install [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/installation.html#install-cookiecutter) and [docker](https://docs.docker.com/get-docker/).

Then, run the commands below and follow the on-screen instructions to "cut" a new project from the template:

```bash
cd /{ base_folder }
cookiecutter gh:sertansenturk/cookiecutter-ds-docker
```

To build and start the Docker stack, run:

```bash
cd /{ base_folder }/{{ cookiecutter.repo_slug }}
make
```

![quickstart](https://raw.githubusercontent.com/sertansenturk/cookiecutter-ds-docker/master/docs/images/installation.gif)

## 4. Known Issues

1. In Linux, if `DATA_DIR` (defined in the [template](https://github.com/sertansenturk/cookiecutter-ds-docker/blob/dev/%7B%7B%20cookiecutter.repo_slug%20%7D%7D/.env)) is in a drive formatted in NTFS, you might have permission issues when mounting the folder to the docker containers (See [Issue #56](https://github.com/sertansenturk/cookiecutter-ds-docker/issues/56)). We suggest you to cut the project into a drive, which is formatted in a native Linux filesystem.

## 5. License

The source code hosted in this repository is licensed under [Affero GPL version 3](https://www.gnu.org/licenses/agpl-3.0.en.html). Any data (features, models,  figures, results, documentation, etc.) in this repository are licensed under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/).

## 6. Authors

Sertan Şentürk  
contact@sertansenturk.com

cookiecutter-ds-docker

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README