使用分布式 RPC 框架实现参数服务器#
创建日期: 2020年4月06日 | 最近更新: 2024年5月07日 | 最近验证: 未验证
作者: Rohan Varma
注意
在 github 中查看和编辑本教程。
先决条件
本教程将通过一个简单的示例，介绍如何使用 PyTorch 的分布式 RPC 框架来实现参数服务器（parameter server）。参数服务器框架是一种范式，其中一组服务器存储参数（例如大型嵌入表），而数个训练器（trainer）查询这些参数服务器以获取最新参数。这些训练器可以在本地运行训练循环，并偶尔与参数服务器进行同步以获取最新参数。欲了解更多关于参数服务器方法的内容，请参阅这篇论文。
利用分布式 RPC 框架，我们将构建一个示例，其中多个训练器使用 RPC 与同一个参数服务器进行通信，并使用 RRef 访问远程参数服务器实例上的状态。每个训练器将通过分布式自动求导（distributed autograd）跨多个节点拼接自动求导图，以分布式方式启动其专属的反向传播。
注意：本教程涵盖了分布式 RPC 框架的使用，该框架对于将模型拆分到多台机器上，或实现网络训练器获取托管在另一台机器上的参数的参数服务器训练策略非常有用。如果你想在多个 GPU 上复制你的模型，请参阅分布式数据并行（DDP）教程。此外，还有另一个RPC 教程涵盖了强化学习和 RNN 的使用案例。
让我们从熟悉的内容开始：导入所需的模块并定义一个将在 MNIST 数据集上训练的简单 ConvNet。下面的网络在很大程度上采用了 pytorch/examples 仓库中定义的网络。
import argparse
import os
import time
from threading import Lock
import torch
import torch.distributed.autograd as dist_autograd
import torch.distributed.rpc as rpc
import torch.multiprocessing as mp
import torch.nn as nn
import torch.nn.functional as F
from torch import optim
from torch.distributed.optim import DistributedOptimizer
from torchvision import datasets, transforms
# --------- MNIST Network to train, from pytorch/examples -----
class Net(nn.Module):
def __init__(self, num_gpus=0):
super(Net, self).__init__()
print(f"Using {num_gpus} GPUs to train")
self.num_gpus = num_gpus
device = torch.device(
"cuda:0" if torch.cuda.is_available() and self.num_gpus > 0 else "cpu")
print(f"Putting first 2 convs on {str(device)}")
# Put conv layers on the first cuda device, or CPU if no cuda device
self.conv1 = nn.Conv2d(1, 32, 3, 1).to(device)
self.conv2 = nn.Conv2d(32, 64, 3, 1).to(device)
# Put rest of the network on the 2nd cuda device, if there is one
if "cuda" in str(device) and num_gpus > 1:
device = torch.device("cuda:1")
print(f"Putting rest of layers on {str(device)}")
self.dropout1 = nn.Dropout2d(0.25).to(device)
self.dropout2 = nn.Dropout2d(0.5).to(device)
self.fc1 = nn.Linear(9216, 128).to(device)
self.fc2 = nn.Linear(128, 10).to(device)
def forward(self, x):
x = self.conv1(x)
x = F.relu(x)
x = self.conv2(x)
x = F.max_pool2d(x, 2)
x = self.dropout1(x)
x = torch.flatten(x, 1)
# Move tensor to next device if necessary
next_device = next(self.fc1.parameters()).device
x = x.to(next_device)
x = self.fc1(x)
x = F.relu(x)
x = self.dropout2(x)
x = self.fc2(x)
output = F.log_softmax(x, dim=1)
return output
接下来，我们来定义一些对脚本其余部分有用的辅助函数。下面使用 rpc_sync 和 RRef 来定义一个函数，该函数调用运行在远程节点上的对象上的给定方法。下面，我们对远程对象的句柄由 rref 参数给出，我们在其所属节点上运行它：rref.owner()。在调用者节点上，我们通过使用 rpc_sync 同步运行此命令，这意味着我们将阻塞直到收到响应。
# --------- Helper Methods --------------------
# On the local node, call a method with first arg as the value held by the
# RRef. Other args are passed in as arguments to the function called.
# Useful for calling instance methods. method could be any matching function, including
# class methods.
def call_method(method, rref, *args, **kwargs):
return method(rref.local_value(), *args, **kwargs)
# Given an RRef, return the result of calling the passed in method on the value
# held by the RRef. This call is done on the remote node that owns
# the RRef and passes along the given argument.
# Example: If the value held by the RRef is of type Foo, then
# remote_method(Foo.bar, rref, arg1, arg2) is equivalent to calling
# <foo_instance>.bar(arg1, arg2) on the remote node and getting the result
# back.
def remote_method(method, rref, *args, **kwargs):
args = [method, rref] + list(args)
return rpc.rpc_sync(rref.owner(), call_method, args=args, kwargs=kwargs)
现在，我们准备好定义我们的参数服务器。我们将继承 nn.Module 并保存一个指向上文定义网络的句柄。我们还将保存一个输入设备，该设备是我们在调用模型之前将输入传输到的设备。
# --------- Parameter Server --------------------
class ParameterServer(nn.Module):
def __init__(self, num_gpus=0):
super().__init__()
model = Net(num_gpus=num_gpus)
self.model = model
self.input_device = torch.device(
"cuda:0" if torch.cuda.is_available() and num_gpus > 0 else "cpu")
接下来，我们将定义前向传播。请注意，无论模型输出的设备是什么，我们都会将输出移动到 CPU，因为分布式 RPC 框架目前仅支持通过 RPC 发送 CPU 张量。由于调用者/被调用者上可能存在不同的设备（CPU/GPU），我们有意禁用了通过 RPC 发送 CUDA 张量的功能，但可能会在未来的版本中支持此功能。
class ParameterServer(nn.Module):
...
def forward(self, inp):
inp = inp.to(self.input_device)
out = self.model(inp)
# This output is forwarded over RPC, which as of 1.5.0 only accepts CPU tensors.
# Tensors must be moved in and out of GPU memory due to this.
out = out.to("cpu")
return out
接下来，我们将定义一些对训练和验证有用的其他函数。第一个函数 get_dist_gradients 将接收一个分布式自动求导（Distributed Autograd）上下文 ID，并调用 dist_autograd.get_gradients API，以检索由分布式自动求导计算出的梯度。更多信息可以在 分布式自动求导文档中找到。请注意，我们还会遍历结果字典并将每个张量转换为 CPU 张量，因为该框架目前仅支持通过 RPC 发送张量。接下来，get_param_rrefs 将遍历我们的模型参数并将其封装为（本地）RRef。该方法将被训练器节点通过 RPC 调用，并将返回待优化参数的列表。这是 分布式优化器（Distributed Optimizer） 的必需输入，该优化器要求将其必须优化的所有参数作为 RRef 列表传入。
# Use dist autograd to retrieve gradients accumulated for this model.
# Primarily used for verification.
def get_dist_gradients(self, cid):
grads = dist_autograd.get_gradients(cid)
# This output is forwarded over RPC, which as of 1.5.0 only accepts CPU tensors.
# Tensors must be moved in and out of GPU memory due to this.
cpu_grads = {}
for k, v in grads.items():
k_cpu, v_cpu = k.to("cpu"), v.to("cpu")
cpu_grads[k_cpu] = v_cpu
return cpu_grads
# Wrap local parameters in a RRef. Needed for building the
# DistributedOptimizer which optimizes paramters remotely.
def get_param_rrefs(self):
param_rrefs = [rpc.RRef(param) for param in self.model.parameters()]
return param_rrefs
最后，我们将创建初始化参数服务器的方法。请注意，在所有进程中，参数服务器只有一个实例，所有训练器都将与同一个参数服务器通信并更新同一个存储的模型。如在 run_parameter_server 中所见，服务器本身不会采取任何独立行动；它等待来自训练器（尚未定义）的请求，并通过运行请求的函数来响应它们。
# The global parameter server instance.
param_server = None
# A lock to ensure we only have one parameter server.
global_lock = Lock()
def get_parameter_server(num_gpus=0):
"""
Returns a singleton parameter server to all trainer processes
"""
global param_server
# Ensure that we get only one handle to the ParameterServer.
with global_lock:
if not param_server:
# construct it once
param_server = ParameterServer(num_gpus=num_gpus)
return param_server
def run_parameter_server(rank, world_size):
# The parameter server just acts as a host for the model and responds to
# requests from trainers.
# rpc.shutdown() will wait for all workers to complete by default, which
# in this case means that the parameter server will wait for all trainers
# to complete, and then exit.
print("PS master initializing RPC")
rpc.init_rpc(name="parameter_server", rank=rank, world_size=world_size)
print("RPC initialized! Running parameter server...")
rpc.shutdown()
print("RPC shutdown on parameter server.")
请注意，在上文中，rpc.shutdown() 不会立即关闭参数服务器。相反，它会等待所有工作节点（在本例中为训练器）也调用 rpc.shutdown()。这保证了在所有训练器（尚未定义）完成其训练过程之前，参数服务器不会下线。
接下来，我们将定义我们的 TrainerNet 类。这也将是 nn.Module 的子类，我们的 __init__ 方法将使用 rpc.remote API 来获取指向参数服务器的 RRef（远程引用，Remote Reference）。请注意，这里我们没有将参数服务器复制到本地进程，相反，我们可以将 self.param_server_rref 视为指向运行在独立进程上的参数服务器的分布式共享指针。
# --------- Trainers --------------------
# nn.Module corresponding to the network trained by this trainer. The
# forward() method simply invokes the network on the given parameter
# server.
class TrainerNet(nn.Module):
def __init__(self, num_gpus=0):
super().__init__()
self.num_gpus = num_gpus
self.param_server_rref = rpc.remote(
"parameter_server", get_parameter_server, args=(num_gpus,))
接下来，我们将定义一个名为 get_global_param_rrefs 的方法。为了阐明该方法的必要性，值得阅读一下关于 DistributedOptimizer 的文档，特别是它的 API 签名。必须向该优化器传递一个与要优化的远程参数对应的 RRef 列表，因此我们在此处获取必要的 RRef。由于给定的 TrainerNet 唯一交互的远程工作节点是 ParameterServer，我们只需在 ParameterServer 上调用 remote_method。我们使用在 ParameterServer 类中定义的 get_param_rrefs 方法。该方法将返回一个指向需要优化的参数的 RRef 列表。请注意，在此例中，我们的 TrainerNet 没有定义它自己的参数；如果定义了，我们也需要将每个参数包装在 RRef 中，并将其包含在传给 DistributedOptimizer 的输入中。
class TrainerNet(nn.Module):
...
def get_global_param_rrefs(self):
remote_params = remote_method(
ParameterServer.get_param_rrefs,
self.param_server_rref)
return remote_params
现在，我们准备好定义我们的 forward 方法，它将调用（同步）RPC 来运行定义在 ParameterServer 上的网络的前向传播。请注意，在 RPC 调用中，我们传入了 self.param_server_rref（这是指向我们 ParameterServer 的远程句柄）。此调用将向运行我们的 ParameterServer 的节点发送一个 RPC，调用 forward 传播，并返回与模型输出对应的 Tensor。
class TrainerNet(nn.Module):
...
def forward(self, x):
model_output = remote_method(
ParameterServer.forward, self.param_server_rref, x)
return model_output
训练器定义完毕后，现在是时候编写我们的神经网络训练循环了，该循环将创建我们的网络 and 优化器，通过网络运行一些输入，并计算损失。训练循环看起来非常像本地训练程序，但由于我们的网络是跨机器分布的，因此进行了一些修改。
下面，我们初始化我们的 TrainerNet 并构建一个 DistributedOptimizer。请注意，如上所述，我们必须传入我们想要优化的所有全局参数（参与分布式训练的所有节点中的参数）。此外，我们还传入了要使用的本地优化器，在本例中为 SGD。请注意，我们可以配置底层优化器算法，其方式与创建本地优化器完全相同——optimizer.SGD 的所有参数都将被正确转发。例如，我们传入了一个自定义学习率，该学习率将用作所有本地优化器的学习率。
def run_training_loop(rank, num_gpus, train_loader, test_loader):
# Runs the typical nueral network forward + backward + optimizer step, but
# in a distributed fashion.
net = TrainerNet(num_gpus=num_gpus)
# Build DistributedOptimizer.
param_rrefs = net.get_global_param_rrefs()
opt = DistributedOptimizer(optim.SGD, param_rrefs, lr=0.03)
接下来，我们定义主训练循环。我们循环遍历由 PyTorch 的 DataLoader 提供的可迭代对象。在编写典型的 forward/backward/optimizer 循环之前，我们首先将该逻辑包装在 分布式自动求导上下文（Distributed Autograd context）中。请注意，这是记录在模型前向传播中调用的 RPC 所必需的，以便构建包含反向传播中所有参与的分布式工作节点的合适图。分布式自动求导上下文返回一个 context_id，该 ID 作为累积和优化对应于特定迭代的梯度的标识符。
与调用典型的 loss.backward()（这将在本地工作节点上启动反向传播）不同，我们调用 dist_autograd.backward() 并传入我们的 context_id 以及 loss（这是我们希望反向传播开始的根节点）。此外，我们将此 context_id 传入我们的优化器调用，这是在所有节点中查找由该特定反向传播计算的相应梯度所必需的。
def run_training_loop(rank, num_gpus, train_loader, test_loader):
...
for i, (data, target) in enumerate(train_loader):
with dist_autograd.context() as cid:
model_output = net(data)
target = target.to(model_output.device)
loss = F.nll_loss(model_output, target)
if i % 5 == 0:
print(f"Rank {rank} training batch {i} loss {loss.item()}")
dist_autograd.backward(cid, [loss])
# Ensure that dist autograd ran successfully and gradients were
# returned.
assert remote_method(
ParameterServer.get_dist_gradients,
net.param_server_rref,
cid) != {}
opt.step(cid)
print("Training complete!")
print("Getting accuracy....")
get_accuracy(test_loader, net)
下面的步骤只是在训练完成后计算模型的准确率，这与传统的本地模型非常相似。但请注意，上文我们传入该函数的 net 是 TrainerNet 的实例，因此其前向传播是以透明的方式调用 RPC 的。
def get_accuracy(test_loader, model):
model.eval()
correct_sum = 0
# Use GPU to evaluate if possible
device = torch.device("cuda:0" if model.num_gpus > 0
and torch.cuda.is_available() else "cpu")
with torch.no_grad():
for i, (data, target) in enumerate(test_loader):
out = model(data, -1)
pred = out.argmax(dim=1, keepdim=True)
pred, target = pred.to(device), target.to(device)
correct = pred.eq(target.view_as(pred)).sum().item()
correct_sum += correct
print(f"Accuracy {correct_sum / len(test_loader.dataset)}")
接下来，类似于我们为负责初始化 RPC 的 ParameterServer 定义主循环 run_parameter_server 的方式，让我们为训练器也定义一个类似的循环。不同之处在于，我们的训练器必须运行我们在上文定义的训练循环。
# Main loop for trainers.
def run_worker(rank, world_size, num_gpus, train_loader, test_loader):
print(f"Worker rank {rank} initializing RPC")
rpc.init_rpc(
name=f"trainer_{rank}",
rank=rank,
world_size=world_size)
print(f"Worker {rank} done initializing RPC")
run_training_loop(rank, num_gpus, train_loader, test_loader)
rpc.shutdown()
请注意，与 run_parameter_server 类似，在当前节点退出之前，rpc.shutdown() 默认会等待所有工作节点（包括训练器和参数服务器）都调用 rpc.shutdown()。这可确保节点优雅地终止，并且在另一个节点期望某个节点在线时，该节点不会下线。
我们现在已经完成了训练器和参数服务器特定的代码，剩下的就是添加启动训练器和参数服务器的代码了。首先，我们必须传入适用于我们的参数服务器和训练器的各种参数。world_size 对应于将参与训练的节点总数，是所有训练器和参数服务器的总和。我们还必须为每个单独的进程传入一个唯一的 rank，范围从 0（我们将在此处运行单个参数服务器）到 world_size - 1。master_addr 和 master_port 是可用于标识 rank 0 进程运行位置的参数，单个节点将使用这些参数来相互发现。要在本地测试此示例，只需向所有启动的实例传入 localhost 和相同的 master_port。请注意，出于演示目的，此示例仅支持使用 0 到 2 个 GPU，尽管该模式可以扩展以使用更多 GPU。
if __name__ == '__main__':
parser = argparse.ArgumentParser(
description="Parameter-Server RPC based training")
parser.add_argument(
"--world_size",
type=int,
default=4,
help="""Total number of participating processes. Should be the sum of
master node and all training nodes.""")
parser.add_argument(
"--rank",
type=int,
default=None,
help="Global rank of this process. Pass in 0 for master.")
parser.add_argument(
"--num_gpus",
type=int,
default=0,
help="""Number of GPUs to use for training, Currently supports between 0
and 2 GPUs. Note that this argument will be passed to the parameter servers.""")
parser.add_argument(
"--master_addr",
type=str,
default="localhost",
help="""Address of master, will default to localhost if not provided.
Master must be able to accept network traffic on the address + port.""")
parser.add_argument(
"--master_port",
type=str,
default="29500",
help="""Port that master is listening on, will default to 29500 if not
provided. Master must be able to accept network traffic on the host and port.""")
args = parser.parse_args()
assert args.rank is not None, "must provide rank argument."
assert args.num_gpus <= 3, f"Only 0-2 GPUs currently supported (got {args.num_gpus})."
os.environ['MASTER_ADDR'] = args.master_addr
os.environ["MASTER_PORT"] = args.master_port
现在，我们将根据命令行参数创建一个对应于参数服务器或训练器的进程。如果传入的 rank 为 0，我们将创建一个 ParameterServer，否则创建一个 TrainerNet。请注意，我们正在使用 torch.multiprocessing 启动与我们想要执行的函数相对应的子进程，并通过主线程中的 p.join() 等待该进程完成。在初始化我们的训练器的情况下，我们还使用 PyTorch 的 dataloader，以便在 MNIST 数据集上指定训练和测试数据加载器。
processes = []
world_size = args.world_size
if args.rank == 0:
p = mp.Process(target=run_parameter_server, args=(0, world_size))
p.start()
processes.append(p)
else:
# Get data to train on
train_loader = torch.utils.data.DataLoader(
datasets.MNIST('../data', train=True, download=True,
transform=transforms.Compose([
transforms.ToTensor(),
transforms.Normalize((0.1307,), (0.3081,))
])),
batch_size=32, shuffle=True,)
test_loader = torch.utils.data.DataLoader(
datasets.MNIST(
'../data',
train=False,
transform=transforms.Compose([
transforms.ToTensor(),
transforms.Normalize((0.1307,), (0.3081,))
])),
batch_size=32,
shuffle=True,
)
# start training worker on this node
p = mp.Process(
target=run_worker,
args=(
args.rank,
world_size, args.num_gpus,
train_loader,
test_loader))
p.start()
processes.append(p)
for p in processes:
p.join()
要在本地运行该示例，请在不同的终端窗口中为服务器以及您希望启动的每个工作节点运行以下命令：python rpc_parameter_server.py --world_size=WORLD_SIZE --rank=RANK。例如，对于 world size 为 2 的主节点，命令将是 python rpc_parameter_server.py --world_size=2 --rank=0。然后，可以在另一个窗口中使用命令 python rpc_parameter_server.py --world_size=2 --rank=1 启动训练器，这将开始使用一个服务器和一个训练器进行训练。请注意，本教程假设使用 0 到 2 个 GPU 进行训练，并且该参数可以通过在训练脚本中传入 --num_gpus=N 来配置。
您可以传入命令行参数 --master_addr=ADDRESS 和 --master_port=PORT 以指示主工作节点正在监听的地址和端口，例如，用于测试训练器和主节点在不同机器上运行的功能。