cookiecutter data science

Cookiecutterデータサイエンス

データサイエンスの仕事を行い、共有するための論理的で合理的に標準化されたが柔軟なプロジェクト構造。

Cookiecutter Data Science（CCDS）は、ベストプラクティスを組み込んだデータサイエンスプロジェクトテンプレートを設定するためのツールです。 CCDSの哲学の詳細については、プロジェクトのホームページをご覧ください。

Cookiecutter Data Science V2はV1から変更されました。現在、Cookeiecutterテンプレートユーティリティの機能を拡張する新しいCookeiecutter-Data-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プロジェクトテンプレートを使用する場合は、cookeiecutter-data-scienceパッケージまたはcookecutterパッケージをインストールする必要があります。次に、 -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