LlamaFactory
算力平台:

从 Jupyter Notebook 启动分布式训练 ​

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

配置环境 ​

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

bash
accelerate config

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

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

python
import os
from accelerate.utils import write_basic_config

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

准备数据集和模型 ​

接下来你应该准备你的数据集。如前所述，在准备 DataLoaders 和模型时应特别小心，以确保 任何内容 都不要放在 任何 GPU 上。

如果你这样做，建议将特定的代码放在一个函数中，并从笔记本启动器界面调用该函数，这将在后面展示。

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

python
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

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

python
import os

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

在这个例子中，标签是 beagle。使用正则表达式可以从文件名中提取标签：

python
import re


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

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

python
"beagle"

接下来需要创建一个 Dataset 类来处理图像和标签的获取：

python
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}

现在来构建数据集。在训练函数之外，你可以找到并声明所有文件名和标签，并在启动的函数中将它们用作引用：

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

接下来收集所有标签：

python
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 设备，那么必须使用此方法来构建它们。

python
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

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

python
from torch.optim.lr_scheduler import CosineAnnealingLR

编写训练函数 ​

现在你可以构建训练循环。[notebook_launcher] 通过传递一个函数来调用，该函数将在分布式系统中运行。

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

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

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

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

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

在本例中，由于你正在进行迁移学习，因此模型的编码器最初是冻结的，以便模型的头部可以先进行训练：

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

对图像批次进行归一化会使训练稍微快一些：

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

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

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

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

python
    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))

在将所有内容传递给 [~Accelerator.prepare] 之前。

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

现在训练模型：

python
    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()

评估循环与训练循环会有一些不同。传递的元素数量以及每个批次的总体准确率将被添加到两个常量中：

python
        model.eval()
        accurate = 0
        num_elems = 0

接下来你有标准的 PyTorch 循环的其余部分：

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

在进行分布式评估时，预测值和标签需要通过 [~Accelerator.gather] 传递，以便所有数据都能在当前设备上可用，并且能够计算出正确的指标：

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

现在你只需要计算这个问题的实际指标，并可以使用 [~Accelerator.print] 在主进程中打印它：

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

完整的训练循环版本如下：

python
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 initaliziations)
    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] 了。

你需要传递函数、参数（作为一个元组）以及用于训练的进程数。（更多信息请参阅 文档）

python
from accelerate import notebook_launcher
python
args = ("fp16", 42, 64)
notebook_launcher(training_loop, args, num_processes=2)

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

对于包含 2 个节点（计算机）的环境，每个节点有 8 个 GPU，主计算机的 IP 地址为 "172.31.43.8"，情况如下：

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

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

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

在使用 TPU 运行的情况下，它看起来是这样的：

python
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 具有弹性功能的示例：

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

在运行过程中，它会打印进度以及你使用了多少个设备。本教程是在两个 GPU 上运行的：

python
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 配置文件，要基于配置文件启动，请使用：

bash
accelerate launch

调试 ​

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

结论 ​

本笔记本展示了如何在 Jupyter Notebook 内进行分布式训练。一些关键点需要记住：

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

Copyright © 2024-2025 llamafactory.cn