注意
点击 此处 下载完整的示例代码
保存和加载模型¶
本文档提供了有关保存和加载 PyTorch 模型的各种用例的解决方案。您可以自由阅读整篇文档，或者直接跳到您需要的特定用例的代码。
在保存和加载模型方面，需要熟悉三个核心函数
torch.save：将序列化对象保存到磁盘。此函数使用 Python 的 pickle 实用程序进行序列化。可以使用此函数保存模型、张量以及各种对象的字典。
torch.load：使用 pickle 的反序列化功能将腌制后的对象文件反序列化到内存。此函数还方便指定将数据加载到的设备（请参阅 跨设备保存和加载模型）。
torch.nn.Module.load_state_dict：使用反序列化的 state_dict 加载模型的参数字典。有关 state_dict 的更多信息，请参阅 什么是 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() 函数接受一个字典对象，而不是保存对象的路径。这意味着您必须在将保存的 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) 会在 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'))。
保存 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 秒）
