aidino/ml-project-template

Machine Learning project template

Project name

       

Overview

Project description

Virtual environment

• Download and switch between Python versions.

pyenv install 3.10.11  # install
pyenv global 3.10.11  # set default

• Create a virtual environment.

export PYTHONPATH=$PYTHONPATH:$PWD
python3 -m venv venv  # recommend using Python 3.10
source venv/bin/activate  # on Windows: venv\Scripts\activate
python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install -r requirements.txt
pre-commit install
pre-commit autoupdate

Notebook

Source: Made With ML

Script

src
├── config.py
├── data.py
├── evaluate.py
├── models.py
├── predict.py
├── serve.py
├── train.py
├── tune.py
└── utils.py

Pre-commit

• Run

# Run
pre-commit run --all-files  # run all hooks on all files
pre-commit run <HOOK_ID> --all-files # run one hook on all files
pre-commit run --files <PATH_TO_FILE>  # run all hooks on a file
pre-commit run <HOOK_ID> --files <PATH_TO_FILE> # run one hook on a file

• Skip

# Commit without hooks
git commit -m <MESSAGE> --no-verify

• Update

# Autoupdate
pre-commit autoupdate