Skip to content

icoxfog417/datascience-template

Repository files navigation

datascience-template

Source Code Check pre-commit Code style: black Code style: flake8 Imports: isort Typing: mypy

Well structured and tested data science project template. You can use this template when creating the data sicence repository.

πŸ“ Organized: The project structure is refereed to Cookiecutter Data Science

πŸš€ Prepared: Major libraries are prepared in environment.yml. If you are familiar with Colaboratory environment, please use environment-colab.yml .

βœ… Tested: scripts are checked by common linter when pre-commit.

Here is the notebook link to provide the quick access to your analysis. You can create the conda environment by Right click Build Conda Environment or conda create -f environment.yml in Studio Lab.

Open in SageMaker Studio Lab

Project Structure

.
β”œβ”€β”€ data
β”‚   β”œβ”€β”€ external                    # data from third party sources.
β”‚   β”œβ”€β”€ processed                   # data after processing
β”‚   β”œβ”€β”€ interim                     # data that transformed
β”‚   └── raw                         # raw data
β”œβ”€β”€ models                          # store models
β”œβ”€β”€ notebooks                       # store notebooks
β”œβ”€β”€ docs                            # documentation for your project
β”œβ”€β”€ .gitignore                      # ignore files that cannot commit to Git
β”œβ”€β”€ .pre-commit-config.yaml         # configurations for pre-commit
β”œβ”€β”€ pyproject.toml                  # dependencies for poetry
β”œβ”€β”€ README.md                       # describe your project
β”œβ”€β”€ scripts                         # store source code used in notebook
β”‚   └── __init__.py                 # make src a Python module
└── tests                           # store tests
    └── __init__.py                 # make tests a Python module

Customization

  • environment.yml: Please specify the packages and versions. As a default, no version is specified.
  • .pre-commit-config.yaml: Please check the rev to check the code.
  • Change the Notebook url for Open in Studio Lab.