torch.jit.freeze

torch.jit.freeze(mod, preserved_attrs=None, optimize_numerics=True)

冻结 ScriptModule，将子模块和属性内联为常量。

冻结一个 ScriptModule 会克隆它，并尝试将克隆模块的子模块、参数和属性内联为 TorchScript IR 图中的常量。默认情况下，forward 方法将被保留，同时也会保留 preserved_attrs 中指定的属性和方法。此外，在保留方法中修改的任何属性都将被保留。

冻结目前只接受处于 eval 模式的 ScriptModules。

冻结应用了通用优化，这将加速您的模型，无论是在何种机器上。为了使用特定服务器设置进一步优化，请在冻结后运行 optimize_for_inference。

参数

• mod (ScriptModule) – 要冻结的模块

• preserved_attrs (Optional[List[str]]) – 除了 forward 方法之外，还要保留的属性列表。在保留方法中修改的属性也将被保留。

• optimize_numerics (bool) – 如果为 True，则会运行一组不严格保留数值的优化。有关优化的详细信息，请参阅 torch.jit.run_frozen_optimizations。

返回

冻结的 ScriptModule。

示例 (冻结一个带有 Parameter 的简单模块)

    def forward(self, input):
        output = self.weight.mm(input)
        output = self.linear(output)
        return output

scripted_module = torch.jit.script(MyModule(2, 3).eval())
frozen_module = torch.jit.freeze(scripted_module)
# parameters have been removed and inlined into the Graph as constants
assert len(list(frozen_module.named_parameters())) == 0
# See the compiled graph as Python code
print(frozen_module.code)

示例 (冻结一个带有保留属性的模块)

    def forward(self, input):
        self.modified_tensor += 1
        return input + self.modified_tensor

scripted_module = torch.jit.script(MyModule2().eval())
frozen_module = torch.jit.freeze(scripted_module, preserved_attrs=["version"])
# we've manually preserved `version`, so it still exists on the frozen module and can be modified
assert frozen_module.version == 1
frozen_module.version = 2
# `modified_tensor` is detected as being mutated in the forward, so freezing preserves
# it to retain model semantics
assert frozen_module(torch.tensor(1)) == torch.tensor(12)
# now that we've run it once, the next result will be incremented by one
assert frozen_module(torch.tensor(1)) == torch.tensor(13)

注意

也支持冻结子模块属性：frozen_module = torch.jit.freeze(scripted_module, preserved_attrs=[“submodule.version”])

注意

如果您不确定某个属性为何未被内联为常量，您可以在 frozen_module.forward.graph 上运行 dump_alias_db 来查看冻结是否检测到该属性已被修改。

注意

由于冻结将权重转换为常量并移除模块层次结构，因此 to 和其他用于操作设备或 dtype 的 nn.Module 方法将不再起作用。作为一种变通方法，您可以在 torch.jit.load 中指定 map_location 来重新映射设备，但是特定于设备的逻辑可能已经嵌入到模型中。