注意
点击here下载完整的示例代码
保存和加载模型
创建于：2018年8月29日 | 最后更新：2024年9月10日 | 最后验证：2024年11月5日
本文档提供了关于保存和加载PyTorch模型的各种用例的解决方案。您可以自由阅读整个文档，或者直接跳转到您需要的用例代码。
在保存和加载模型时，有三个核心函数需要熟悉：
torch.save: 将序列化对象保存到磁盘。此函数使用Python的 pickle工具 进行序列化。可以使用此函数保存模型、张量以及各种对象的字典。
torch.load: 使用pickle的反序列化功能将序列化的对象文件反序列化到内存中。 此函数还便于将数据加载到设备中（参见 Saving & Loading Model Across Devices）。
torch.nn.Module.load_state_dict: 使用反序列化的state_dict加载模型的参数字典。有关state_dict的更多信息，请参见What is a state_dict?。
内容：
什么是state_dict？
在 PyTorch 中，torch.nn.Module 模型的可学习参数（即权重和偏置）包含在模型的 parameters 中（通过 model.parameters() 访问）。state_dict 是一个简单的 Python 字典对象，它将每一层映射到其参数张量。请注意，只有具有可学习参数的层（卷积层、线性层等）和注册的缓冲区（batchnorm 的 running_mean）在模型的 state_dict 中有条目。优化器对象（torch.optim）也有一个 state_dict，其中包含有关优化器状态的信息以及使用的超参数。
因为state_dict对象是Python字典，它们可以轻松地保存、更新、修改和恢复，这为PyTorch模型和优化器增加了很大的模块化。
示例:
让我们看一下在训练分类器教程中使用的简单模型的state_dict。
# Define model
class TheModelClass(nn.Module):
def __init__(self):
super(TheModelClass, self).__init__()
self.conv1 = nn.Conv2d(3, 6, 5)
self.pool = nn.MaxPool2d(2, 2)
self.conv2 = nn.Conv2d(6, 16, 5)
self.fc1 = nn.Linear(16 * 5 * 5, 120)
self.fc2 = nn.Linear(120, 84)
self.fc3 = nn.Linear(84, 10)
def forward(self, x):
x = self.pool(F.relu(self.conv1(x)))
x = self.pool(F.relu(self.conv2(x)))
x = x.view(-1, 16 * 5 * 5)
x = F.relu(self.fc1(x))
x = F.relu(self.fc2(x))
x = self.fc3(x)
return x
# Initialize model
model = TheModelClass()
# Initialize optimizer
optimizer = optim.SGD(model.parameters(), lr=0.001, momentum=0.9)
# Print model's state_dict
print("Model's state_dict:")
for param_tensor in model.state_dict():
print(param_tensor, "\t", model.state_dict()[param_tensor].size())
# Print optimizer's state_dict
print("Optimizer's state_dict:")
for var_name in optimizer.state_dict():
print(var_name, "\t", optimizer.state_dict()[var_name])
输出:
Model's state_dict:
conv1.weight torch.Size([6, 3, 5, 5])
conv1.bias torch.Size([6])
conv2.weight torch.Size([16, 6, 5, 5])
conv2.bias torch.Size([16])
fc1.weight torch.Size([120, 400])
fc1.bias torch.Size([120])
fc2.weight torch.Size([84, 120])
fc2.bias torch.Size([84])
fc3.weight torch.Size([10, 84])
fc3.bias torch.Size([10])
Optimizer's state_dict:
state {}
param_groups [{'lr': 0.001, 'momentum': 0.9, 'dampening': 0, 'weight_decay': 0, 'nesterov': False, 'params': [4675713712, 4675713784, 4675714000, 4675714072, 4675714216, 4675714288, 4675714432, 4675714504, 4675714648, 4675714720]}]
保存和加载模型用于推理
保存/加载 state_dict (推荐)
保存:
torch.save(model.state_dict(), PATH)
加载:
model = TheModelClass(*args, **kwargs)
model.load_state_dict(torch.load(PATH, weights_only=True))
model.eval()
注意
PyTorch 1.6 版本将 torch.save 切换为使用新的基于 zip 文件的格式。torch.load 仍然保留加载旧格式文件的能力。如果出于任何原因你希望 torch.save 使用旧格式，可以传递 kwarg 参数 _use_new_zipfile_serialization=False。
在保存模型进行推理时，只需要保存训练模型的学习参数。使用torch.save()函数保存模型的state_dict将为您提供最大的灵活性，以便以后恢复模型，这就是为什么它是保存模型的推荐方法。
一个常见的PyTorch约定是使用.pt或.pth文件扩展名来保存模型。
请记住，在运行推理之前，您必须调用model.eval()来将dropout和批量归一化层设置为评估模式。如果不这样做，将会导致不一致的推理结果。
注意
请注意，load_state_dict() 函数接受一个字典对象，而不是保存对象的路径。这意味着在将其传递给 load_state_dict() 函数之前，您必须反序列化保存的 state_dict。例如，您不能使用 model.load_state_dict(PATH) 来加载。
注意
如果你只计划保留表现最佳的模型（根据获得的验证损失），不要忘记best_model_state = model.state_dict()返回的是状态的引用而不是它的副本！你必须序列化best_model_state或使用best_model_state = deepcopy(model.state_dict())，否则你最佳的best_model_state将会被后续的训练迭代不断更新。结果，最终的模型状态将会是过拟合模型的状态。
保存/加载整个模型
保存:
torch.save(model, PATH)
加载:
# Model class must be defined somewhere
model = torch.load(PATH, weights_only=False)
model.eval()
这种保存/加载过程使用最直观的语法，并且涉及的代码量最少。以这种方式保存模型将使用Python的pickle模块保存整个模块。这种方法的缺点是序列化数据绑定到特定的类和保存模型时使用的确切目录结构。这是因为pickle不保存模型类本身。相反，它保存包含类的文件的路径，该路径在加载时使用。因此，当在其他项目中使用或重构后，您的代码可能会以各种方式中断。
一个常见的PyTorch约定是使用.pt或.pth文件扩展名来保存模型。
请记住，在运行推理之前，您必须调用model.eval()将dropout和批量归一化层设置为评估模式。如果不这样做，将会导致不一致的推理结果。
以TorchScript格式导出/加载模型
使用训练好的模型进行推理的一种常见方法是使用 TorchScript，这是PyTorch模型的中间表示，可以在Python以及像C++这样的高性能环境中运行。TorchScript实际上是推荐用于扩展推理和部署的模型格式。
注意
使用TorchScript格式，您将能够加载导出的模型并在不定义模型类的情况下运行推理。
导出：
model_scripted = torch.jit.script(model) # Export to TorchScript
model_scripted.save('model_scripted.pt') # Save
加载:
model = torch.jit.load('model_scripted.pt')
model.eval()
请记住，在运行推理之前，您必须调用model.eval()来将dropout和批量归一化层设置为评估模式。如果不这样做，将会导致不一致的推理结果。
有关TorchScript的更多信息，请随时访问专门的 教程。 您将熟悉跟踪转换，并学习如何在 C++环境中运行TorchScript模块。
保存和加载用于推理和/或恢复训练的通用检查点
保存:
torch.save({
'epoch': epoch,
'model_state_dict': model.state_dict(),
'optimizer_state_dict': optimizer.state_dict(),
'loss': loss,
...
}, PATH)
加载:
model = TheModelClass(*args, **kwargs)
optimizer = TheOptimizerClass(*args, **kwargs)
checkpoint = torch.load(PATH, weights_only=True)
model.load_state_dict(checkpoint['model_state_dict'])
optimizer.load_state_dict(checkpoint['optimizer_state_dict'])
epoch = checkpoint['epoch']
loss = checkpoint['loss']
model.eval()
# - or -
model.train()
在保存一个通用检查点时，无论是用于推理还是恢复训练，你都必须保存不仅仅是模型的state_dict。同样重要的是保存优化器的state_dict，因为它包含了随着模型训练而更新的缓冲区和参数。你可能还想保存的其他项目包括你停止的epoch、最新记录的训练损失、外部的torch.nn.Embedding层等。因此，这样的检查点通常比单独的模型大2~3倍。
要保存多个组件，可以将它们组织在一个字典中，并使用
torch.save() 来序列化该字典。PyTorch 的一个常见约定是使用 .tar 文件扩展名来保存这些检查点。
要加载项目，首先初始化模型和优化器，然后使用torch.load()在本地加载字典。从这里开始，您可以像预期的那样简单地查询字典来轻松访问保存的项目。
请记住，在运行推理之前，您必须调用model.eval()将dropout和批量归一化层设置为评估模式。如果不这样做，将会产生不一致的推理结果。如果您希望恢复训练，请调用model.train()以确保这些层处于训练模式。
在一个文件中保存多个模型
保存:
torch.save({
'modelA_state_dict': modelA.state_dict(),
'modelB_state_dict': modelB.state_dict(),
'optimizerA_state_dict': optimizerA.state_dict(),
'optimizerB_state_dict': optimizerB.state_dict(),
...
}, PATH)
加载:
modelA = TheModelAClass(*args, **kwargs)
modelB = TheModelBClass(*args, **kwargs)
optimizerA = TheOptimizerAClass(*args, **kwargs)
optimizerB = TheOptimizerBClass(*args, **kwargs)
checkpoint = torch.load(PATH, weights_only=True)
modelA.load_state_dict(checkpoint['modelA_state_dict'])
modelB.load_state_dict(checkpoint['modelB_state_dict'])
optimizerA.load_state_dict(checkpoint['optimizerA_state_dict'])
optimizerB.load_state_dict(checkpoint['optimizerB_state_dict'])
modelA.eval()
modelB.eval()
# - or -
modelA.train()
modelB.train()
当保存由多个torch.nn.Modules组成的模型时，例如GAN、序列到序列模型或模型集合，您遵循与保存一般检查点时相同的方法。换句话说，保存每个模型的state_dict和相应的优化器的字典。如前所述，您可以通过简单地将它们附加到字典中来保存任何其他可能有助于恢复训练的项目。
一个常见的PyTorch约定是使用.tar文件扩展名保存这些检查点。
要加载模型，首先初始化模型和优化器，然后使用torch.load()在本地加载字典。从这里开始，你可以像预期的那样简单地查询字典，轻松访问保存的项目。
请记住，在运行推理之前，您必须调用model.eval()将dropout和批量归一化层设置为评估模式。如果不这样做，将会产生不一致的推理结果。如果您希望恢复训练，请调用model.train()将这些层设置为训练模式。
使用来自不同模型的参数进行模型热启动
加载:
modelB = TheModelBClass(*args, **kwargs)
modelB.load_state_dict(torch.load(PATH, weights_only=True), strict=False)
部分加载模型或加载部分模型是迁移学习或训练新复杂模型时的常见场景。利用训练好的参数，即使只有少数可用，也将有助于预热训练过程，并有望帮助您的模型比从头开始训练更快地收敛。
无论你是从一个缺少某些键的部分state_dict加载，还是加载一个包含比你要加载的模型更多键的state_dict，你都可以在load_state_dict()函数中将strict参数设置为False，以忽略不匹配的键。
如果你想将参数从一个层加载到另一个层，但某些键不匹配，只需更改你正在加载的state_dict中的参数键名称，以匹配你正在加载的模型中的键。
跨设备保存和加载模型
在GPU上保存，在CPU上加载
保存:
torch.save(model.state_dict(), PATH)
加载:
device = torch.device('cpu')
model = TheModelClass(*args, **kwargs)
model.load_state_dict(torch.load(PATH, map_location=device, weights_only=True))
在CPU上加载使用GPU训练的模型时，将torch.device('cpu')传递给torch.load()函数中的map_location参数。在这种情况下，张量的底层存储会使用map_location参数动态地重新映射到CPU设备。
在GPU上保存，在GPU上加载
保存:
torch.save(model.state_dict(), PATH)
加载:
device = torch.device("cuda")
model = TheModelClass(*args, **kwargs)
model.load_state_dict(torch.load(PATH, weights_only=True))
model.to(device)
# Make sure to call input = input.to(device) on any input tensors that you feed to the model
当在GPU上加载一个在GPU上训练并保存的模型时，只需使用model.to(torch.device('cuda'))将初始化的model转换为CUDA优化的模型。同时，确保在所有模型输入上使用.to(torch.device('cuda'))函数来准备模型的数据。请注意，调用my_tensor.to(device)会在GPU上返回my_tensor的新副本。它不会覆盖my_tensor。因此，记得手动覆盖张量：my_tensor = my_tensor.to(torch.device('cuda'))。
节省CPU，加载到GPU
保存:
torch.save(model.state_dict(), PATH)
加载:
device = torch.device("cuda")
model = TheModelClass(*args, **kwargs)
model.load_state_dict(torch.load(PATH, weights_only=True, map_location="cuda:0")) # Choose whatever GPU device number you want
model.to(device)
# Make sure to call input = input.to(device) on any input tensors that you feed to the model
在GPU上加载在CPU上训练并保存的模型时，请在torch.load()函数中设置map_location参数为cuda:device_id。这将把模型加载到指定的GPU设备上。接下来，确保调用model.to(torch.device('cuda'))将模型的参数张量转换为CUDA张量。最后，确保在所有模型输入上使用.to(torch.device('cuda'))函数，以准备数据用于CUDA优化的模型。请注意，调用my_tensor.to(device)会在GPU上返回my_tensor的新副本。它不会覆盖my_tensor。因此，请记住手动覆盖张量：my_tensor = my_tensor.to(torch.device('cuda'))。
