بنية مشروع منطقية وموحدة بشكل معقول ولكن مرنة للقيام بمشاركة أعمال علوم البيانات.
CookieCutter Data Science (CCDS) هي أداة لإعداد قالب مشروع علم البيانات الذي يتضمن أفضل الممارسات. لمعرفة المزيد حول فلسفة CCDS ، تفضل بزيارة الصفحة الرئيسية للمشروع.
لقد تغير CookieCutter Data Science V2 من V1. يتطلب الأمر الآن تثبيت حزمة Python الجديدة CookieCutter-Data-Science ، والتي تمتد على وظائف فائدة Templating CookiCutter. استخدم برنامج سطر أوامر
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 القديم ، فأنت بحاجة إلى إما حزمة علوم cookiecutter-data أو حزمة 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.txtpytest tests