评价此页
★ ★ ★ ★ ★
beginner/saving_loading_models

注意

转到末尾下载完整的示例代码。

保存和加载模型#

创建于：2018年8月29日 | 最后更新：2025年6月26日 | 最后验证：2024年11月5日

作者： Matthew Inkawhich

本文档为有关保存和加载 PyTorch 模型的各种用例提供了解决方案。您可以阅读整个文档，也可以直接跳到您所需用例的代码。

在保存和加载模型方面，有三个核心函数需要熟悉

  1. torch.save：将序列化对象保存到磁盘。此函数使用 Python 的 pickle 工具进行序列化。模型、张量和各种对象的字典都可以使用此函数进行保存。

  2. torch.load：使用 pickle 的 unpickling 功能将 pickled 对象文件反序列化到内存中。此函数还有助于将数据加载到指定设备（请参阅跨设备保存和加载模型）。

  3. 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]}]

为推理保存和加载模型#

保存/加载整个模型#

保存

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 和批量归一化层设置为评估模式。不这样做会导致不一致的推理结果。

保存导出的程序#

如果您正在使用 torch.export，您可以使用 torch.export.save() 和 torch.export.load() API 来保存和加载您的 ExportedProgram，并使用 .pt2 文件扩展名。

class SimpleModel(torch.nn.Module):
     def forward(self, x):
         return x + 10

# Create a sample input
sample_input = torch.randn(5)

# Export the model
exported_program = torch.export.export(SimpleModel(), sample_input)

# Save the exported program
torch.export.save(exported_program, 'exported_program.pt2')

# Load the exported program
saved_exported_program = torch.export.load('exported_program.pt2')

保存和加载通用检查点以进行推理和/或恢复训练#

保存：#

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()。这样，您就可以灵活地以任何您想要的方式将模型加载到任何您想要的设备上。

© 版权所有 2024, PyTorch。

使用 PyData Sphinx 主题 0.15.4 构建。

在此页面上
PyTorch 库