注意
点击此处下载完整的示例代码
保存和加载模型¶
创建于：2018 年 8 月 29 日 | 最后更新：2024 年 9 月 10 日 | 最后验证：2024 年 11 月 05 日
本文档提供了关于保存和加载 PyTorch 模型的各种用例的解决方案。您可以通读整个文档，或者直接跳到您所需用例的代码。
在保存和加载模型时，需要熟悉三个核心函数
torch.save：将序列化对象保存到磁盘。此函数使用 Python 的 pickle 实用程序进行序列化。可以使用此函数保存模型、张量和各种对象的字典。
torch.load：使用 pickle 的反序列化功能将 pickle 对象文件反序列化到内存。此函数还方便指定将数据加载到的设备（请参阅跨设备保存和加载模型）。
torch.nn.Module.load_state_dict：使用反序列化的 state_dict 加载模型的参数字典。有关 state_dict 的更多信息，请参阅什么是 state_dict？。
目录
什么是 state_dict？¶
在 PyTorch 中，torch.nn.Module 模型的学习参数（即权重和偏差）包含在模型的参数中（使用 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() 函数接受字典对象，而不是保存对象的路径。这意味着您必须在将反序列化的 state_dict 传递给 load_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() 以将这些层设置为训练模式。
使用来自不同模型的参数预热启动模型¶
保存：¶
torch.save(modelA.state_dict(), PATH)
加载：¶
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) 会返回 my_tensor 在 GPU 上的新副本。它不会覆盖 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) 会返回 my_tensor 在 GPU 上的新副本。它不会覆盖 my_tensor。因此，请记住手动覆盖张量：my_tensor = my_tensor.to(torch.device('cuda'))。
保存 torch.nn.DataParallel 模型¶
保存
torch.save(model.module.state_dict(), PATH)
加载
# Load to whatever device you want
torch.nn.DataParallel 是一个模型包装器，可实现并行 GPU 利用率。要通用地保存 DataParallel 模型，请保存 model.module.state_dict()。这样，您可以灵活地以任何您想要的方式将模型加载到任何您想要的设备。
脚本的总运行时间： (0 分钟 0.000 秒)
