Makefile

Makefiles are task automation files that serve as the executable documentation and command entry point for ML projects — replacing the problem of memorizing long, complex commands (python src/train.py --config configs/prod.yaml --epochs 100 --lr 0.001 --output models/) with simple, memorable shortcuts (make train), while also defining dependency graphs so that tasks execute in the correct order (data must be downloaded before preprocessing, which must complete before training).

What Are Makefiles?

• Definition: A Makefile is a plain text file containing rules that define targets (task names) and their commands — originally designed for compiling C/C++ programs but widely adopted in ML projects as a universal task runner and project entry point.
• The Problem: ML projects have many complex commands — install dependencies, download data, preprocess, train, evaluate, deploy, lint, test. New developers joining the project have no idea what commands to run. The commands are scattered across README files, Slack messages, and tribal knowledge.
• The Solution: A Makefile serves as both documentation and automation. A new developer reads the Makefile to understand the project, then runs `make setup` to get started. Every common task is a one-word command.

Standard ML Makefile

.PHONY: setup data train evaluate deploy test lint clean

setup:
	python -m venv venv && source venv/bin/activate && pip install -r requirements.txt

data:
	python src/download_data.py
	python src/preprocess.py

train:
	python src/train.py --config configs/default.yaml

evaluate:
	python src/evaluate.py --model models/latest.pt

deploy:
	docker build -t mymodel:latest .
	docker push mymodel:latest

test:
	pytest tests/ -v

lint:
	ruff check src/ && mypy src/

clean:
	rm -rf __pycache__ .pytest_cache models/*.pt

Key Makefile Concepts

Dependency Chains

# Dependencies ensure correct execution order
deploy: test evaluate train data setup
# Reading right to left: setup → data → train → evaluate → test → deploy

Makefile vs Alternatives

Makefiles are the universal project entry point for ML projects — providing executable documentation that replaces complex commands with memorable targets, defines dependency chains that ensure tasks execute in the correct order, and serves as the first file a new developer reads to understand how to build, train, evaluate, and deploy a machine learning project.