从 Jupyter Notebooks 启动分布式训练

本教程教你如何使用 🤗 Accelerate 从 Jupyter Notebook 在分布式系统上微调计算机视觉模型。你还将学习如何设置一些确保环境配置正确、数据已正确准备以及最终如何启动训练的必要条件。

本教程也以 Jupyter Notebook 的形式提供，点击此处查看

配置环境

在执行任何训练之前，系统中必须存在 Accelerate 配置文件。通常，可以通过在终端中运行以下命令并回答提示来完成此操作

accelerate config

但是，如果通用默认设置可以接受，并且你没有在 TPU 上运行，Accelerate 提供了一个实用程序，可以通过 utils.write_basic_config() 快速将你的 GPU 配置写入配置文件。

以下代码将在写入配置后重启 Jupyter，因为调用了 CUDA 代码来执行此操作。

CUDA 在多 GPU 系统上无法初始化多次。在 notebook 中调试和调用 CUDA 是可以的，但是为了最终训练，需要执行完整的清理和重启。

import os
from accelerate.utils import write_basic_config

write_basic_config()  # Write a config file
os._exit(00)  # Restart the notebook

准备数据集和模型

接下来，你应该准备你的数据集。如前所述，在准备 DataLoaders 和模型时应格外小心，以确保任何东西都没有被放到任何 GPU 上。

如果这样做，建议将该特定代码放入一个函数中，并从 notebook 启动器接口中调用该函数，稍后将展示该接口。

请确保根据此处的说明下载数据集

import os, re, torch, PIL
import numpy as np

from torch.optim.lr_scheduler import OneCycleLR
from torch.utils.data import DataLoader, Dataset
from torchvision.transforms import Compose, RandomResizedCrop, Resize, ToTensor

from accelerate import Accelerator
from accelerate.utils import set_seed
from timm import create_model

首先，你需要创建一个函数来根据文件名提取类名

import os

data_dir = "../../images"
fnames = os.listdir(data_dir)
fname = fnames[0]
print(fname)

beagle_32.jpg

在此示例中，标签是 beagle。使用正则表达式，你可以从文件名中提取标签

import re


def extract_label(fname):
    stem = fname.split(os.path.sep)[-1]
    return re.search(r"^(.*)_\d+\.jpg$", stem).groups()[0]

extract_label(fname)

你可以看到它为我们的文件正确返回了正确的名称

"beagle"

接下来，应该创建一个 Dataset 类来处理获取图像和标签

class PetsDataset(Dataset):
    def __init__(self, file_names, image_transform=None, label_to_id=None):
        self.file_names = file_names
        self.image_transform = image_transform
        self.label_to_id = label_to_id

    def __len__(self):
        return len(self.file_names)

    def __getitem__(self, idx):
        fname = self.file_names[idx]
        raw_image = PIL.Image.open(fname)
        image = raw_image.convert("RGB")
        if self.image_transform is not None:
            image = self.image_transform(image)
        label = extract_label(fname)
        if self.label_to_id is not None:
            label = self.label_to_id[label]
        return {"image": image, "label": label}

现在构建数据集。在训练函数外部，你可以查找并声明所有文件名和标签，并在启动的函数内部使用它们作为引用

fnames = [os.path.join("../../images", fname) for fname in fnames if fname.endswith(".jpg")]

接下来收集所有标签

all_labels = [extract_label(fname) for fname in fnames]
id_to_label = list(set(all_labels))
id_to_label.sort()
label_to_id = {lbl: i for i, lbl in enumerate(id_to_label)}

接下来，你应该创建一个 get_dataloaders 函数，它将返回你构建的数据加载器。如前所述，如果在构建 DataLoaders 时数据自动发送到 GPU 或 TPU 设备，则必须使用此方法构建它们。

def get_dataloaders(batch_size: int = 64):
    "Builds a set of dataloaders with a batch_size"
    random_perm = np.random.permutation(len(fnames))
    cut = int(0.8 * len(fnames))
    train_split = random_perm[:cut]
    eval_split = random_perm[cut:]

    # For training a simple RandomResizedCrop will be used
    train_tfm = Compose([RandomResizedCrop((224, 224), scale=(0.5, 1.0)), ToTensor()])
    train_dataset = PetsDataset([fnames[i] for i in train_split], image_transform=train_tfm, label_to_id=label_to_id)

    # For evaluation a deterministic Resize will be used
    eval_tfm = Compose([Resize((224, 224)), ToTensor()])
    eval_dataset = PetsDataset([fnames[i] for i in eval_split], image_transform=eval_tfm, label_to_id=label_to_id)

    # Instantiate dataloaders
    train_dataloader = DataLoader(train_dataset, shuffle=True, batch_size=batch_size, num_workers=4)
    eval_dataloader = DataLoader(eval_dataset, shuffle=False, batch_size=batch_size * 2, num_workers=4)
    return train_dataloader, eval_dataloader

最后，你应该导入稍后要使用的调度器

from torch.optim.lr_scheduler import CosineAnnealingLR

编写训练函数

现在你可以构建训练循环了。notebook_launcher() 的工作原理是传入一个要调用的函数，该函数将在分布式系统上运行。

这是一个用于动物分类问题的基本训练循环

代码已被拆分，以便解释每个部分。可以在末尾找到可以复制粘贴的完整版本

def training_loop(mixed_precision="fp16", seed: int = 42, batch_size: int = 64):
    set_seed(seed)
    accelerator = Accelerator(mixed_precision=mixed_precision)

首先，你应该设置种子并尽早地在训练循环中创建一个 Accelerator 对象。

如果在 TPU 上训练，你的训练循环应将模型作为参数传入，并且应在训练循环函数外部实例化模型。请参阅 TPU 最佳实践以了解原因

接下来，你应该构建你的数据加载器并创建你的模型

    train_dataloader, eval_dataloader = get_dataloaders(batch_size)
    model = create_model("resnet50d", pretrained=True, num_classes=len(label_to_id))

你在此处构建模型，以便种子也控制新的权重初始化

由于你在此示例中执行迁移学习，因此模型的编码器最初是冻结的，因此最初只能训练模型的头部

    for param in model.parameters():
        param.requires_grad = False
    for param in model.get_classifier().parameters():
        param.requires_grad = True

标准化图像批次将使训练更快一些

    mean = torch.tensor(model.default_cfg["mean"])[None, :, None, None]
    std = torch.tensor(model.default_cfg["std"])[None, :, None, None]

为了使这些常量在活动设备上可用，你应该将其设置为 Accelerator 的设备

    mean = mean.to(accelerator.device)
    std = std.to(accelerator.device)

接下来，实例化用于训练的其余 PyTorch 类

    optimizer = torch.optim.Adam(params=model.parameters(), lr=3e-2 / 25)
    lr_scheduler = OneCycleLR(optimizer=optimizer, max_lr=3e-2, epochs=5, steps_per_epoch=len(train_dataloader))

在将所有内容传递给 prepare() 之前。

没有需要记住的特定顺序，你只需要按照你提供给 prepare 方法的顺序解包对象即可。

    model, optimizer, train_dataloader, eval_dataloader, lr_scheduler = accelerator.prepare(
        model, optimizer, train_dataloader, eval_dataloader, lr_scheduler
    )

现在训练模型

    for epoch in range(5):
        model.train()
        for batch in train_dataloader:
            inputs = (batch["image"] - mean) / std
            outputs = model(inputs)
            loss = torch.nn.functional.cross_entropy(outputs, batch["label"])
            accelerator.backward(loss)
            optimizer.step()
            lr_scheduler.step()
            optimizer.zero_grad()

与训练循环相比，评估循环看起来略有不同。作为元素的数量以及每个批次的总体总准确率将被添加到两个常量中

        model.eval()
        accurate = 0
        num_elems = 0

接下来，你将拥有标准的 PyTorch 循环的其余部分

        for batch in eval_dataloader:
            inputs = (batch["image"] - mean) / std
            with torch.no_grad():
                outputs = model(inputs)
            predictions = outputs.argmax(dim=-1)

最后是最后一个主要区别之前。

在执行分布式评估时，预测和标签需要通过 gather() 传递，以便所有数据在当前设备上可用，并且可以实现正确计算的指标

            accurate_preds = accelerator.gather(predictions) == accelerator.gather(batch["label"])
            num_elems += accurate_preds.shape[0]
            accurate += accurate_preds.long().sum()

现在你只需要计算此问题的实际指标，你就可以使用 print() 在主进程上打印它

        eval_metric = accurate.item() / num_elems
        accelerator.print(f"epoch {epoch}: {100 * eval_metric:.2f}")

此训练循环的完整版本如下所示

def training_loop(mixed_precision="fp16", seed: int = 42, batch_size: int = 64):
    set_seed(seed)
    # Initialize accelerator
    accelerator = Accelerator(mixed_precision=mixed_precision)
    # Build dataloaders
    train_dataloader, eval_dataloader = get_dataloaders(batch_size)

    # Instantiate the model (you build the model here so that the seed also controls new weight initializations)
    model = create_model("resnet50d", pretrained=True, num_classes=len(label_to_id))

    # Freeze the base model
    for param in model.parameters():
        param.requires_grad = False
    for param in model.get_classifier().parameters():
        param.requires_grad = True

    # You can normalize the batches of images to be a bit faster
    mean = torch.tensor(model.default_cfg["mean"])[None, :, None, None]
    std = torch.tensor(model.default_cfg["std"])[None, :, None, None]

    # To make these constants available on the active device, set it to the accelerator device
    mean = mean.to(accelerator.device)
    std = std.to(accelerator.device)

    # Instantiate the optimizer
    optimizer = torch.optim.Adam(params=model.parameters(), lr=3e-2 / 25)

    # Instantiate the learning rate scheduler
    lr_scheduler = OneCycleLR(optimizer=optimizer, max_lr=3e-2, epochs=5, steps_per_epoch=len(train_dataloader))

    # Prepare everything
    # There is no specific order to remember, you just need to unpack the objects in the same order you gave them to the
    # prepare method.
    model, optimizer, train_dataloader, eval_dataloader, lr_scheduler = accelerator.prepare(
        model, optimizer, train_dataloader, eval_dataloader, lr_scheduler
    )

    # Now you train the model
    for epoch in range(5):
        model.train()
        for batch in train_dataloader:
            inputs = (batch["image"] - mean) / std
            outputs = model(inputs)
            loss = torch.nn.functional.cross_entropy(outputs, batch["label"])
            accelerator.backward(loss)
            optimizer.step()
            lr_scheduler.step()
            optimizer.zero_grad()

        model.eval()
        accurate = 0
        num_elems = 0
        for batch in eval_dataloader:
            inputs = (batch["image"] - mean) / std
            with torch.no_grad():
                outputs = model(inputs)
            predictions = outputs.argmax(dim=-1)
            accurate_preds = accelerator.gather(predictions) == accelerator.gather(batch["label"])
            num_elems += accurate_preds.shape[0]
            accurate += accurate_preds.long().sum()

        eval_metric = accurate.item() / num_elems
        # Use accelerator.print to print only on the main process.
        accelerator.print(f"epoch {epoch}: {100 * eval_metric:.2f}")

使用 notebook_launcher

剩下的就是使用 notebook_launcher()。

你传入函数、参数（作为元组）以及要训练的进程数。（有关更多信息，请参阅文档）

from accelerate import notebook_launcher

args = ("fp16", 42, 64)
notebook_launcher(training_loop, args, num_processes=2)

在多节点上运行的情况下，你需要在每个节点上设置一个 Jupyter 会话，并同时运行启动单元格。

对于包含 2 个节点（计算机），每个节点有 8 个 GPU，主计算机的 IP 地址为“172.31.43.8”的环境，它看起来像这样

notebook_launcher(training_loop, args, master_addr="172.31.43.8", node_rank=0, num_nodes=2, num_processes=8)

在另一台机器上的第二个 Jupyter 会话中

请注意 node_rank 是如何更改的

notebook_launcher(training_loop, args, master_addr="172.31.43.8", node_rank=1, num_nodes=2, num_processes=8)

在 TPU 上运行的情况下，它看起来像这样

model = create_model("resnet50d", pretrained=True, num_classes=len(label_to_id))

args = (model, "fp16", 42, 64)
notebook_launcher(training_loop, args, num_processes=8)

要启动具有弹性的训练过程，启用容错，你可以使用 PyTorch 提供的 elastic_launch 功能。这需要设置额外的参数，例如 rdzv_backend 和 max_restarts。以下是如何将 notebook_launcher 与弹性功能结合使用的示例

notebook_launcher(
    training_loop,
    args,
    num_processes=2,
    max_restarts=3
)

当它运行时，它将打印进度以及你运行的设备数量。本教程在两个 GPU 上运行

Launching training on 2 GPUs.
epoch 0: 88.12
epoch 1: 91.73
epoch 2: 92.58
epoch 3: 93.90
epoch 4: 94.71

就是这样！

请注意，notebook_launcher() 忽略 Accelerate 配置文件，要基于配置启动，请使用

accelerate launch

调试

运行 notebook_launcher 时的一个常见问题是收到 CUDA 已初始化的错误。这通常源于 notebook 中的导入或先前代码调用了 PyTorch torch.cuda 子库。为了帮助缩小错误范围，你可以在你的环境中启动 notebook_launcher 并设置 ACCELERATE_DEBUG_MODE=yes，并且在生成时将进行额外的检查，以确保可以创建常规进程并正常使用 CUDA。（你的 CUDA 代码仍然可以在之后运行）。

结论

本 notebook 展示了如何从 Jupyter Notebook 内部执行分布式训练。需要记住的一些关键点

确保为传递给 notebook_launcher() 的函数保存任何使用 CUDA 的代码（或 CUDA 导入）
将 num_processes 设置为用于训练的设备数量（例如 GPU、CPU、TPU 等的数量）
如果使用 TPU，请在训练循环函数外部声明你的模型

< > 在 GitHub 上更新