sgF%rddlZddlZddlmZmZmZddlZddlmZddl m Z m Z ddl m Z dgZGddZy)N)CallableOptionalSet)register_multi_grad_hook)register_module_forward_hook register_module_forward_pre_hook) tree_flatten ModTrackerc eZdZUdZeeed< dZdZe dZ dZ dde e d e e d e e d e e fd Zd ZdZdZdZdZdZdZdZy)r a= ``ModTracker`` is a context manager that tracks the nn.Module hierarchy during execution so that other system can query which Module is currently being executed (or its backward is being executed). You can access the ``parents`` attribute on this context manager to get the set of all the Modules currently being executed via their fqn (fully qualified name, also used as the key within the state_dict). You can access the ``is_bw`` attribute to know if you are currently running in backward or not. Note that ``parents`` is never empty and always contains the "Global" key. The ``is_bw`` flag will remain ``True`` after the forward until another Module is executed. If you need it to be more accurate, please submit an issue requesting this. Adding a map from fqn to the module instance is possible but not done yet, please submit an issue requesting this if you need it. Example usage .. code-block:: python mod = torch.nn.Linear(2, 2) with ModTracker() as tracker: # Access anything during the forward pass def my_linear(m1, m2, bias): print(f"Current modules: {tracker.parents}") return torch.mm(m1, m2.t()) + bias torch.nn.functional.linear = my_linear mod(torch.rand(2, 2)) parentscdh|_i|_tj|_tj |_d|_d|_d|_ d|_ d|_ yNGlobalF) r _active_module_cntweakrefWeakKeyDictionary_known_modulesWeakSet _seen_modules _has_callback_user_pre_fw_hook_user_post_fw_hook_user_pre_bw_hook_user_post_bw_hookselfs W/var/www/html/venv/lib/python3.12/site-packages/torch/distributed/_tools/mod_tracker.py__init__zModTracker.__init__8s[ z "$9@9R9R9T.5oo.?"!%"&!%"&cjryfd}tjjjj |d_y)Nc$dh_d_yr)r rrsrcallbackz7ModTracker._maybe_set_engine_callback..callbackHs$:DL!&D rT)rtorchautogradVariable_execution_enginequeue_callback)rr"s` r_maybe_set_engine_callbackz%ModTracker._maybe_set_engine_callbackCs<     ' 11@@J!rcDtjjdk7S)z` A boolean marking if this is currently running during the backward pass or not )r#_C_current_graph_task_idrs ris_bwzModTracker.is_bwOs xx..0B66rc:|jj|dS)zo Return the fqn for the given module if it is known to the ``ModTracker``, otherwise ``None``. N)rget)rmods r get_known_fqnzModTracker.get_known_fqnVs""&&sD11rN pre_fw_hook post_fw_hook pre_bw_hook post_bw_hookcd}|||jd|_|||jd|_|||jd|_|||jd|_y)aB Registers user-specified hooks to be called before/after the forward/backward pass for each module tracked by the ``ModTracker``. One or more can be ``None``. Args: pre_fw_hook (Callable, optional): A hook to be called before the forward pass for the module. It should have the following signature: pre_fw_hook (module, input) -> None post_fw_hook (Callable, optional): A hook to be called after the forward pass for the module. It should have the following signature: post_fw_hook (module, input, output) -> None pre_bw_hook (Callable, optional): A multi-grad hook to be called on all the outputs of the module that require gradients. It should have the following signature: pre_bw_hook (module, grad_output) -> None post_bw_hook (Callable, optional): A multi-grad hook to be called on all the inputs of the module that require gradients. It should have the following signature: post_bw_hook (module, grad_input) -> None Raises: AssertionError: If a new hook is provided when one is already registered. Note: If the module is not alive during the backward pass, the pre_bw_hook and post_bw_hook will will receive None as the module argument. The module fqn will be present in the ``parents`` attribute when each of the hooks is called. Hooks are intended to be used as markers only not to modify the inputs/outputs. c,||td|d|S)Nz Only one zq can be registered at a time Clear the existing hook by calling ``clear_user_hooks`` before registering a new one)AssertionError)hook user_hook hook_names rset_hookz0ModTracker.register_user_hooks..set_hook|s4I$9$ {+lmKrr2r3r4r5Nrrrr)rr2r3r4r5r<s rregister_user_hookszModTracker.register_user_hooks\sx@ "* //" #+ $11># "* //" #+ $11># rc<d|_d|_d|_d|_y)zY Clears the user specified hooks registered with ``register_user_hooks`` Nr=rs rclear_user_hookszModTracker.clear_user_hookss$"&"&!%"&rcP||jvr"t|j|j|<|j|}||jvrX|j D]*\}}|d||j|<|j |,|jj ||S)N.)rtype__name__rnamed_children _get_mod_nameadd)rr0mod_namenamesubmods rrFzModTracker._get_mod_names d)) )'+Cy'9'9D   $&&s+ d(( ( # 2 2 4 + f19 !D6.B##F+""6* +    " "3 'rcfd}|S)Ncrjjvr0js$dd}|t_tj djvr+dj <jjnj xxdz cc<jrj|yyy)Nc2|d|d|jd|dS)N:z: z )rD)msgcategoryfilenamelinenolines rcustom_formatwarningzCModTracker._get_append_fn..fn..custom_formatwarnings(&Zq83D3D2ERuCPPrzbThe module hierarchy tracking maybe be messed up. Please file a bug to PyTorch, if it is the case.N) r(r r-warnings formatwarningwarnrrGr)argsrTr-rIrw_mods rfnz%ModTracker._get_append_fn..fns//1t||#DJJQ*>& H4<<'01''-   &''-2-%%1e&&uw57<1rrr[rIr-r\s```` r_get_append_fnzModTracker._get_append_fns 6, rcfd}|S)Nc&jrj|jvrFjxxdzcc<jdk(rjjyyjs t dy)NrUrz?The Module hierarchy tracking is wrong. Report a bug to PyTorch)rr rremover- RuntimeError)rZr-rIrr[s rr\z"ModTracker._get_pop_fn..fns&&2u''6t||#''-2-**40A5LL''-6ZZ#U rr]r^s```` r _get_pop_fnzModTracker._get_pop_fns  rc|j|}tj|}|j||d|j|j ||t |\}}|Dcgc],}t |tjs|js+|.}}|js!|rt||j||dyyycc}wNFT) rFrrefr_rr isinstancer#Tensor requires_gradr-rrd) rr0inputrIr[rZ_atensorss r _fw_pre_hookzModTracker._fw_pre_hooks!!#& C /E4/1  ! ! -  " "3 .u%a"VjELL&Aaoo1VVzzg $Wd.>.>udD.Q R&zWs/C CCc|j|}tj|}|j|j||||j ||dt |\}}|Dcgc],}t |tjs|js+|.} }|js!| rt| |j||dyyycc}wrf) rFrrgrrdr rhr#rirjr-rr_) rr0rkoutputrIr[rZrlrmrns r _fw_post_hookzModTracker._fw_post_hooks!!#& C   " " .  # #C 7,e,.v&a"VjELL&Aaoo1VVzzg $Wd.A.A%t.T U&zWs0C CCcrt|j|_t|jd|_|S)NT) always_call)rro_fw_pre_handlerrr_fw_post_handlers r __enter__zModTracker.__enter__s4>t?P?PQ;   D  rcl|jj|jjyrV)rurbrv)rrZs r__exit__zModTracker.__exit__s& ""$ ##%r)NNNN)rD __module__ __qualname____doc__rstr__annotations__rr(propertyr-r1rrr>r@rFr_rdrorrrwryr]rrr r s@X ' "77 2+/+/*.+/ 3 h'3 x(3 h' 3 x( 3 j' 2" S V&r)rWrtypingrrrr#torch.autograd.graphrtorch.nn.modules.modulerrtorch.utils._pytreer __all__r r]rrrs6** 9- .\&\&r