Skip to content

llmcompressor.modifiers.utils.hooks

Classes:

  • HooksMixin –

    Mixin to manage hook registration, disabling, and removal.

HooksMixin

Bases: BaseModel

Mixin to manage hook registration, disabling, and removal. Modifiers should use self.register_hook(module, hook, hook_type) for hook registration and self.remove_hooks() for removal.

Modifiers which implement hooks should register them using self.register_..._hook(module, hook) rather than the usual module.register_..._hook(hook). Modifiers should remove hooks with self.remove_hooks().

Hooks can be applied to modules or parameters

Typical example

modifier.register_forward_hook(module, hook) with HooksMixin.disable_hooks(): model.forward(...) modifier.remove_hooks()

Example of activating only a specific subset of hooks

hooks = [modifier.register_forward_hook(module, hook) for module in ...] with HooksMixin.disable_hooks(keep=hooks): model.forward(...) modifier.remove_hooks(hooks)

Methods:

  • disable_hooks –

    Disable all hooks across all modifiers. Composing multiple contexts is

  • register_hook –

    Registers a hook on a specified module/parameter with the option to disable it

  • remove_hooks –

    Removes hooks registered by this modifier

disable_hooks classmethod 

disable_hooks(keep: Set[RemovableHandle] = frozenset())

Disable all hooks across all modifiers. Composing multiple contexts is equivalent to the union of keep arguments

Parameters:

  • keep

    (Set[RemovableHandle], default: frozenset() ) –

    optional set of handles to keep enabled

Source code in llmcompressor/modifiers/utils/hooks.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@classmethod
@contextlib.contextmanager
def disable_hooks(cls, keep: Set[RemovableHandle] = frozenset()):
    """
    Disable all hooks across all modifiers. Composing multiple contexts is
    equivalent to the union of `keep` arguments

    :param keep: optional set of handles to keep enabled
    """
    try:
        cls._HOOKS_DISABLED = True
        cls._HOOKS_KEEP_ENABLED |= keep
        yield
    finally:
        cls._HOOKS_DISABLED = False
        cls._HOOKS_KEEP_ENABLED -= keep

register_hook 

register_hook(
    target: Union[Module, Parameter],
    hook: Callable[[Any], Any],
    hook_type: str,
    **kwargs
) -> RemovableHandle

Registers a hook on a specified module/parameter with the option to disable it with HooksMixin.disable_hooks()

Parameters:

  • target

    (Union[Module, Parameter]) –

    the module or parameter on which the hook should be registered

  • hook

    (Callable[[Any], Any]) –

    the hook to register

  • hook_type

    (str) –

    the type of hook to register corresponding to the register_{hook_type}_hook attribute on torch.nn.Module. Ex. "forward", "forward_pre", "full_backward", "state_dict_post", ""

  • kwargs

    –

    keyword arguments to pass to register hook method

Source code in llmcompressor/modifiers/utils/hooks.py 
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def register_hook(
    self,
    target: Union[torch.nn.Module, torch.nn.Parameter],
    hook: Callable[[Any], Any],
    hook_type: str,
    **kwargs,
) -> RemovableHandle:
    """
    Registers a hook on a specified module/parameter with the option to disable it
    with HooksMixin.disable_hooks()

    :param target: the module or parameter on which the hook should be registered
    :param hook: the hook to register
    :param hook_type: the type of hook to register corresponding to the
        `register_{hook_type}_hook` attribute on torch.nn.Module.
        Ex. "forward", "forward_pre", "full_backward", "state_dict_post", ""
    :param kwargs: keyword arguments to pass to register hook method
    """
    handle = None

    @wraps(hook)
    def wrapped_hook(*args, **kwargs):
        nonlocal handle

        if (
            HooksMixin._HOOKS_DISABLED
            and handle not in HooksMixin._HOOKS_KEEP_ENABLED
        ):
            return

        return hook(*args, **kwargs)

    register_function = getattr(target, f"register_{hook_type}_hook")
    handle = register_function(wrapped_hook, **kwargs)
    self._hooks.add(handle)
    logger.debug(f"{self} added {handle}")

    return handle

remove_hooks 

remove_hooks(
    handles: Optional[Set[RemovableHandle]] = None,
)

Removes hooks registered by this modifier

Parameters:

  • handles

    (Optional[Set[RemovableHandle]], default: None ) –

    optional list of handles to remove, defaults to all hooks registerd by this modifier

Source code in llmcompressor/modifiers/utils/hooks.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def remove_hooks(self, handles: Optional[Set[RemovableHandle]] = None):
    """
    Removes hooks registered by this modifier

    :param handles: optional list of handles to remove, defaults to all hooks
        registerd by this modifier
    """
    if handles is None:
        handles = self._hooks

    for hook in handles:
        hook.remove()

    self._hooks -= handles