Libuv TCPStore 后端简介¶
创建日期：2024年7月22日 | 最后更新日期：2024年7月24日 | 最后验证日期：2024年11月5日
作者: 吴西伦
注意
查看和编辑此教程在 github。
什么是新的 TCPStore 后端
比较新 libuv 后端与传统后端
如何启用以使用旧版后端
PyTorch 2.4 或更高版本
了解 TCPStore API。
介绍¶
最近，我们推出了一种使用 libuv 新的 TCPStore 服务器后端，libuv 是一个用于异步 I/O 的第三方库。这个新的服务器后端旨在解决大规模分布式训练任务中的可扩展性和健壮性挑战，例如拥有超过 1024 个进程的任务。我们运行了一系列基准测试，将 libuv 后端与旧后端进行比较，实验结果表明存储初始化时间有了显著提升，并且在存储 I/O 操作中保持了相当的性能。
由于这些发现，libuv 后端已被设置为 PyTorch 2.4 中 TCPStore 服务器的默认后端。此更改预计将增强分布式训练任务的性能和可扩展性。
此更改引入了存储初始化的轻微不兼容性。对于希望继续使用旧版后端的用户，教程将提供如何指定使用之前 TCPStore 服务器后端的指导。
性能基准¶
为了更好地展示我们新 libuv TCPStore 后端的优势，我们在从 1024（1K）到 98304（96K）个进程规模的广泛范围内设置了一个基准测试。 我们首先使用以下代码片段测量了 TCPStore 的初始化时间：
import logging
import os
from time import perf_counter
import torch
import torch.distributed as dist
logger: logging.Logger = logging.getLogger(__name__)
# Env var are preset when launching the benchmark
env_rank = os.environ.get("RANK", 0)
env_world_size = os.environ.get("WORLD_SIZE", 1)
env_master_addr = os.environ.get("MASTER_ADDR", "localhost")
env_master_port = os.environ.get("MASTER_PORT", "23456")
start = perf_counter()
tcp_store = dist.TCPStore(
env_master_addr,
int(env_master_port),
world_size=int(env_world_size),
is_master=(int(env_rank) == 0),
)
end = perf_counter()
time_elapsed = end - start
logger.info(
f"Complete TCPStore init with rank={env_rank}, world_size={env_world_size} in {time_elapsed} seconds."
)
由于 TCPStore 服务器线程的执行将被阻塞，直到所有客户端成功连接，因此我们以 rank 0 测量的时间作为 TCPStore 初始化的总运行时间。实验数据如下图所示：
图1显示了一些重要的证据，表明libuv后端优于传统后端：
使用 libuv 后端的 TCPStore 始终比传统后端具有更快的初始化速度，尤其是在超大规模的情况下
旧的后端在 96K 规模的服务器-客户端连接时会超时（例如，超过 30 分钟），而 libuv 后端则能在 100 秒内完成初始化。
我们进行的第二个基准测试是测量TCPStore store_based_barrier 操作的运行时间:
import logging
import os
import time
from datetime import timedelta
from time import perf_counter
import torch
import torch.distributed as dist
DistStoreError = torch._C._DistStoreError
logger: logging.Logger = logging.getLogger(__name__)
# since dist._store_based_barrier is a private function and cannot be directly called, we need to write a function which does the same
def store_based_barrier(
rank,
store,
group_name,
rendezvous_count,
timeout=dist.constants.default_pg_timeout,
logging_interval=timedelta(seconds=10),
):
store_key = f"store_based_barrier_key:{group_name}"
store.add(store_key, 1)
world_size = rendezvous_count
worker_count = store.add(store_key, 0)
last_worker_key = f"{store_key}:last_worker"
if worker_count == world_size:
store.set(last_worker_key, "1")
start = time.time()
while True:
try:
# This will throw an exception after the logging_interval in which we print out
# the status of the group or time out officially, throwing runtime error
store.wait([last_worker_key], logging_interval)
break
except RuntimeError as e:
worker_count = store.add(store_key, 0)
# Print status periodically to keep track.
logger.info(
"Waiting in store based barrier to initialize process group for "
"rank: %s, key: %s (world_size=%s, num_workers_joined=%s, timeout=%s)"
"error: %s",
rank,
store_key,
world_size,
worker_count,
timeout,
e,
)
if timedelta(seconds=(time.time() - start)) > timeout:
raise DistStoreError(
"Timed out initializing process group in store based barrier on "
"rank {}, for key: {} (world_size={}, num_workers_joined={}, timeout={})".format(
rank, store_key, world_size, worker_count, timeout
)
)
logger.info(
"Rank %s: Completed store-based barrier for key:%s with %s nodes.",
rank,
store_key,
world_size,
)
# Env var are preset when launching the benchmark
env_rank = os.environ.get("RANK", 0)
env_world_size = os.environ.get("WORLD_SIZE", 1)
env_master_addr = os.environ.get("MASTER_ADDR", "localhost")
env_master_port = os.environ.get("MASTER_PORT", "23456")
tcp_store = dist.TCPStore(
env_master_addr,
int(env_master_port),
world_size=int(env_world_size),
is_master=(int(env_rank) == 0),
)
# sync workers
store_based_barrier(int(env_rank), tcp_store, "tcpstore_test", int(env_world_size))
number_runs = 10
start = perf_counter()
for _ in range(number_runs):
store_based_barrier(
int(env_rank), tcp_store, "tcpstore_test", int(env_world_size)
)
end = perf_counter()
time_elapsed = end - start
logger.info(
f"Complete {number_runs} TCPStore barrier runs with rank={env_rank}, world_size={env_world_size} in {time_elapsed} seconds."
)
我们通过将 rank 0 上测量的运行时间除以 number_runs 来计算平均值，并在下面的图中报告结果：
图2显示，libuv后端的I/O性能与传统后端相当：
The libuv backend has a comparable performance over the whole spectrum in terms of the number of ranks
libuv 后端运行时比传统后端更加稳定，尤其是在 rank 数量增加时
影响¶
一个用户需要注意的不兼容性是，当使用libuv后端时，TCPStore目前不支持使用 listen_fd 进行初始化。
如果用户希望继续使用此初始化方法，用户只需传递 use_libuv=False 以保持使用旧版的TCPStore后端。
import socket
import torch
import torch.distributed as dist
listen_sock: socket.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
listen_sock.bind(("localhost", 0))
addr, port, *_ = listen_sock.getsockname()
listen_fd = listen_sock.detach()
tcpstore = dist.TCPStore(addr, port, 1, True, master_listen_fd=listen_fd) # expect NotImplementedError
tcpstore = dist.TCPStore(addr, port, 1, True, master_listen_fd=listen_fd, use_libuv=False) # OK. Use legacy backend
退出路径 1: 将 use_libuv=False 传递给 TCPStore 初始化¶
如上面的代码片段所示，如果用户调用TCPStore初始化方法来创建存储，只需传递use_libuv=False即可让用户继续使用旧的
TCPStore后端。此覆盖方式优先级高于其他决定TCPStore服务器应选择哪个后端的方法。
退出路线 2: 在 ProcessGroup 初始化时将 use_libuv=0 添加到 init_method¶
ProcessGroup 如果用户没有显式地传递一个TCPStore到其初始化函数中，则会创建一个TCPStore。用户可以在初始化ProcessGroup时添加查询选项use_libuv=0到init_method。这种方法的优先级低于退出路线1。
import torch
import torch.distributed as dist
addr = "localhost"
port = 23456
dist.init_process_group(
backend="cpu:gloo,cuda:nccl",
rank=0,
world_size=1,
init_method=f"tcp://{addr}:{port}?use_libuv=0",
)
dist.destroy_process_group()
退出路线 3: 设置环境变量 USE_LIBUV 为 0¶
当ProcessGroup创建一个TCPStore时，它还会检查环境变量 USE_LIBUV 以确定使用哪种TCPStore后端。用户可以设置环境变量 "USE_LIBUV" 为 "0" 以指定使用旧版TCPStore后端。这种方法的优先级低于Exit Route 2，例如，如果用户设置环境变量 USE_LIBUV 为 1 并且也在 use_libuv=0 中传递了 init_method，则会选择旧版存储后端。
import os
import torch
import torch.distributed as dist
addr = "localhost"
port = 23456
os.environ["USE_LIBUV"] = "0"
dist.init_process_group(
backend="cpu:gloo,cuda:nccl",
rank=0,
world_size=1,
init_method=f"tcp://{addr}:{port}",
)
dist.destroy_process_group()
结论¶
在PyTorch 2.4中，我们将新的libuv TCPStore后端设为默认。尽管新后端与从listen_fd初始化不兼容，但它在大规模存储初始化时表现出显著的性能提升，并在小/中/大规模存储I/O时保持兼容性性能，这为分布式训练的控制平面带来了重大优势。本教程解释了我们的动机，介绍了性能基准测试，通知用户潜在影响，并介绍了三种继续使用旧后端的方法。长期来看，我们旨在最终弃用旧后端。