通用连接上下文管理器

通用的 join 上下文管理器促进了对不均匀输入的分布式训练。此页面概述了相关类的 API：Join、Joinable 和 JoinHook。有关教程，请参阅 使用 Join 上下文管理器进行不均匀输入的分布式训练。

class torch.distributed.algorithms.Join(joinables, enable=True, throw_on_early_termination=False, **kwargs)

这个类定义了通用的连接上下文管理器，它允许在进程加入后调用自定义钩子。

这些钩子应该屏蔽未加入进程的集体通信，以防止挂起和错误，并确保算法正确性。有关钩子定义的详细信息，请参阅 JoinHook。

警告

上下文管理器要求每个参与的 Joinable 在其自身的每次迭代集体通信之前调用方法 notify_join_context() 以确保正确性。

警告

上下文管理器要求所有 process_group 属性在 JoinHook 对象中都是相同的。如果有多个 JoinHook 对象，则使用第一个的 device。 进程组和设备信息用于检查未加入的进程，并在启用 throw_on_early_termination 时通知进程抛出异常，这两者都使用全归约。

Parameters

• 可加入的对象 (List[可加入的]) – 参与的 Joinable 列表；按照给定的顺序迭代他们的钩子。

• 启用 (布尔值) – 一个启用不均匀输入检测的标志；设置为 False 将禁用上下文管理器的功能，且仅应在用户确定输入不会不均匀时 设置（默认值：True）。

• throw_on_early_termination (bool) – 一个控制在检测到不均匀输入时是否抛出异常的标志（默认值：False）。

Example:

>>> import os
>>> import torch
>>> import torch.distributed as dist
>>> import torch.multiprocessing as mp
>>> import torch.nn.parallel.DistributedDataParallel as DDP
>>> import torch.distributed.optim.ZeroRedundancyOptimizer as ZeRO
>>> from torch.distributed.algorithms.join import Join
>>>
>>> # On each spawned worker
>>> def worker(rank):
>>>     dist.init_process_group("nccl", rank=rank, world_size=2)
>>>     model = DDP(torch.nn.Linear(1, 1).to(rank), device_ids=[rank])
>>>     optim = ZeRO(model.parameters(), torch.optim.Adam, lr=0.01)
>>>     # Rank 1 gets one more input than rank 0
>>>     inputs = [torch.tensor([1.]).to(rank) for _ in range(10 + rank)]
>>>     with Join([model, optim]):
>>>         for input in inputs:
>>>             loss = model(input).sum()
>>>             loss.backward()
>>>             optim.step()
>>>     # All ranks reach here without hanging/erroring

static notify_join_context(joinable)

通知join上下文管理器调用进程尚未加入。

然后，如果 throw_on_early_termination=True，检查是否检测到不均匀的输入 （即如果一个进程已经加入）并且在检测到时抛出异常。

此方法应在 Joinable 对象的每次迭代集体通信之前调用。例如，这应该在 DistributedDataParallel 的前向传递开始时调用。

仅传递给上下文管理器的第一个 Joinable 对象在该方法中执行集体通信，对于其他对象，此方法为空操作。

Parameters

可连接的 (可连接的) – 调用此方法的 Joinable 对象。

Returns

一个异步工作句柄，用于所有归约操作，旨在通知上下文管理器，如果joinable是第一个传递给上下文管理器的参数，则进程尚未加入；否则为None。

class torch.distributed.algorithms.Joinable

这定义了一个可连接类的抽象基类。

一个可加入的类 （继承自 Joinable）应该实现 join_hook(), 该方法返回一个 JoinHook 实例，除此之外还应实现 join_device() 和 join_process_group() 分别返回设备和 进程组信息。

abstract property join_device: device

返回用于执行join上下文管理器所需的集体通信的设备。

abstract join_hook(**kwargs)

返回给定 Joinable 的 JoinHook 实例。

Parameters

kwargs (字典) – 包含用于在运行时修改连接钩子行为的任何关键字参数 的dict；所有共享相同连接上下文管理器的 Joinable 实例都会收到相同的 kwargs 值。

Return type

JoinHook

abstract property join_process_group: Any

返回join上下文管理器本身所需的集体通信进程组。

class torch.distributed.algorithms.JoinHook

这定义了一个连接钩子，它在连接上下文管理器中提供了两个入口点。

入口点：一个主钩子，当存在未加入的进程时，它会被反复调用；以及一个后钩子，在所有进程都已加入后被调用一次。

为了为通用连接上下文管理器实现一个连接钩子，定义一个继承自 JoinHook 的类，并根据需要重写 main_hook() 和 post_hook()。

main_hook()

在训练迭代中存在未加入的进程时调用此钩子以模拟集体通信。

训练迭代，即在一个前向传递、反向传递和优化器步骤中。

post_hook(is_last_joiner)

在所有进程都已加入后调用钩子。

它传递了一个额外的 bool 参数 is_last_joiner，这表示排名是否是最后加入的之一。

Parameters

is_last_joiner (bool) – 如果排名是最后加入的之一，则为True；否则为False。