mcpField
H
huggingface-accelerate

huggingface-accelerate

github.com/orchestra-research开发14.1k991 次安装19 周前更新
代码仓库

关于 huggingface-accelerate

huggingface-accelerate 是介绍 Accelerate 分布式训练的技能资料,面向希望以较少代码改动运行 PyTorch 训练的开发者。内容包括多种分布式后端、混合精度和梯度累积。

主要功能

  1. 01简化 PyTorch 分布式训练
  2. 02配置 DDP、DeepSpeed 与 FSDP
  3. 03启用混合精度
  4. 04执行梯度累积
  5. 05使用命令启动训练

适用场景

  1. 01将单 GPU 脚本用于多 GPU
  2. 02配置多节点训练
  3. 03降低训练的显存需求

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/orchestra-research/ai-research-skills --skill huggingface-accelerate

安装后在 Claude Code 中输入/huggingface-accelerate确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
custom-plugins.md
megatron-integration.md
performance.md

详细介绍

HuggingFace Accelerate - 统一分布式训练

快速开始

Accelerate 将分布式训练简化为 4 行代码。

安装:

pip install accelerate

转换 PyTorch 脚本(4 行):

import torch
+ from accelerate import Accelerator

+ accelerator = Accelerator()

  model = torch.nn.Transformer()
  optimizer = torch.optim.Adam(model.parameters())
  dataloader = torch.utils.data.DataLoader(dataset)

+ model, optimizer, dataloader = accelerator.prepare(model, optimizer, dataloader)

  for batch in dataloader:
      optimizer.zero_grad()
      loss = model(batch)
-     loss.backward()
+     accelerator.backward(loss)
      optimizer.step()

运行(单条命令):

accelerate launch train.py

常见工作流

工作流 1:从单 GPU 到多 GPU

原始脚本:

# train.py
import torch

model = torch.nn.Linear(10, 2).to('cuda')
optimizer = torch.optim.Adam(model.parameters())
dataloader = torch.utils.data.DataLoader(dataset, batch_size=32)

for epoch in range(10):
    for batch in dataloader:
        batch = batch.to('cuda')
        optimizer.zero_grad()
        loss = model(batch).mean()
        loss.backward()
        optimizer.step()

使用 Accelerate(新增 4 行):

# train.py
import torch
from accelerate import Accelerator  # +1

accelerator = Accelerator()  # +2

model = torch.nn.Linear(10, 2)
optimizer = torch.optim.Adam(model.parameters())
dataloader = torch.utils.data.DataLoader(dataset, batch_size=32)

model, optimizer, dataloader = accelerator.prepare(model, optimizer, dataloader)  # +3

for epoch in range(10):
    for batch in dataloader:
        # No .to('cuda') needed - automatic!
        optimizer.zero_grad()
        loss = model(batch).mean()
        accelerator.backward(loss)  # +4
        optimizer.step()

配置(交互式):

accelerate config

问题:

  • 哪台机器?(单/多 GPU/TPU/CPU)
  • 多少台机器?(1)
  • 混合精度?(no/fp16/bf16/fp8)
  • DeepSpeed?(no/yes)

启动(适用于任何环境):

# Single GPU
accelerate launch train.py

# Multi-GPU (8 GPUs)
accelerate launch --multi_gpu --num_processes 8 train.py

# Multi-node
accelerate launch --multi_gpu --num_processes 16 \
  --num_machines 2 --machine_rank 0 \
  --main_process_ip $MASTER_ADDR \
  train.py
工作流 2:混合精度训练

启用 FP16/BF16:

from accelerate import Accelerator

# FP16 (with gradient scaling)
accelerator = Accelerator(mixed_precision='fp16')

# BF16 (no scaling, more stable)
accelerator = Accelerator(mixed_precision='bf16')

# FP8 (H100+)
accelerator = Accelerator(mixed_precision='fp8')

model, optimizer, dataloader = accelerator.prepare(model, optimizer, dataloader)

# Everything else is automatic!
for batch in dataloader:
    with accelerator.autocast():  # Optional, done automatically
        loss = model(batch)
    accelerator.backward(loss)
工作流 3:DeepSpeed ZeRO 集成

启用 DeepSpeed ZeRO-2:

from accelerate import Accelerator

accelerator = Accelerator(
    mixed_precision='bf16',
    deepspeed_plugin={
        "zero_stage": 2,  # ZeRO-2
        "offload_optimizer": False,
        "gradient_accumulation_steps": 4
    }
)

# Same code as before!
model, optimizer, dataloader = accelerator.prepare(model, optimizer, dataloader)

或通过配置:

accelerate config
# Select: DeepSpeed → ZeRO-2

deepspeed_config.json:

{
    "fp16": {"enabled": false},
    "bf16": {"enabled": true},
    "zero_optimization": {
        "stage": 2,
        "offload_optimizer": {"device": "cpu"},
        "allgather_bucket_size": 5e8,
        "reduce_bucket_size": 5e8
    }
}

启动:

accelerate launch --config_file deepspeed_config.json train.py
工作流 4:FSDP(完全分片数据并行)

启用 FSDP:

from accelerate import Accelerator, FullyShardedDataParallelPlugin

fsdp_plugin = FullyShardedDataParallelPlugin(
    sharding_strategy="FULL_SHARD",  # ZeRO-3 equivalent
    auto_wrap_policy="TRANSFORMER_AUTO_WRAP",
    cpu_offload=False
)

accelerator = Accelerator(
    mixed_precision='bf16',
    fsdp_plugin=fsdp_plugin
)

model, optimizer, dataloader = accelerator.prepare(model, optimizer, dataloader)

或通过配置:

accelerate config
# Select: FSDP → Full Shard → No CPU Offload
工作流 5:梯度累积

累积梯度:

from accelerate import Accelerator

accelerator = Accelerator(gradient_accumulation_steps=4)

model, optimizer, dataloader = accelerator.prepare(model, optimizer, dataloader)

for batch in dataloader:
    with accelerator.accumulate(model):  # Handles accumulation
        optimizer.zero_grad()
        loss = model(batch)
        accelerator.backward(loss)
        optimizer.step()

有效批大小:batch_size * num_gpus * gradient_accumulation_steps

何时使用及替代方案

在以下情况使用 Accelerate:

  • 想要最简单的分布式训练
  • 需要单一脚本适配任何硬件
  • 使用 HuggingFace 生态系统
  • 想要灵活性(DDP/DeepSpeed/FSDP/Megatron)
  • 需要快速原型开发

主要优势:

  • 4 行:最少的代码改动
  • 统一 API:DDP、DeepSpeed、FSDP、Megatron 使用相同代码
  • 自动化:设备放置、混合精度、分片
  • 交互式配置:无需手动设置启动器
  • 单次启动:随处可用

在以下情况改用替代方案:

  • PyTorch Lightning:需要回调、高层抽象
  • Ray Train:多节点编排、超参数调优
  • DeepSpeed:直接 API 控制、高级功能
  • 原生 DDP:最大控制、最少抽象

常见问题

问题:设备放置错误

不要手动移动到设备:

# WRONG
batch = batch.to('cuda')

# CORRECT
# Accelerate handles it automatically after prepare()

问题:梯度累积不生效

使用上下文管理器:

# CORRECT
with accelerator.accumulate(model):
    optimizer.zero_grad()
    accelerator.backward(loss)
    optimizer.step()

问题:分布式中的检查点保存

使用 accelerator 方法:

# Save only on main process
if accelerator.is_main_process:
    accelerator.save_state('checkpoint/')

# Load on all processes
accelerator.load_state('checkpoint/')

问题:FSDP 结果不同

确保相同的随机种子:

from accelerate.utils import set_seed
set_seed(42)

高级主题

Megatron 集成:参见 references/megatron-integration.md 了解张量并行、流水线并行和序列并行的设置。

自定义插件:参见 references/custom-plugins.md 了解如何创建自定义分布式插件和高级配置。

性能调优:参见 references/performance.md 了解性能分析、内存优化和最佳实践。

硬件要求

  • CPU:可用(较慢)
  • 单 GPU:可用
  • 多 GPU:DDP(默认)、DeepSpeed 或 FSDP
  • 多节点:DDP、DeepSpeed、FSDP、Megatron
  • TPU:支持
  • Apple MPS:支持

启动器要求:

  • DDP:torch.distributed.run(内置)
  • DeepSpeed:deepspeed(pip install deepspeed)
  • FSDP:PyTorch 1.12+(内置)
  • Megatron:自定义设置

资源

评论

支持 Markdown