Struct HookedModule 

pub struct HookedModule<M, T: Float> { /* private fields */ }

A wrapper that adds hook storage around any Module.

HookedModule implements Module<T> itself, so it can be used anywhere the inner module could be used. Hooks are stored behind Mutexes and the wrapper is Send + Sync as long as the inner module is.

Implementations

impl<M, T: Float> HookedModule<M, T>

pub fn new(module: M) -> Self

Wrap a module, enabling hook registration.

pub fn register_forward_hook(&self, hook: ForwardHook<T>) -> HookHandle

Register a hook that fires after forward.

The hook receives (&input, &output). Returns a HookHandle that can be used to unregister the hook.

pub fn register_forward_pre_hook(&self, hook: ForwardPreHook<T>) -> HookHandle

Register a hook that fires before forward.

The hook receives (&input) and returns a (possibly modified) input tensor. Returns a HookHandle.

pub fn register_backward_hook(&self, hook: BackwardHook<T>) -> HookHandle

Register a hook that fires during the backward pass.

The hook receives (&grad_input, &grad_output). Returns a HookHandle.

pub fn inner(&self) -> &M

Borrow the inner module.

pub fn inner_mut(&mut self) -> &mut M

Mutably borrow the inner module.

pub fn into_inner(self) -> M

Consume the wrapper and return the inner module.

Trait Implementations

impl<M: Module<T>, T: Float> Module<T> for HookedModule<M, T>

fn forward(&self, input: &Tensor<T>) -> FerrotorchResult<Tensor<T>>

Forward pass. Takes input tensor, returns output tensor.

fn parameters(&self) -> Vec<&Parameter<T>>

Iterate over all learnable parameters.

fn parameters_mut(&mut self) -> Vec<&mut Parameter<T>>

Iterate over all learnable parameters mutably.

fn named_parameters(&self) -> Vec<(String, &Parameter<T>)>

Named parameters for state dict serialization.

fn train(&mut self)

Set training mode. Affects dropout, batchnorm, etc.

fn eval(&mut self)

Set evaluation mode.

fn is_training(&self) -> bool

Whether the module is in training mode.

fn state_dict(&self) -> StateDict<T>

Export parameters and buffers as a state dict (torch parity).

fn load_state_dict( &mut self, state: &StateDict<T>, strict: bool, ) -> FerrotorchResult<()>

Load parameters from a state dict.

fn to_device(&mut self, device: Device) -> FerrotorchResult<()>

Move all parameters and buffers to a device.

fn buffers(&self) -> Vec<&Buffer<T>>

Iterate over all non-trainable buffers (e.g. running mean / variance in BatchNorm). Default returns empty — concrete modules with buffers override.

fn buffers_mut(&mut self) -> Vec<&mut Buffer<T>>

Mutable iteration over all buffers. Default returns empty.

fn named_buffers(&self) -> Vec<(String, &Buffer<T>)>

Named buffers (dot-separated paths for nested modules). Default returns empty.

fn as_any(&self) -> Option<&dyn Any>

Downcast hook for type-erased buffer-loader dispatch. (#984)

fn children(&self) -> Vec<&dyn Module<T>>

Direct child modules. Default returns empty (leaf module).

fn named_children(&self) -> Vec<(String, &dyn Module<T>)>

Direct child modules with their attribute names. Default returns empty.

fn modules(&self) -> Vec<&dyn Module<T>>

where Self: Sized,

All modules in this subtree, depth-first (self first, then each child’s descendants in order).

fn descendants_dyn(&self) -> Vec<&dyn Module<T>>

All strict descendants of self in depth-first order. Object-safe.

fn named_modules(&self) -> Vec<(String, &dyn Module<T>)>

where Self: Sized,

All modules in this subtree with dot-separated path names. The root is named ""; children paths are joined with ..

fn named_descendants_dyn(&self) -> Vec<(String, &dyn Module<T>)>

Strict descendants with dot-paths. Object-safe.

fn with_forward_hook( self, hook: ForwardHook<T>, ) -> (HookedModule<Self, T>, HookHandle)

where Self: Sized,

Wrap this module in a HookedModule and register a forward hook. Returns the wrapper paired with a HookHandle that can be used to remove the hook later. The wrapper implements Module<T> itself, so it slots into any place the original module did. Mirrors torch.nn.Module.register_forward_hook.

fn with_forward_pre_hook( self, hook: ForwardPreHook<T>, ) -> (HookedModule<Self, T>, HookHandle)

where Self: Sized,

Wrap this module in a HookedModule and register a forward pre-hook. See Self::with_forward_hook. Mirrors torch.nn.Module.register_forward_pre_hook.

fn with_backward_hook( self, hook: BackwardHook<T>, ) -> (HookedModule<Self, T>, HookHandle)

where Self: Sized,

Wrap this module in a HookedModule and register a backward hook. See Self::with_forward_hook. Mirrors torch.nn.Module.register_backward_hook.

fn zero_grad(&self) -> FerrotorchResult<()>

Set the gradient of every parameter to None.

fn requires_grad_(&mut self, requires_grad: bool)

Toggle requires_grad on every parameter (freeze / unfreeze the module). Mirrors torch.nn.Module.requires_grad_.

fn apply_to_parameters(&mut self, f: &mut dyn FnMut(&mut Parameter<T>))

Apply a function to every parameter in this module. Mirrors torch.nn.Module.apply for the parameter case (true apply recurses over all submodules; the recursive form requires &mut dyn Module which conflicts with this trait’s &mut self borrow).