序列化语义¶
本说明描述如何在 Python 中保存和加载 PyTorch 张量和模块状态，以及如何序列化 Python 模块以便在 C++ 中加载。
目录
保存和加载张量¶
torch.save() 和 torch.load() 允许您轻松保存和加载张量
>>> t = torch.tensor([1., 2.])
>>> torch.save(t, 'tensor.pt')
>>> torch.load('tensor.pt')
tensor([1., 2.])
按照惯例，PyTorch 文件通常使用“.pt”或“.pth”扩展名编写。
torch.save() 和 torch.load() 默认使用 Python 的 pickle，因此您还可以将多个张量作为 Python 对象（如元组、列表和字典）的一部分保存
>>> d = {'a': torch.tensor([1., 2.]), 'b': torch.tensor([3., 4.])}
>>> torch.save(d, 'tensor_dict.pt')
>>> torch.load('tensor_dict.pt')
{'a': tensor([1., 2.]), 'b': tensor([3., 4.])}
如果数据结构是可 pickle 的，则还可以保存包含 PyTorch 张量的自定义数据结构。
保存和加载张量会保留视图¶
保存张量会保留其视图关系
>>> numbers = torch.arange(1, 10)
>>> evens = numbers[1::2]
>>> torch.save([numbers, evens], 'tensors.pt')
>>> loaded_numbers, loaded_evens = torch.load('tensors.pt')
>>> loaded_evens *= 2
>>> loaded_numbers
tensor([ 1, 4, 3, 8, 5, 12, 7, 16, 9])
在幕后，这些张量共享同一个“存储”。有关视图和存储的更多信息，请参阅张量视图。
当 PyTorch 保存张量时，它会分别保存其存储对象和张量元数据。这是一个将来可能会更改的实现细节，但它通常可以节省空间并使 PyTorch 轻松重建加载的张量之间的视图关系。例如，在上面的代码段中，只有一个存储被写入“tensors.pt”。
但是，在某些情况下，保存当前存储对象可能是不必要的，并且会创建过大的文件。在下面的代码段中，一个比保存的张量大得多的存储被写入文件
>>> large = torch.arange(1, 1000)
>>> small = large[0:5]
>>> torch.save(small, 'small.pt')
>>> loaded_small = torch.load('small.pt')
>>> loaded_small.storage().size()
999
并没有仅将 small 张量中的五个值保存到“small.pt”，而是保存并加载了与其共享存储的 large 中的 999 个值。
当保存的张量的元素少于其存储对象时，可以通过先克隆张量来减小保存的文件的大小。克隆张量会生成一个新张量，该张量具有一个新的存储对象，该对象仅包含张量中的值
>>> large = torch.arange(1, 1000)
>>> small = large[0:5]
>>> torch.save(small.clone(), 'small.pt') # saves a clone of small
>>> loaded_small = torch.load('small.pt')
>>> loaded_small.storage().size()
5
但是，由于克隆的张量彼此独立，因此它们不具有原始张量所具有的任何视图关系。如果在保存小于其存储对象的张量时，文件大小和视图关系都很重要，则在保存之前必须小心构造新的张量，以最大程度地减小其存储对象的大小，但仍然具有所需的视图关系。
保存和加载 torch.nn.Modules¶
另请参阅：教程：保存和加载模块
在 PyTorch 中，模块的状态通常使用“状态字典”进行序列化。模块的状态字典包含其所有参数和持久缓冲区
>>> bn = torch.nn.BatchNorm1d(3, track_running_stats=True)
>>> list(bn.named_parameters())
[('weight', Parameter containing: tensor([1., 1., 1.], requires_grad=True)),
('bias', Parameter containing: tensor([0., 0., 0.], requires_grad=True))]
>>> list(bn.named_buffers())
[('running_mean', tensor([0., 0., 0.])),
('running_var', tensor([1., 1., 1.])),
('num_batches_tracked', tensor(0))]
>>> bn.state_dict()
OrderedDict([('weight', tensor([1., 1., 1.])),
('bias', tensor([0., 0., 0.])),
('running_mean', tensor([0., 0., 0.])),
('running_var', tensor([1., 1., 1.])),
('num_batches_tracked', tensor(0))])
出于兼容性原因，建议不要直接保存模块，而只保存其状态字典。Python 模块甚至有一个函数 load_state_dict()，用于从状态字典中恢复其状态
>>> torch.save(bn.state_dict(), 'bn.pt')
>>> bn_state_dict = torch.load('bn.pt')
>>> new_bn = torch.nn.BatchNorm1d(3, track_running_stats=True)
>>> new_bn.load_state_dict(bn_state_dict)
<All keys matched successfully>
请注意，首先使用 torch.load() 从其文件中加载状态字典，然后使用 load_state_dict() 恢复状态。
即使是自定义模块和包含其他模块的模块也具有状态字典，并且可以使用此模式
# A module with two linear layers
>>> class MyModule(torch.nn.Module):
def __init__(self):
super().__init__()
self.l0 = torch.nn.Linear(4, 2)
self.l1 = torch.nn.Linear(2, 1)
def forward(self, input):
out0 = self.l0(input)
out0_relu = torch.nn.functional.relu(out0)
return self.l1(out0_relu)
>>> m = MyModule()
>>> m.state_dict()
OrderedDict([('l0.weight', tensor([[ 0.1400, 0.4563, -0.0271, -0.4406],
[-0.3289, 0.2827, 0.4588, 0.2031]])),
('l0.bias', tensor([ 0.0300, -0.1316])),
('l1.weight', tensor([[0.6533, 0.3413]])),
('l1.bias', tensor([-0.1112]))])
>>> torch.save(m.state_dict(), 'mymodule.pt')
>>> m_state_dict = torch.load('mymodule.pt')
>>> new_m = MyModule()
>>> new_m.load_state_dict(m_state_dict)
<All keys matched successfully>
用于 torch.save 的序列化文件格式¶
从 PyTorch 1.6.0 开始，torch.save 默认返回未压缩的 ZIP64 存档，除非用户设置 _use_new_zipfile_serialization=False。
在此存档中，文件的顺序如下
checkpoint.pth
├── data.pkl
├── byteorder # added in PyTorch 2.1.0
├── data/
│ ├── 0
│ ├── 1
│ ├── 2
│ └── …
└── version
- 条目如下
data.pkl是将传递给torch.save的对象（不包括它包含的torch.Storage对象）进行 pickle 处理的结果。byteorder包含一个字符串，其中包含保存时的sys.byteorder（“little”或“big”）。data/包含对象中的所有存储，其中每个存储都是一个单独的文件。version包含保存时的版本号，可在加载时使用。
保存时，PyTorch 将确保每个文件的本地文件头都填充到 64 字节的倍数偏移量，从而确保每个文件的偏移量都与 64 字节对齐。
注意
某些设备（如 XLA）上的张量将序列化为 pickle 处理的 numpy 数组。因此，它们的存储不会被序列化。在这些情况下，检查点中可能不存在 data/。
序列化 torch.nn.Modules 并将其加载到 C++ 中¶
另请参阅：教程：在 C++ 中加载 TorchScript 模型
ScriptModules 可以序列化为 TorchScript 程序，并使用 torch.jit.load() 加载。此序列化编码所有模块的方法、子模块、参数和属性，并且允许在 C++ 中加载序列化程序（即无需 Python）。
torch.jit.save() 和 torch.save() 之间的区别可能并不立即明显。torch.save() 使用 pickle 保存 Python 对象。这对于原型设计、研究和训练特别有用。另一方面，torch.jit.save() 将 ScriptModules 序列化为可以在 Python 或 C++ 中加载的格式。这在保存和加载 C++ 模块时，或者在使用 C++ 运行在 Python 中训练的模块时非常有用，这是部署 PyTorch 模型的常见做法。
要在 Python 中编写脚本、序列化和加载模块
>>> scripted_module = torch.jit.script(MyModule())
>>> torch.jit.save(scripted_module, 'mymodule.pt')
>>> torch.jit.load('mymodule.pt')
RecursiveScriptModule( original_name=MyModule
(l0): RecursiveScriptModule(original_name=Linear)
(l1): RecursiveScriptModule(original_name=Linear) )
跟踪模块也可以使用 torch.jit.save() 保存，但需要注意的是，只有跟踪的代码路径会被序列化。以下示例演示了这一点
# A module with control flow
>>> class ControlFlowModule(torch.nn.Module):
def __init__(self):
super().__init__()
self.l0 = torch.nn.Linear(4, 2)
self.l1 = torch.nn.Linear(2, 1)
def forward(self, input):
if input.dim() > 1:
return torch.tensor(0)
out0 = self.l0(input)
out0_relu = torch.nn.functional.relu(out0)
return self.l1(out0_relu)
>>> traced_module = torch.jit.trace(ControlFlowModule(), torch.randn(4))
>>> torch.jit.save(traced_module, 'controlflowmodule_traced.pt')
>>> loaded = torch.jit.load('controlflowmodule_traced.pt')
>>> loaded(torch.randn(2, 4)))
tensor([[-0.1571], [-0.3793]], grad_fn=<AddBackward0>)
>>> scripted_module = torch.jit.script(ControlFlowModule(), torch.randn(4))
>>> torch.jit.save(scripted_module, 'controlflowmodule_scripted.pt')
>>> loaded = torch.jit.load('controlflowmodule_scripted.pt')
>> loaded(torch.randn(2, 4))
tensor(0)
上面的模块有一个 if 语句，该语句不会由跟踪的输入触发，因此不是跟踪模块的一部分，也不会与其一起序列化。但是，脚本模块包含 if 语句，并与其一起序列化。有关脚本和跟踪的更多信息，请参阅TorchScript 文档。
最后，要在 C++ 中加载模块
>>> torch::jit::script::Module module;
>>> module = torch::jit::load('controlflowmodule_scripted.pt');
有关如何在 C++ 中使用 PyTorch 模块的详细信息，请参阅PyTorch C++ API 文档。
跨 PyTorch 版本保存和加载 ScriptModules¶
PyTorch 团队建议使用相同版本的 PyTorch 保存和加载模块。旧版本的 PyTorch 可能不支持较新的模块，而较新版本可能已删除或修改了较旧的行为。这些更改在 PyTorch 的发行说明中有明确说明，依赖于已更改功能的模块可能需要更新才能继续正常工作。在有限的情况下（如下所述），PyTorch 将保留序列化 ScriptModules 的历史行为，因此它们不需要更新。
torch.div 执行整数除法¶
在 PyTorch 1.5 及更早版本中，当给出两个整数输入时，torch.div() 将执行地板除法
# PyTorch 1.5 (and earlier)
>>> a = torch.tensor(5)
>>> b = torch.tensor(3)
>>> a / b
tensor(1)
但是，在 PyTorch 1.7 中，torch.div() 将始终对其输入执行真除法，就像 Python 3 中的除法一样
# PyTorch 1.7
>>> a = torch.tensor(5)
>>> b = torch.tensor(3)
>>> a / b
tensor(1.6667)
torch.div() 的行为在序列化 ScriptModules 中得以保留。也就是说，即使使用较新版本的 PyTorch 加载，使用 1.6 之前版本的 PyTorch 序列化的 ScriptModules 仍将看到 torch.div() 在给出两个整数输入时执行地板除法。但是，使用 torch.div() 并在 PyTorch 1.6 及更高版本上序列化的 ScriptModules 无法在早期版本的 PyTorch 中加载，因为这些早期版本不理解新的行为。
torch.full 始终推断 float 数据类型¶
在 PyTorch 1.5 及更早版本中，torch.full() 始终返回一个 float 张量，而不管给定的填充值是什么
# PyTorch 1.5 and earlier
>>> torch.full((3,), 1) # Note the integer fill value...
tensor([1., 1., 1.]) # ...but float tensor!
但是，在 PyTorch 1.7 中，torch.full() 将从填充值推断返回张量的数据类型
# PyTorch 1.7
>>> torch.full((3,), 1)
tensor([1, 1, 1])
>>> torch.full((3,), True)
tensor([True, True, True])
>>> torch.full((3,), 1.)
tensor([1., 1., 1.])
>>> torch.full((3,), 1 + 1j)
tensor([1.+1.j, 1.+1.j, 1.+1.j])
torch.full() 的行为在序列化 ScriptModules 中得以保留。也就是说，使用 1.6 之前版本的 PyTorch 序列化的 ScriptModules 即使在给定布尔值或整型填充值时，默认情况下仍将看到 torch.full 返回 float 张量。但是，使用 torch.full() 并在 PyTorch 1.6 及更高版本上序列化的 ScriptModules 无法在早期版本的 PyTorch 中加载，因为这些早期版本不理解新的行为。
实用函数¶
以下实用函数与序列化相关
- torch.serialization.register_package(priority, tagger, deserializer)[源代码]¶
注册用于标记和反序列化存储对象的回调函数，并设置关联的优先级。标记在保存时将设备与存储对象相关联，而反序列化在加载时将存储对象移动到适当的设备。
tagger和deserializer按其priority给定的顺序运行，直到标记器/反序列化器返回一个不为 None 的值。要覆盖全局注册表中设备的反序列化行为，可以注册一个优先级高于现有标记器的标记器。
此函数还可用于为新设备注册标记器和反序列化器。
- 参数
priority (int) – 指示与标记器和反序列化器关联的优先级，其中较低的值表示较高的优先级。
tagger (Callable[[Union[Storage, TypedStorage, UntypedStorage]], Optional[str]]) – 可调用对象，它接收一个存储对象，并将其标记的设备作为字符串或 None 返回。
deserializer (Callable[[Union[Storage, TypedStorage, UntypedStorage]], str], Optional[Union[Storage, TypedStorage, UntypedStorage]]]) – 可调用对象，它接收存储对象和设备字符串，并在相应的设备上返回存储对象或 None。
- 返回值
无
示例
>>> def ipu_tag(obj): >>> if obj.device.type == 'ipu': >>> return 'ipu' >>> def ipu_deserialize(obj, location): >>> if location.startswith('ipu'): >>> ipu = getattr(torch, "ipu", None) >>> assert ipu is not None, "IPU device module is not loaded" >>> assert torch.ipu.is_available(), "ipu is not available" >>> return obj.ipu(location) >>> torch.serialization.register_package(11, ipu_tag, ipu_deserialize)
- torch.serialization.get_default_load_endianness()[源代码]¶
获取用于加载文件的回退字节顺序
如果保存的检查点中不存在字节顺序标记，则使用此字节顺序作为回退。默认情况下，它是“本机”字节顺序。
- 返回值
Optional[LoadEndianness]
- 返回类型
default_load_endian
- torch.serialization.set_default_load_endianness(endianness)[源代码]¶
设置加载文件的回退字节顺序
如果保存的检查点中不存在字节顺序标记，则使用此字节顺序作为回退。默认情况下，它是“本机”字节顺序。
- 参数
endianness – 新的回退字节顺序
- torch.serialization.get_default_mmap_options()[源代码]¶
使用
mmap=True获取torch.load()的默认 mmap 选项。默认为
mmap.MAP_PRIVATE。- 返回值
int
- 返回类型
default_mmap_options
- torch.serialization.set_default_mmap_options(flags)[源代码]¶
将使用
mmap=True的torch.load()的默认 mmap 选项设置为 flags。目前仅支持
mmap.MAP_PRIVATE或mmap.MAP_SHARED。 如果您需要添加任何其他选项，请提交问题。注意
Windows 当前不支持此功能。
- 参数
flags (int) –
mmap.MAP_PRIVATE或mmap.MAP_SHARED
- torch.serialization.add_safe_globals(safe_globals)[源代码]¶
将给定的全局变量标记为对
weights_only加载安全。例如，添加到此列表中的函数可以在反序列化期间调用，类可以被实例化并设置状态。- 参数
safe_globals (List[Any]) – 要标记为安全的全局变量列表
示例
>>> import tempfile >>> class MyTensor(torch.Tensor): ... pass >>> t = MyTensor(torch.randn(2, 3)) >>> with tempfile.NamedTemporaryFile() as f: ... torch.save(t, f.name) # Running `torch.load(f.name, weights_only=True)` will fail with # Unsupported global: GLOBAL __main__.MyTensor was not an allowed global by default. # Check the code and make sure MyTensor is safe to be used when loaded from an arbitrary checkpoint. ... torch.serialization.add_safe_globals([MyTensor]) ... torch.load(f.name, weights_only=True) # MyTensor([[-0.5024, -1.8152, -0.5455], # [-0.8234, 2.0500, -0.3657]])
