torch.optim.Optimizer.register_load_state_dict_pre_hook

Optimizer.register_load_state_dict_pre_hook(hook, prepend=False)

注册一个load_state_dict pre-hook，它将在调用 load_state_dict() 之前被调用。它应该具有以下签名：

hook(optimizer, state_dict) -> state_dict or None

hook 将使用 self 和 state_dict 作为参数在调用 load_state_dict 之前被调用。注册的 hook 可用于在调用 load_state_dict 之前执行预处理。

The optimizer argument is the optimizer instance being used and the state_dict argument is a shallow copy of the state_dict the user passed in to load_state_dict. The hook may modify the state_dict inplace or optionally return a new one. If a state_dict is returned, it will be used to be loaded into the optimizer.

参数

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

• prepend (bool) – 如果为 True，则提供的 hook 将在 load_state_dict 上已注册的所有 pre-hook 之前触发。否则，提供的 hook 将在已注册的所有 pre-hook 之后触发。（默认值：False）

返回

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

返回类型

torch.utils.hooks.RemoveableHandle