|
| 1 | +# Copyright 2024 The HuggingFace Team. All rights reserved. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +import functools |
| 16 | +from typing import Any, Dict, Tuple |
| 17 | + |
| 18 | +import torch |
| 19 | + |
| 20 | +from ..utils.logging import get_logger |
| 21 | + |
| 22 | + |
| 23 | +logger = get_logger(__name__) # pylint: disable=invalid-name |
| 24 | + |
| 25 | + |
| 26 | +class ModelHook: |
| 27 | + r""" |
| 28 | + A hook that contains callbacks to be executed just before and after the forward method of a model. |
| 29 | + """ |
| 30 | + |
| 31 | + _is_stateful = False |
| 32 | + |
| 33 | + def initialize_hook(self, module: torch.nn.Module) -> torch.nn.Module: |
| 34 | + r""" |
| 35 | + Hook that is executed when a model is initialized. |
| 36 | +
|
| 37 | + Args: |
| 38 | + module (`torch.nn.Module`): |
| 39 | + The module attached to this hook. |
| 40 | + """ |
| 41 | + return module |
| 42 | + |
| 43 | + def deinitalize_hook(self, module: torch.nn.Module) -> torch.nn.Module: |
| 44 | + r""" |
| 45 | + Hook that is executed when a model is deinitalized. |
| 46 | +
|
| 47 | + Args: |
| 48 | + module (`torch.nn.Module`): |
| 49 | + The module attached to this hook. |
| 50 | + """ |
| 51 | + module.forward = module._old_forward |
| 52 | + del module._old_forward |
| 53 | + return module |
| 54 | + |
| 55 | + def pre_forward(self, module: torch.nn.Module, *args, **kwargs) -> Tuple[Tuple[Any], Dict[str, Any]]: |
| 56 | + r""" |
| 57 | + Hook that is executed just before the forward method of the model. |
| 58 | +
|
| 59 | + Args: |
| 60 | + module (`torch.nn.Module`): |
| 61 | + The module whose forward pass will be executed just after this event. |
| 62 | + args (`Tuple[Any]`): |
| 63 | + The positional arguments passed to the module. |
| 64 | + kwargs (`Dict[Str, Any]`): |
| 65 | + The keyword arguments passed to the module. |
| 66 | +
|
| 67 | + Returns: |
| 68 | + `Tuple[Tuple[Any], Dict[Str, Any]]`: |
| 69 | + A tuple with the treated `args` and `kwargs`. |
| 70 | + """ |
| 71 | + return args, kwargs |
| 72 | + |
| 73 | + def post_forward(self, module: torch.nn.Module, output: Any) -> Any: |
| 74 | + r""" |
| 75 | + Hook that is executed just after the forward method of the model. |
| 76 | +
|
| 77 | + Args: |
| 78 | + module (`torch.nn.Module`): |
| 79 | + The module whose forward pass been executed just before this event. |
| 80 | + output (`Any`): |
| 81 | + The output of the module. |
| 82 | +
|
| 83 | + Returns: |
| 84 | + `Any`: The processed `output`. |
| 85 | + """ |
| 86 | + return output |
| 87 | + |
| 88 | + def detach_hook(self, module: torch.nn.Module) -> torch.nn.Module: |
| 89 | + r""" |
| 90 | + Hook that is executed when the hook is detached from a module. |
| 91 | +
|
| 92 | + Args: |
| 93 | + module (`torch.nn.Module`): |
| 94 | + The module detached from this hook. |
| 95 | + """ |
| 96 | + return module |
| 97 | + |
| 98 | + def reset_state(self, module: torch.nn.Module): |
| 99 | + if self._is_stateful: |
| 100 | + raise NotImplementedError("This hook is stateful and needs to implement the `reset_state` method.") |
| 101 | + return module |
| 102 | + |
| 103 | + |
| 104 | +class HookRegistry: |
| 105 | + def __init__(self, module_ref: torch.nn.Module) -> None: |
| 106 | + super().__init__() |
| 107 | + |
| 108 | + self.hooks: Dict[str, ModelHook] = {} |
| 109 | + |
| 110 | + self._module_ref = module_ref |
| 111 | + self._hook_order = [] |
| 112 | + |
| 113 | + def register_hook(self, hook: ModelHook, name: str) -> None: |
| 114 | + if name in self.hooks.keys(): |
| 115 | + logger.warning(f"Hook with name {name} already exists, replacing it.") |
| 116 | + |
| 117 | + if hasattr(self._module_ref, "_old_forward"): |
| 118 | + old_forward = self._module_ref._old_forward |
| 119 | + else: |
| 120 | + old_forward = self._module_ref.forward |
| 121 | + self._module_ref._old_forward = self._module_ref.forward |
| 122 | + |
| 123 | + self._module_ref = hook.initialize_hook(self._module_ref) |
| 124 | + |
| 125 | + if hasattr(hook, "new_forward"): |
| 126 | + new_forward = hook.new_forward |
| 127 | + else: |
| 128 | + |
| 129 | + def new_forward(module, *args, **kwargs): |
| 130 | + args, kwargs = hook.pre_forward(module, *args, **kwargs) |
| 131 | + output = old_forward(*args, **kwargs) |
| 132 | + return hook.post_forward(module, output) |
| 133 | + |
| 134 | + new_forward = functools.update_wrapper(new_forward, old_forward) |
| 135 | + self._module_ref.forward = new_forward.__get__(self._module_ref) |
| 136 | + |
| 137 | + self.hooks[name] = hook |
| 138 | + self._hook_order.append(name) |
| 139 | + |
| 140 | + def get_hook(self, name: str) -> ModelHook: |
| 141 | + if name not in self.hooks.keys(): |
| 142 | + raise ValueError(f"Hook with name {name} not found.") |
| 143 | + return self.hooks[name] |
| 144 | + |
| 145 | + def remove_hook(self, name: str) -> None: |
| 146 | + if name not in self.hooks.keys(): |
| 147 | + raise ValueError(f"Hook with name {name} not found.") |
| 148 | + self.hooks[name].deinitalize_hook(self._module_ref) |
| 149 | + del self.hooks[name] |
| 150 | + self._hook_order.remove(name) |
| 151 | + |
| 152 | + @classmethod |
| 153 | + def check_if_exists_or_initialize(cls, module: torch.nn.Module) -> "HookRegistry": |
| 154 | + if not hasattr(module, "_diffusers_hook"): |
| 155 | + module._diffusers_hook = cls(module) |
| 156 | + return module._diffusers_hook |
| 157 | + |
| 158 | + def __repr__(self) -> str: |
| 159 | + hook_repr = "" |
| 160 | + for i, hook_name in enumerate(self._hook_order): |
| 161 | + hook_repr += f" ({i}) {hook_name} - ({self.hooks[hook_name].__class__.__name__})" |
| 162 | + if i < len(self._hook_order) - 1: |
| 163 | + hook_repr += "\n" |
| 164 | + return f"HookRegistry(\n{hook_repr}\n)" |
0 commit comments