快捷方式

SyncBatchNorm

class torch.nn.SyncBatchNorm(num_features, eps=1e-05, momentum=0.1, affine=True, track_running_stats=True, process_group=None, device=None, dtype=None)[source][source]

对 N 维输入应用批量归一化。

N 维输入是 [N-2] 维输入的 mini-batch,带有额外的通道维度,如论文 Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift 中所述。

y=xE[x]Var[x]+ϵγ+βy = \frac{x - \mathrm{E}[x]}{ \sqrt{\mathrm{Var}[x] + \epsilon}} * \gamma + \beta

均值和标准差是在同一进程组的所有 mini-batch 上按维度计算的。 γ\gammaβ\beta 是大小为 C (其中 C 是输入大小)的可学习参数向量。默认情况下, γ\gamma 的元素从 U(0,1)\mathcal{U}(0, 1) 中采样, β\beta 的元素设置为 0。标准差通过有偏估计量计算,等效于 torch.var(input, unbiased=False)

同样默认情况下,在训练期间,此层会保留其计算的均值和方差的运行估计值,然后在评估期间将其用于归一化。运行估计值以默认的 momentum 0.1 保留。

如果 track_running_stats 设置为 False,则此层不会保留运行估计值,并且在评估时也使用批量统计信息。

注意

momentum 参数与优化器类中使用的参数以及动量的传统概念不同。从数学上讲,此处运行统计信息的更新规则是 x^new=(1momentum)×x^+momentum×xt\hat{x}_\text{new} = (1 - \text{momentum}) \times \hat{x} + \text{momentum} \times x_t,其中 x^\hat{x} 是估计的统计信息, xtx_t 是新的观察值。

由于批量归一化是针对 C 维度中的每个通道完成的,因此在 (N, +) 切片上计算统计信息,因此通常将此称为体积批量归一化或时空批量归一化。

目前, SyncBatchNorm 仅支持每个进程单 GPU 的 DistributedDataParallel (DDP)。在用 DDP 包装网络之前,使用 torch.nn.SyncBatchNorm.convert_sync_batchnorm()BatchNorm*D 层转换为 SyncBatchNorm

参数
  • num_features (int) – 来自预期大小为 (N,C,+)(N, C, +) 的输入的 CC

  • eps (float) – 添加到分母以提高数值稳定性的值。默认值: 1e-5

  • momentum (Optional[float]) – 用于 running_mean 和 running_var 计算的值。可以设置为 None 以进行累积移动平均(即简单平均)。默认值: 0.1

  • affine (bool) – 一个布尔值,当设置为 True 时,此模块具有可学习的仿射参数。默认值: True

  • track_running_stats (bool) – 一个布尔值,当设置为 True 时,此模块跟踪运行均值和方差,当设置为 False 时,此模块不跟踪此类统计信息,并将统计信息缓冲区 running_meanrunning_var 初始化为 None。当这些缓冲区为 None 时,此模块始终在训练和评估模式下都使用批量统计信息。默认值: True

  • process_group (Optional[Any]) – 统计信息的同步在每个进程组内单独发生。默认行为是在整个世界范围内同步

形状
  • 输入: (N,C,+)(N, C, +)

  • 输出: (N,C,+)(N, C, +) (与输入形状相同)

注意

批量归一化统计信息的同步仅在训练时发生,即当设置 model.eval()self.training 另为 False 时,同步将被禁用。

示例

>>> # With Learnable Parameters
>>> m = nn.SyncBatchNorm(100)
>>> # creating process group (optional)
>>> # ranks is a list of int identifying rank ids.
>>> ranks = list(range(8))
>>> r1, r2 = ranks[:4], ranks[4:]
>>> # Note: every rank calls into new_group for every
>>> # process group created, even if that rank is not
>>> # part of the group.
>>> process_groups = [torch.distributed.new_group(pids) for pids in [r1, r2]]
>>> process_group = process_groups[0 if dist.get_rank() <= 3 else 1]
>>> # Without Learnable Parameters
>>> m = nn.BatchNorm3d(100, affine=False, process_group=process_group)
>>> input = torch.randn(20, 100, 35, 45, 10)
>>> output = m(input)

>>> # network is nn.BatchNorm layer
>>> sync_bn_network = nn.SyncBatchNorm.convert_sync_batchnorm(network, process_group)
>>> # only single gpu per process is currently supported
>>> ddp_sync_bn_network = torch.nn.parallel.DistributedDataParallel(
>>>                         sync_bn_network,
>>>                         device_ids=[args.local_rank],
>>>                         output_device=args.local_rank)
classmethod convert_sync_batchnorm(module, process_group=None)[source][source]

将模型中的所有 BatchNorm*D 层转换为 torch.nn.SyncBatchNorm 层。

参数
  • module (nn.Module) – 包含一个或多个 BatchNorm*D 层的模块

  • process_group (可选) – 用于限定同步范围的进程组,默认为整个世界

返回值

原始 module ,其中包含转换后的 torch.nn.SyncBatchNorm 层。如果原始 moduleBatchNorm*D 层,则将返回一个新的 torch.nn.SyncBatchNorm 层对象。

示例

>>> # Network with nn.BatchNorm layer
>>> module = torch.nn.Sequential(
>>>            torch.nn.Linear(20, 100),
>>>            torch.nn.BatchNorm1d(100),
>>>          ).cuda()
>>> # creating process group (optional)
>>> # ranks is a list of int identifying rank ids.
>>> ranks = list(range(8))
>>> r1, r2 = ranks[:4], ranks[4:]
>>> # Note: every rank calls into new_group for every
>>> # process group created, even if that rank is not
>>> # part of the group.
>>> process_groups = [torch.distributed.new_group(pids) for pids in [r1, r2]]
>>> process_group = process_groups[0 if dist.get_rank() <= 3 else 1]
>>> sync_bn_module = torch.nn.SyncBatchNorm.convert_sync_batchnorm(module, process_group)

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

获取面向初学者和高级开发者的深入教程

查看教程

资源

查找开发资源并获得问题解答

查看资源