Lines Matching full:hook

271 def register_optimizer_step_pre_hook(hook: GlobalOptimizerPreHook) -> RemovableHandle:
272     r"""Register a pre hook common to all optimizers.
274     The hook should have the following signature::
276         hook(optimizer, args, kwargs) -> None or modified args and kwargs
279         hook (Callable): A user defined hook which is registered on all optimizers.
283             a handle that can be used to remove the added hook by calling
287     _global_optimizer_pre_hooks[handle.id] = hook
291 def register_optimizer_step_post_hook(hook: GlobalOptimizerPostHook) -> RemovableHandle:
292     r"""Register a post hook common to all optimizers.
294     The hook should have the following signature::
296         hook(optimizer, args, kwargs) -> None
299         hook (Callable): A user defined hook which is registered on all optimizers.
303             a handle that can be used to remove the added hook by calling
307     _global_optimizer_post_hooks[handle.id] = hook
456         When python tracing is enabled the profiler will hook into this
461         This is a workaround due to lack of a proper step hook on the optimizer,
527     def register_step_pre_hook(self, hook: OptimizerPreHook) -> RemovableHandle:
528         r"""Register an optimizer step pre hook which will be called before optimizer step.
532             hook(optimizer, args, kwargs) -> None or modified args and kwargs
535         args and kwargs are modified by the pre-hook, then the transformed
539             hook (Callable): The user defined hook to be registered.
543                 a handle that can be used to remove the added hook by calling
547         self._optimizer_step_pre_hooks[handle.id] = hook
550     def register_step_post_hook(self, hook: OptimizerPostHook) -> RemovableHandle:
551         r"""Register an optimizer step post hook which will be called after optimizer step.
555             hook(optimizer, args, kwargs) -> None
560             hook (Callable): The user defined hook to be registered.
564                 a handle that can be used to remove the added hook by calling
568         self._optimizer_step_post_hooks[handle.id] = hook
572         self, hook: Callable[["Optimizer"], None], prepend: bool = False
574 …r"""Register a state dict pre-hook which will be called before :meth:`~torch.optim.Optimizer.state…
578             hook(optimizer) -> None
581         The hook will be called with argument ``self`` before calling ``state_dict`` on ``self``.
582         The registered hook can be used to perform pre-processing before the ``state_dict``
586             hook (Callable): The user defined hook to be registered.
587             prepend (bool): If True, the provided pre ``hook`` will be fired before
589                 the provided ``hook`` will be fired after all the already registered
594                 a handle that can be used to remove the added hook by calling
598         self._optimizer_state_dict_pre_hooks[handle.id] = hook
605         hook: Callable[["Optimizer", StateDict], Optional[StateDict]],
608 …r"""Register a state dict post-hook which will be called after :meth:`~torch.optim.Optimizer.state…
612             hook(optimizer, state_dict) -> state_dict or None
614         The hook will be called with arguments ``self`` and ``state_dict`` after generating
615         a ``state_dict`` on ``self``. The hook may modify the state_dict inplace or optionally
616         return a new one. The registered hook can be used to perform post-processing
620             hook (Callable): The user defined hook to be registered.
621             prepend (bool): If True, the provided post ``hook`` will be fired before
623                 the provided ``hook`` will be fired after all the already registered
628                 a handle that can be used to remove the added hook by calling
632         self._optimizer_state_dict_post_hooks[handle.id] = hook
759         hook: Callable[["Optimizer", StateDict], Optional[StateDict]],
762         r"""Register a load_state_dict pre-hook which will be called before
766             hook(optimizer, state_dict) -> state_dict or None
770         passed in to ``load_state_dict``. The hook may modify the state_dict inplace
774         The hook will be called with argument ``self`` and ``state_dict`` before
775         calling ``load_state_dict`` on ``self``. The registered hook can be used to
779             hook (Callable): The user defined hook to be registered.
780             prepend (bool): If True, the provided pre ``hook`` will be fired before
782                 the provided ``hook`` will be fired after all the already registered
787                 a handle that can be used to remove the added hook by calling
791         self._optimizer_load_state_dict_pre_hooks[handle.id] = hook
797         self, hook: Callable[["Optimizer"], None], prepend: bool = False
799         r"""Register a load_state_dict post-hook which will be called after
803             hook(optimizer) -> None
807         The hook will be called with argument ``self`` after calling
808         ``load_state_dict`` on ``self``. The registered hook can be used to
813             hook (Callable): The user defined hook to be registered.
814             prepend (bool): If True, the provided post ``hook`` will be fired before
816                 the provided ``hook`` will be fired after all the already registered
821                 a handle that can be used to remove the added hook by calling
825         self._optimizer_load_state_dict_post_hooks[handle.id] = hook