Libuv TCPStore 后端介绍
创建于：2024年7月22日 | 最后更新：2024年7月24日 | 最后验证：2024年11月5日
作者: Xilun Wu
注意
在github上查看和编辑本教程。
什么是新的TCPStore后端
将新的libuv后端与旧的后端进行比较
如何启用使用旧版后端
PyTorch 2.4 或更高版本
阅读有关TCPStore API的内容。
介绍
最近，我们推出了一个新的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服务器线程的执行将被阻塞，直到所有客户端成功连接，因此我们将排名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性能与传统后端相当：
libuv 后端在排名数量方面在整个范围内具有可比的性能
随着秩数的增加，libuv后端运行时比传统后端更稳定
影响
用户可能需要注意的一个不兼容性是，TCPStore目前在使用libuv后端时，不支持使用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：在TCPStore初始化时传递use_libuv=False
如上代码片段所示，如果用户调用TCPStore的init方法来创建一个存储，只需传递use_libuv=False即可让用户继续使用旧的TCPStore后端。此覆盖具有最高优先级，高于其他确定TCPStore服务器应选择哪个后端的方法。
退出路径2：在ProcessGroup初始化时向init_method添加use_libuv=0
ProcessGroup 如果用户没有显式传递一个 TCPStore 给它的初始化，它会创建一个 TCPStore。用户可以在初始化 ProcessGroup 时向 init_method 添加查询选项 use_libuv=0。这种方法比退出路径 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后端。此方法的优先级低于退出路径2，例如，如果用户将环境变量USE_LIBUV设置为1，并且在init_method中传递了use_libuv=0，则将选择旧的存储后端。
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()
