cookiecutter data science

Cookiecutter 데이터 과학

데이터 과학 작업을 수행하고 공유하기위한 논리적이고 합리적으로 표준화되었지만 유연한 프로젝트 구조.

CCDS (CookieCutter Data Science)는 모범 사례를 통합 한 데이터 과학 프로젝트 템플릿을 설정하는 도구입니다. CCDS의 철학에 대한 자세한 내용은 프로젝트 홈페이지를 방문하십시오.

Cookiecutter Data Science V2는 V1에서 변경되었습니다. 이제 CookieCutter 템플릿 유틸리티의 기능을 확장하는 새로운 CookieCutter-Science Python 패키지를 설치해야합니다. cookiecutter 대신 제공된 ccds 명령 줄 프로그램을 사용하십시오.

설치

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 패키지 또는 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