cookiecutter data science

CookieCutter Data Science

Логическая, разумно стандартизированная, но гибкая структура проекта для работы и совместного использования работы с данными.

CookieCutter Data Science (CCDS) - это инструмент для настройки шаблона проекта Data Science, который включает в себя лучшие практики. Чтобы узнать больше о философии CCDS, посетите домашнюю страницу проекта.

CookieCutter Data Science V2 изменилась с V1. Теперь требуется установка нового пакета Pykutter-Data-Data-Science, который расширяет функциональность утилиты шаблона CookieCutter. Используйте предоставленную программу командной строки ccds вместо cookiecutter .

Установка

CookieCutter Data Science V2 требует Python 3.8+. Поскольку это приложение по перекрестному проекту, мы рекомендуем установить его с помощью PIPX. Параметры команды установки:

 # With pipx from PyPI (recommended)
pipx install cookiecutter-data-science

# With pip from PyPI
pip install cookiecutter-data-science

# With conda from conda-forge (coming soon)
# conda install cookiecutter-data-science -c conda-forge 

Запуск нового проекта

Чтобы начать новый проект, запустите:

ccds

Полученная структура каталогов

Структура каталогов вашего нового проекта будет выглядеть примерно так (в зависимости от настройки, которые вы выбираете):

 ├── LICENSE            <- Open-source license if one is chosen
├── Makefile           <- Makefile with convenience commands like `make data` or `make train`
├── 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.
│
├── docs               <- A default mkdocs project; see www.mkdocs.org for details
│
├── 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`.
│
├── pyproject.toml     <- Project configuration file with package metadata for 
│                         {{ cookiecutter.module_name }} and configuration for tools like black
│
├── references         <- Data dictionaries, manuals, and all other explanatory materials.
│
├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
│   └── figures        <- Generated graphics and figures to be used in reporting
│
├── requirements.txt   <- The requirements file for reproducing the analysis environment, e.g.
│                         generated with `pip freeze > requirements.txt`
│
├── setup.cfg          <- Configuration file for flake8
│
└── {{ cookiecutter.module_name }}   <- Source code for use in this project.
    │
    ├── __init__.py             <- Makes {{ cookiecutter.module_name }} a Python module
    │
    ├── config.py               <- Store useful variables and configuration
    │
    ├── dataset.py              <- Scripts to download or generate data
    │
    ├── features.py             <- Code to create features for modeling
    │
    ├── modeling                
    │   ├── __init__.py 
    │   ├── predict.py          <- Code to run model inference with trained models          
    │   └── train.py            <- Code to train models
    │
    └── plots.py                <- Code to create visualizations   

Используя v1

Если вы хотите использовать старый шаблон проекта V1, вам необходимо установить либо CookieCutter-Data-Science Package, либо пакет CookieCutter. Затем используйте любую программу командной строки с опцией -c v1 :

ccds https://github.com/drivendataorg/cookiecutter-data-science -c v1
# or equivalently
cookiecutter https://github.com/drivendataorg/cookiecutter-data-science -c v1

Внося

Мы приветствуем вклад! Смотрите документы для руководящих принципов.

Установка требований к разработке

pip install -r dev-requirements.txt

Запуск тестов

pytest tests