torch.optim.Optimizer.register_load_state_dict_pre_hook

Optimizer.register_load_state_dict_pre_hook(hook, prepend=False)

注册一个 load_state_dict 预钩子，该钩子将在调用 load_state_dict() 之前被调用。它应具有以下签名

hook(optimizer, state_dict) -> state_dict or None

参数 optimizer 是正在使用的优化器实例，参数 state_dict 是用户传递给 load_state_dict 的 state_dict 的浅拷贝。该钩子可以就地修改 state_dict，或者选择返回一个新的 state_dict。如果返回了一个 state_dict，它将被用来加载到优化器中。

在对 self 调用 load_state_dict 之前，将使用参数 self 和 state_dict 调用该钩子。注册的钩子可用于在调用 load_state_dict 之前执行预处理。

参数

• hook (Callable) – 要注册的用户定义钩子。

• prepend (bool) – 如果为 True，提供的预钩子 hook 将在所有已注册的 load_state_dict 预钩子之前触发。否则，提供的钩子 hook 将在所有已注册的预钩子之后触发。(默认值: False)

返回值

一个句柄，可以通过调用 handle.remove() 来移除添加的钩子

返回类型

torch.utils.hooks.RemoveableHandle