Table of Contents
Shortcuts
beginner/saving_loading_models

备注

点击 这里 下载完整示例代码

保存和加载模型

Created On: Aug 29, 2018 | Last Updated: Sep 10, 2024 | Last Verified: Nov 05, 2024

作者： Matthew Inkawhich

本文档提供了有关保存和加载 PyTorch 模型的各种用例的解决方案。可以阅读完整文档，也可直接跳到需要的代码段以满足特定用例。

在保存和加载模型时，有三个核心功能需要熟悉：

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

  2. torch.load: 使用 pickle 的反序列化功能将对象文件从磁盘加载到内存中。此函数还支持将数据加载到指定设备（参见 跨设备保存和加载模型 <#saving-loading-model-across-devices>）。

  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 和批规范化层设置为评估模式。如果没有这样做，将会产生不一致的推断结果。

以 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 秒)

画廊由 Sphinx-Gallery 生成

文档

访问 PyTorch 的详细开发者文档

查看文档

教程

获取针对初学者和高级开发人员的深入教程

查看教程

资源

查找开发资源并获得问题的解答

查看资源

为了分析流量并优化您的体验，我们在此网站上提供Cookie。点击或浏览即表示您同意我们使用Cookie。 作为本网站的当前维护者，Facebook的Cookie政策适用。了解更多信息，包括可用的控件： Cookies政策.