Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viacheslavdanilov/ml_project_template
Cookiecutter template for an ML, DS or AI project
https://github.com/viacheslavdanilov/ml_project_template
aritificial-intelligence cookiecutter deep-learning machine-learning project-template
Last synced: 8 days ago
JSON representation
Cookiecutter template for an ML, DS or AI project
- Host: GitHub
- URL: https://github.com/viacheslavdanilov/ml_project_template
- Owner: ViacheslavDanilov
- License: mit
- Created: 2022-12-29T12:11:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-22T17:17:11.000Z (about 1 year ago)
- Last Synced: 2024-11-10T13:49:05.313Z (2 months ago)
- Topics: aritificial-intelligence, cookiecutter, deep-learning, machine-learning, project-template
- Language: Python
- Homepage: https://sites.google.com/view/viacheslav-danilov
- Size: 76.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cookiecutter template for an ML, DS or AI project
## What is this?
This repository represents a logical, reasonably standardized, but flexible project structure for doing and sharing data science work.
#### [Cookiecutter homepage](http://drivendata.github.io/cookiecutter-data-science/)
## Tools used in this project
-----------
* [hydra](https://hydra.cc/): Manage configuration files([article on Medium](https://towardsdatascience.com/introduction-to-hydra-cc-a-powerful-framework-to-configure-your-data-science-projects-ed65713a53c6))
* [pre-commit](https://pre-commit.com/): Automate code reviewing formatting ([article on Medium](https://towardsdatascience.com/4-pre-commit-plugins-to-automate-code-reviewing-and-formatting-in-python-c80c6d2e9f5?sk=2388804fb174d667ee5b680be22b8b1f))
* [DVC](https://dvc.org/): Data version control ([article on Medium](https://towardsdatascience.com/introduction-to-dvc-data-version-control-tool-for-machine-learning-projects-7cb49c229fe0))
## Requirements to use the cookiecutter template:
-----------
- Python 2.7 or 3.5+
- [Cookiecutter Python package](http://cookiecutter.readthedocs.org/en/latest/installation.html) >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:
``` bash
pip install cookiecutter
```
or
``` bash
conda config --add channels conda-forge
conda install cookiecutter
```
## To start a new project, run:
------------
``` bash
cookiecutter https://github.com/ViacheslavDanilov/ml_project_template
```
# Project structure
------------
```bash
.
├── .dvc
│ └── config # DVC project-level config file
│
├── .github # GitHub actions configuration directory
│ └── workflows
│ └── ci.yaml # Configuration file for continuous integration
│
├── configs # Hydra configuration
│ ├── main.yaml # Main configuration file
│ ├── data.yaml # Data processing configurations
│ └── model.yaml # Model training and testing configurations
│
├── data # Data of the project
│ ├── final # The final, canonical data for modeling
│ ├── interim # Intermediate data that has been transformed
│ └── raw # The original, immutable data dump
│
├── dvc # Storage of DVC files
│ ├── data # DVC files tracking data-related files and directories
│ └── models # DVC files tracking model-related files and directories
│
├── media # Media files used for README.md
│
├── models # Trained and serialized models, model predictions, or model summaries
│
├── notebooks # Jupyter Notebooks
│
├── src # Source code for use in the project
│ ├── __init__.py # Make src a Python module
│ ├── data # Scripts for loading, generating, and processing data
│ │ └── __init__.py # Make data a Python module
│ ├── models # Scripts for training models and their subsequent use for making predictions
│ │ └── __init__.py # Make models a Python module
│ └── vis # Scripts for creating exploratory and results-oriented visualizations
│ └── __init__.py # Make vis a Python module
│
├── tests # Source code for code testing
│ ├── __init__.py # Make tests a Python module
│ ├── test_process.py # Test functions for process.py
│ ├── test_train.py # Test functions for train.py
│ └── test_visualize.py # Test functions for visualize.py
│
├── .dvcignore # Files or directories that should be excluded when traversing a DVC project
├── .gitignore # List of ignored files that cannot commit to Git
├── .pre-commit-config.yaml # Configuration file for pre-commit package
├── environment.yaml # Configuration file used to define and manage a Conda environment
├── create_env.sh # Shell script to create conda environment
├── LICENSE # License file of the repository
├── pyproject.toml # Unified Python project settings file that replaces setup.py
└── README.md # The top-level readme file for developers using this project
```