超时计时器

创建于：2021 年 5 月 4 日 | 最后更新于：2024 年 4 月 25 日

超时计时器在与代理程序相同的进程中设置，并从您的脚本中使用，以处理卡住的工作进程。当您进入一个有潜在卡住风险的代码块时，您可以获取一个超时计时器，该计时器指示计时器服务器在进程未能在自行设定的到期截止时间之前释放计时器时终止该进程。

用法

import torchelastic.timer as timer
import torchelastic.agent.server as agent

def main():
    start_method = "spawn"
    message_queue = mp.get_context(start_method).Queue()
    server = timer.LocalTimerServer(message, max_interval=0.01)
    server.start() # non-blocking

    spec = WorkerSpec(
                fn=trainer_func,
                args=(message_queue,),
                ...<OTHER_PARAMS...>)
    agent = agent.LocalElasticAgent(spec, start_method)
    agent.run()

def trainer_func(message_queue):
    timer.configure(timer.LocalTimerClient(message_queue))
    with timer.expires(after=60): # 60 second expiry
        # do some work

在上面的示例中，如果 trainer_func 的完成时间超过 60 秒，则工作进程将被终止，代理程序将重试工作进程组。

客户端方法

torch.distributed.elastic.timer.configure(timer_client)

配置计时器客户端。必须在使用 expires 之前调用。

torch.distributed.elastic.timer.expires(after, scope=None, client=None)

获取一个倒计时计时器，该计时器将在 after 秒后过期，除非它包装的代码块在规定时间内完成。当计时器过期时，该工作进程将有资格被回收。 “回收”的确切含义取决于客户端实现。在大多数情况下，回收意味着终止工作进程。请注意，不保证工作进程会在 time.now() + after 时刻被回收，而是工作进程 “有资格” 被回收，并且客户端通信的 TimerServer 将最终决定何时以及如何回收具有过期计时器的工作进程。

用法

torch.distributed.elastic.timer.configure(LocalTimerClient())
with expires(after=10):
    torch.distributed.all_reduce(...)

服务器/客户端实现

以下是 torchelastic 提供的计时器服务器和客户端对。

注意

计时器服务器和客户端必须始终成对实现和使用，因为服务器和客户端之间存在消息传递协议。

以下是一对基于 multiprocess.Queue 实现的计时器服务器和客户端。

class torch.distributed.elastic.timer.LocalTimerServer(mp_queue, max_interval=60, daemon=True)

与 LocalTimerClient 一起工作的服务器。客户端预计是运行此服务器的父进程的子进程。作业中的每个主机都应在本地启动自己的计时器服务器，每个服务器实例管理本地工作进程（在同一主机上的进程中运行）的计时器。

class torch.distributed.elastic.timer.LocalTimerClient(mp_queue)

与 LocalTimerServer 对应的客户端。此客户端旨在在运行 LocalTimerServer 的同一主机上使用，并使用 pid 唯一标识工作进程。这在在一个具有多个 GPU 设备的机器上为每个 GPU 产生一个（训练器）子进程的情况下特别有用。

以下是基于命名管道实现的另一对计时器服务器和客户端。

class torch.distributed.elastic.timer.FileTimerServer(file_path, run_id, max_interval=10, daemon=True, log_event=None)

与 FileTimerClient 一起工作的服务器。客户端预计与运行此服务器的进程在同一台主机上运行。作业中的每个主机都应在本地启动自己的计时器服务器，每个服务器实例管理本地工作进程（在同一主机上的进程中运行）的计时器。

参数

• file_path (str) – str，FIFO 特殊文件的路径，将创建该文件。

• max_interval (float) – float，每个看门狗循环的最大间隔（秒）。

• daemon (bool) – bool，是否以守护进程模式运行看门狗线程。守护进程线程不会阻止进程停止。

• log_event (Optional[Callable[[str, Optional[FileTimerRequest]], None]]) – Callable[[Dict[str, str]], None]，一个用于以 JSON 格式记录事件的可选回调。

class torch.distributed.elastic.timer.FileTimerClient(file_path, signal=Signals.SIGKILL)

与 FileTimerServer 对应的客户端。此客户端旨在在运行 FileTimerServer 的同一主机上使用，并使用 pid 唯一标识工作进程。此客户端使用命名管道将计时器请求发送到 FileTimerServer。此客户端是生产者，而 FileTimerServer 是消费者。多个客户端可以与同一个 FileTimerServer 一起工作。

参数

• file_path (str) – str，FIFO 特殊文件的路径。 FileTimerServer 必须通过调用 os.mkfifo() 来创建它。

• signal – signal，用于终止进程的信号。使用负数或零信号将不会终止进程。

编写自定义计时器服务器/客户端

要编写自己的计时器服务器和客户端，请为服务器扩展 torch.distributed.elastic.timer.TimerServer，为客户端扩展 torch.distributed.elastic.timer.TimerClient。 TimerRequest 对象用于在服务器和客户端之间传递消息。

class torch.distributed.elastic.timer.TimerRequest(worker_id, scope_id, expiration_time)

表示倒计时计时器获取和释放的数据对象，用于 TimerClient 和 TimerServer 之间。负数的 expiration_time 应解释为“释放”请求。

注意

worker_id 的类型是特定于实现的。它是 TimerServer 和 TimerClient 实现用来唯一标识工作进程的任何内容。

class torch.distributed.elastic.timer.TimerServer(request_queue, max_interval, daemon=True)

监控活动计时器并及时过期它们的实体。此服务器负责回收具有过期计时器的工作进程。

abstract clear_timers(worker_ids)

清除给定 worker_ids 的所有计时器。

abstract get_expired_timers(deadline)

返回每个 worker_id 的所有过期计时器。过期计时器是 expiration_time 小于或等于提供的截止时间的计时器。

返回类型

dict[str, list[torch.distributed.elastic.timer.api.TimerRequest]]

abstract register_timers(timer_requests)

处理传入的计时器请求，并将它们注册到服务器。计时器请求可以是获取计时器或释放计时器的请求。具有负 expiration_time 的计时器请求应解释为释放计时器请求。

class torch.distributed.elastic.timer.TimerClient

通过与 TimerServer 通信来获取和释放倒计时计时器的客户端库。

abstract acquire(scope_id, expiration_time)

为持有此客户端对象的工作进程获取一个计时器，给定 scope_id 和 expiration_time。通常会将计时器注册到 TimerServer。

abstract release(scope_id)

释放此客户端代表的工作进程的 scope_id 的计时器。调用此方法后，范围内的倒计时计时器不再生效。

调试信息日志记录

torch.distributed.elastic.timer.debug_info_logging.log_debug_info_for_expired_timers(run_id, expired_timers)