评价此页
★ ★ ★ ★ ★
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 的反序列化功能将腌制的对象文件反序列化到内存。此函数还方便将数据加载到设备上（请参阅 跨设备保存和加载模型）。

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

用于推理的保存和加载模型#

保存/加载整个模型#

保存

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 和 batch normalization 层设置为评估模式。未能这样做会导致不一致的推理结果。

保存导出的程序#

如果您正在使用 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 和 batch normalization 层设置为评估模式。未能这样做会导致不一致的推理结果。如果您希望恢复训练，请调用 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 和 batch normalization 层设置为评估模式。否则，推理结果将不一致。如果您希望恢复训练，请调用 model.train() 将这些层设置为训练模式。

使用来自不同模型的参数 Warmstarting 模型#

保存：#

torch.save(modelA.state_dict(), PATH)

加载：#

modelB = TheModelBClass(*args, **kwargs)
modelB.load_state_dict(torch.load(PATH, weights_only=True), strict=False)

部分加载模型或加载部分模型是在进行迁移学习或训练新的复杂模型时常见的场景。利用训练好的参数，即使只有一部分可用，也有助于 warmstart 训练过程，并有望帮助您的模型比从头开始训练更快地收敛。

无论您是加载一个缺少某些键的部分 state_dict，还是加载一个键比您要加载到的模型更多的 state_dict，您都可以将 strict 参数设置为 False 在 load_state_dict() 函数中，以忽略不匹配的键。

如果您想将参数从一个层加载到另一个层，但某些键不匹配，只需更改您正在加载的 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()。这样，您可以灵活地以您想要的方式将模型加载到您想要的任何设备上。

在此页面上
PyTorch 库