Struct VaeEncoder 

pub struct VaeEncoder<T: Float> {
    pub encoder: Encoder<T>,
    pub quant_conv: Conv2d<T>,
    pub config: VaeEncoderConfig,
    /* private fields */
}

AutoencoderKL-style VAE encoder = Encoder + quant_conv.

The encoder produces [B, 2*latent_channels, H/8, W/8] after the Encoder stack; the 1x1 quant_conv then projects this through a learned linear map. The split into (mean, logvar) and any sampling happens in DiagonalGaussianDistribution.

Fields

encoder: Encoder<T>

The actual Encoder stack.

quant_conv: Conv2d<T>

1x1 quant projection over 2 * latent_channels channels.

config: VaeEncoderConfig

Frozen config copy.

Implementations

impl<T: Float> VaeEncoder<T>

pub fn load_hf_state_dict( &mut self, hf_state: &StateDict<T>, strict: bool, ) -> FerrotorchResult<DropReport>

Load a HuggingFace AutoencoderKL state dict into this module.

Accepts both:

• encoder.* / quant_conv.* (bare-VAE layout, the normalised form produced by the pin script for an encoder-only artifact)
• vae.encoder.* / vae.quant_conv.* (full SD pipeline checkpoint, e.g. an upstream runwayml/stable-diffusion-v1-5 model.safetensors)

Any other key (decoder, post_quant_conv, UNet, text encoder, …) is recorded in the returned DropReport (or, in strict mode, surfaces as FerrotorchError::InvalidArgument). This mirrors VaeDecoder::load_hf_state_dict so the same full-checkpoint file can be loaded twice — once for the encoder and once for the decoder — each time dropping the other half.

Errors

Forwards whatever each sub-module’s load_state_dict returns (ShapeMismatch on a wrong-shape tensor, InvalidArgument in strict mode when a required tensor is missing). Strict mode will surface decoder.* / post_quant_conv.* / etc. as errors; callers with a full VAE checkpoint must pass strict=false.

impl<T: Float> VaeEncoder<T>

pub fn new(cfg: VaeEncoderConfig) -> FerrotorchResult<Self>

Build a randomly-initialized VaeEncoder.

Errors

Returns the underlying FerrotorchError on bad config dims.

pub fn encode( &self, image: &Tensor<T>, ) -> FerrotorchResult<DiagonalGaussianDistribution<T>>

Encode an image into a diagonal Gaussian distribution over latent space. Matches AutoencoderKL.encode(image).latent_dist.

Errors

Returns FerrotorchError::ShapeMismatch when the input is not [B, out_channels, H, W]. Propagates downstream op errors.

pub fn encode_with_scaling( &self, image: &Tensor<T>, seed: u64, ) -> FerrotorchResult<Tensor<T>>

Encode an image, sample from the latent distribution with a deterministic seed, then multiply by scaling_factor. This matches the canonical SD pipeline call:

latent = vae.encode(image).latent_dist.sample() * vae.config.scaling_factor

The Box-Muller / xorshift noise generator runs on CPU and is fully deterministic for a given seed — different from PyTorch’s CUDA RNG, so the produced latent will NOT be numerically identical to a Python reference run; only statistically equivalent.

Errors

Returns the underlying FerrotorchError for shape or arithmetic failures.

Trait Implementations

impl<T: Debug + Float> Debug for VaeEncoder<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Float> Module<T> for VaeEncoder<T>

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

Forward returns the raw [B, 2*latent_channels, h, w] parameters tensor (concatenated mean/logvar, post quant_conv). Callers who want a latent should use Self::encode or Self::encode_with_scaling.

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 load_state_dict( &mut self, state: &StateDict<T>, strict: bool, ) -> FerrotorchResult<()>

Load parameters from a state dict.

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

Move all parameters and buffers to a device.

fn state_dict(&self) -> HashMap<String, Tensor<T>>

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

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 + 'static)>

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: Box<dyn Fn(&Tensor<T>, &Tensor<T>) + Send + Sync>, ) -> (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: Box<dyn Fn(&Tensor<T>) -> Result<Tensor<T>, FerrotorchError> + Send + Sync>, ) -> (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: Box<dyn Fn(&Tensor<T>, &Tensor<T>) + Send + Sync>, ) -> (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) -> Result<(), FerrotorchError>

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).