pytorch模型存储的几种方式以及存在的问题

Tutorials

首先我们要了解pytorch有关保存和加载模型的三个核心函数

1. torch.save: 该函数用python的pickle实现序列化，并将序列化后的object放到硬盘。
2. torch.load: 用pickle将object从硬盘中反序列化到内存中。
3. torch.nn.Module.load_state_dict: 通过反序列化后的state_dict 来读取模型的训练参数。

state_dict

state_dict是一个简单的python字典，它映射模型的每一层到每一层的参数tensor. 这里值得注意的是，只有有可学习参数的层（例如convolutional layers，linear layers等等）以及已经注册的buffers才会在state_dict中存在。torch.optim对象同样也有state_dict,它处指出优化器的状态和优化器使用的超参数，这用于你需要再次训练的模型上。

以下给出pytorch Tutorials中给出的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]}]

几种保存方法

Save/Load state_dict （这是官方最推荐的方法）

Save:

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

Load:

model = TheModelClass(*args, **kwargs)
model.load_state_dict(torch.load(PATH))
model.eval()

该方法是官方推荐的保存模型的方案，保存模型时只保存了已经训练好的模型参数。这种保存方法较于保存整个模型来说更为灵活。这里需要注意的是model.load_state_dict()函数需要的是一个字典类型的输入，所以model.load_state_dict(PATH)是不可行的。这种方法有一个缺点就是需要初始化模型后将保存的模型学习参数赋值给模型。这样你就需要记录你曾经用于初始化模型的参数。

Save/Load Entire Model

pytorch同样可以保存整个模型，方法如下：
Save:

torch.save(model, PATH)

Load:

model = torch.load(PATH)
model.eval() 

该方法可以直接保存/读取一整个模型，这种方法非常直观，且很方便，涉及的代码很少，也不需要初始化模型。

存在的问题

1.设备错误问题
我在使用中遇到的一个直观的问题就是，保存的模型中绑定了训练时使用的设备号，如我在“cuda:3”上训练，保存的模型在你读取出来时就会默认是在"cuda:3"上，一个有意思的问题就是如果你的服务器上并没有4块卡，那模型读取时就会报错，

RuntimeError: Attempting to deserialize object on CUDA device 3 but torch.cuda.device_count() is 2. Please use torch.load with map_location to map your storages to an existing device.
出现这种情况时就需要用跨设备加载模型的方法，使用如下代码可以解决
Load

device = torch.device("cuda:0")
model = torch.load(PATH, map_location=device)

2.模型错误问题
我在使用的过程中还遇到的一个问题如下:

Conv1d' object has no attribute 'padding_mode'    

这应该是pytorch的一个bug, 解决方法如下：
方案一
重新初始化一个干净的模型，将训练参数赋值给模型。

model_state_dict = torch.load(model_path).state_dict()
model = WaveGlow(**waveglow_config)
model.load_state_dict(model_state_dict)
model.cuda()

方案二

for m in model.modules():
    if 'Conv' in str(type(m)):
        setattr(m, 'padding_mode', 'zeros')

保存checkpoint用于恢复训练

需要恢复训练，保存的就不能只是模型的state_dict, 还需要保存优化器和一些其他的超参数。

Save:

torch.save({
            'epoch': epoch,
            'model_state_dict': model.state_dict(),
            'optimizer_state_dict': optimizer.state_dict(),
            'loss': loss,
            ...
            }, PATH)

Load

model = TheModelClass(*args, **kwargs)
optimizer = TheOptimizerClass(*args, **kwargs)

checkpoint = torch.load(PATH)
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()

保存多个模型

Save:

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)

Load:

modelA = TheModelAClass(*args, **kwargs)
modelB = TheModelBClass(*args, **kwargs)
optimizerA = TheOptimizerAClass(*args, **kwargs)
optimizerB = TheOptimizerBClass(*args, **kwargs)

checkpoint = torch.load(PATH)
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()