Makefile

为应用程序流程组织命令的自动化工具。

Intuition

尽管只完成了课程的一半，但已经有很多不同的命令需要跟踪。为了帮助组织一切，将使用Makefile一个自动化工具来组织命令。将首先在项目的根目录中创建此文件。

在顶部，Makefile需要指定希望所有命令在其中执行的 shell 环境：

# Makefile
SHELL = /bin/bash
1

成分

在Makefile中，将创建一个规则列表。这些规则有一个target，有时prerequisites需要满足（可以是其他目标），在下一行，Tab后面跟着一个recipe，指定如何创建目标。

# Makefile
target: prerequisites
 recipe
1

例如，如果想创建一个规则来为文件设置样式，可以将以下内容添加到Makefile：

# Styling
style:
    black .
    flake8
    python3 -m isort .
1

制表符与空格

Makefile 要求缩进使用，而不是会收到错误的空格：

生成文件：: *** 缺少分隔符。停止。

幸运的是，即使其他文件使用空格，像 VSCode 这样的编辑器也会自动将缩进更改为制表符。

目标

make 可以通过在终端中键入来执行任何规则：

# Make a target
$ make style
1

# Make a target $ make style

同样，可以设置Makefile用于创建虚拟环境：

# Environment
venv:
    python3 -m venv venv
    source venv/bin/activate && \
    python3 -m pip install pip setuptools wheel && \
    python3 -m pip install -e .
1

&&表示希望这些命令在一个 shell 中执行（更多内容见下文）。

PHONY

之所以这样称呼 Makefile，是因为传统上targets它们应该是可以制作的文件。但是，Makefile 也常被用作命令快捷方式，当 Makefile 目标和文件共享相同的名称时会导致混淆！例如，如果有一个名为venv（这样做）的文件，并且target在您的 Makefile 中有一个名为venv，当您运行时，make venv将收到此消息：

$ make venv

在这种情况下，这是预期的行为，因为如果虚拟环境已经存在，那么不想再次创建该目标。然而，有时，会命名目标并希望它们执行，无论它是否作为实际文件存在。在这些情况下，希望PHONY通过在目标上方添加以下行来在 makefile 中定义一个目标：

.PHONY:

Makefile 中的大多数规则都需要PHONY目标，因为希望即使存在共享目标名称的文件，它们也能执行。

# Styling
.PHONY: style
style:
    black .
    flake8
    isort .
1

先决条件

在制定目标之前，可以为它们附加先决条件。这些可以是必须存在的文件目标，也可以是在创建此目标之前需要执行的 PHONY 目标命令。例如，将样式目标设置为**清理目标的先决条件，以便所有文件在清理之前都适当地格式化。

# Cleaning
.PHONY: clean
clean: style
    find . -type f -name "*.DS_Store" -ls -delete
    find . | grep -E "(__pycache__|\.pyc|\.pyo)" | xargs rm -rf
    find . | grep -E ".pytest_cache" | xargs rm -rf
    find . | grep -E ".ipynb_checkpoints" | xargs rm -rf
    find . | grep -E ".trash" | xargs rm -rf
    rm -f .coverage
1

变量

还可以在 Makefile 中设置和使用变量来组织所有的规则。

• 可以直接在 Makefile 中设置变量。如果该变量未在 Makefile 中定义，则它将默认为具有相同名称的任何环境变量。

  # Set variable
  MESSAGE := "hello world"
  
  # Use variable
  greeting:
      @echo ${MESSAGE}
  
  1

• 也可以像这样在执行规则时使用传入的变量（确保变量没有在 Makefile 中被覆盖）：

  make greeting MESSAGE="hi"

Shells

规则配方中的每一行都将在单独的子 shell 中执行。但是对于某些方法，例如激活虚拟环境和加载包，希望在一个 shell 中执行所有步骤。为此，可以在.ONESHELL任何目标之上添加特殊目标。

# Environment
.ONESHELL:
venv:
    python3 -m venv venv
    source venv/bin/activate
    python3 -m pip install pip setuptools wheel
    python3 -m pip install -e .

1

然而，这仅在 Make 3.82 及更高版本中可用，大多数 Mac 当前使用的是 3.81 版本。您可以更新到当前版本，也可以&&像之前那样将您的命令链接起来：

# Environment
venv:
    python3 -m venv venv
    source venv/bin/activate && \
    python3 -m pip install pip setuptools wheel && \
    python3 -m pip install -e .

1

帮助

要添加到Makefile（至少现在）的最后一件事是一个help目标到最顶层。此规则将为该 Makefile 的功能提供信息性消息：

.PHONY: help
help:
    @echo "Commands:"
    @echo "venv    : creates a virtual environment."
    @echo "style   : executes style formatting."
    @echo "clean   : cleans all unnecessary files."

1

make help

1

Makefile的内容要多得多，但这对于大多数应用 ML 项目来说已经足够了。

本文主体源自以下链接：

@article{madewithml,
    author       = {Goku Mohandas},
    title        = { Made With ML },
    howpublished = {\url{https://madewithml.com/}},
    year         = {2022}
}
1