sae-lens 5.10.7__py3-none-any.whl → 6.0.0__py3-none-any.whl

sae_lens/saes/gated_sae.py

@@ -0,0 +1,254 @@
+from dataclasses import dataclass
+from typing import Any
+
+import torch
+from jaxtyping import Float
+from numpy.typing import NDArray
+from torch import nn
+from typing_extensions import override
+
+from sae_lens.saes.sae import (
+    SAE,
+    SAEConfig,
+    TrainCoefficientConfig,
+    TrainingSAE,
+    TrainingSAEConfig,
+    TrainStepInput,
+)
+from sae_lens.util import filter_valid_dataclass_fields
+
+
+@dataclass
+class GatedSAEConfig(SAEConfig):
+    """
+    Configuration class for a GatedSAE.
+    """
+
+    @override
+    @classmethod
+    def architecture(cls) -> str:
+        return "gated"
+
+
+class GatedSAE(SAE[GatedSAEConfig]):
+    """
+    GatedSAE is an inference-only implementation of a Sparse Autoencoder (SAE)
+    using a gated linear encoder and a standard linear decoder.
+    """
+
+    b_gate: nn.Parameter
+    b_mag: nn.Parameter
+    r_mag: nn.Parameter
+
+    def __init__(self, cfg: GatedSAEConfig, use_error_term: bool = False):
+        super().__init__(cfg, use_error_term)
+        # Ensure b_enc does not exist for the gated architecture
+        self.b_enc = None
+
+    @override
+    def initialize_weights(self) -> None:
+        super().initialize_weights()
+        _init_weights_gated(self)
+
+    def encode(
+        self, x: Float[torch.Tensor, "... d_in"]
+    ) -> Float[torch.Tensor, "... d_sae"]:
+        """
+        Encode the input tensor into the feature space using a gated encoder.
+        This must match the original encode_gated implementation from SAE class.
+        """
+        # Preprocess the SAE input (casting type, applying hooks, normalization)
+        sae_in = self.process_sae_in(x)
+
+        # Gating path exactly as in original SAE.encode_gated
+        gating_pre_activation = sae_in @ self.W_enc + self.b_gate
+        active_features = (gating_pre_activation > 0).to(self.dtype)
+
+        # Magnitude path (weight sharing with gated encoder)
+        magnitude_pre_activation = self.hook_sae_acts_pre(
+            sae_in @ (self.W_enc * self.r_mag.exp()) + self.b_mag
+        )
+        feature_magnitudes = self.activation_fn(magnitude_pre_activation)
+
+        # Combine gating and magnitudes
+        return self.hook_sae_acts_post(active_features * feature_magnitudes)
+
+    def decode(
+        self, feature_acts: Float[torch.Tensor, "... d_sae"]
+    ) -> Float[torch.Tensor, "... d_in"]:
+        """
+        Decode the feature activations back into the input space:
+          1) Apply optional finetuning scaling.
+          2) Linear transform plus bias.
+          3) Run any reconstruction hooks and out-normalization if configured.
+          4) If the SAE was reshaping hook_z activations, reshape back.
+        """
+        # 1) optional finetuning scaling
+        # 2) linear transform
+        sae_out_pre = feature_acts @ self.W_dec + self.b_dec
+        # 3) hooking and normalization
+        sae_out_pre = self.hook_sae_recons(sae_out_pre)
+        sae_out_pre = self.run_time_activation_norm_fn_out(sae_out_pre)
+        # 4) reshape if needed (hook_z)
+        return self.reshape_fn_out(sae_out_pre, self.d_head)
+
+    @torch.no_grad()
+    def fold_W_dec_norm(self):
+        """Override to handle gated-specific parameters."""
+        W_dec_norms = self.W_dec.norm(dim=-1).unsqueeze(1)
+        self.W_dec.data = self.W_dec.data / W_dec_norms
+        self.W_enc.data = self.W_enc.data * W_dec_norms.T
+
+        # Gated-specific parameters need special handling
+        self.r_mag.data = self.r_mag.data * W_dec_norms.squeeze()
+        self.b_gate.data = self.b_gate.data * W_dec_norms.squeeze()
+        self.b_mag.data = self.b_mag.data * W_dec_norms.squeeze()
+
+    @torch.no_grad()
+    def initialize_decoder_norm_constant_norm(self, norm: float = 0.1):
+        """Initialize decoder with constant norm."""
+        self.W_dec.data /= torch.norm(self.W_dec.data, dim=1, keepdim=True)
+        self.W_dec.data *= norm
+
+
+@dataclass
+class GatedTrainingSAEConfig(TrainingSAEConfig):
+    """
+    Configuration class for training a GatedTrainingSAE.
+    """
+
+    l1_coefficient: float = 1.0
+    l1_warm_up_steps: int = 0
+
+    @override
+    @classmethod
+    def architecture(cls) -> str:
+        return "gated"
+
+
+class GatedTrainingSAE(TrainingSAE[GatedTrainingSAEConfig]):
+    """
+    GatedTrainingSAE is a concrete implementation of BaseTrainingSAE for the "gated" SAE architecture.
+    It implements:
+      - initialize_weights: sets up gating parameters (as in GatedSAE) plus optional training-specific init.
+      - encode: calls encode_with_hidden_pre (standard training approach).
+      - decode: linear transformation + hooking, same as GatedSAE or StandardTrainingSAE.
+      - encode_with_hidden_pre: gating logic + optional noise injection for training.
+      - calculate_aux_loss: includes an auxiliary reconstruction path and gating-based sparsity penalty.
+      - training_forward_pass: calls encode_with_hidden_pre, decode, and sums up MSE + gating losses.
+    """
+
+    b_gate: nn.Parameter  # type: ignore
+    b_mag: nn.Parameter  # type: ignore
+    r_mag: nn.Parameter  # type: ignore
+
+    def __init__(self, cfg: GatedTrainingSAEConfig, use_error_term: bool = False):
+        if use_error_term:
+            raise ValueError(
+                "GatedSAE does not support `use_error_term`. Please set `use_error_term=False`."
+            )
+        super().__init__(cfg, use_error_term)
+
+    def initialize_weights(self) -> None:
+        super().initialize_weights()
+        _init_weights_gated(self)
+
+    def encode_with_hidden_pre(
+        self, x: Float[torch.Tensor, "... d_in"]
+    ) -> tuple[Float[torch.Tensor, "... d_sae"], Float[torch.Tensor, "... d_sae"]]:
+        """
+        Gated forward pass with pre-activation (for training).
+        We also inject noise if self.training is True.
+        """
+        sae_in = self.process_sae_in(x)
+
+        # Gating path
+        gating_pre_activation = sae_in @ self.W_enc + self.b_gate
+        active_features = (gating_pre_activation > 0).to(self.dtype)
+
+        # Magnitude path
+        magnitude_pre_activation = sae_in @ (self.W_enc * self.r_mag.exp()) + self.b_mag
+        magnitude_pre_activation = self.hook_sae_acts_pre(magnitude_pre_activation)
+
+        feature_magnitudes = self.activation_fn(magnitude_pre_activation)
+
+        # Combine gating path and magnitude path
+        feature_acts = self.hook_sae_acts_post(active_features * feature_magnitudes)
+
+        # Return both the final feature activations and the pre-activation (for logging or penalty)
+        return feature_acts, magnitude_pre_activation
+
+    def calculate_aux_loss(
+        self,
+        step_input: TrainStepInput,
+        feature_acts: torch.Tensor,
+        hidden_pre: torch.Tensor,
+        sae_out: torch.Tensor,
+    ) -> dict[str, torch.Tensor]:
+        # Re-center the input if apply_b_dec_to_input is set
+        sae_in_centered = step_input.sae_in - (
+            self.b_dec * self.cfg.apply_b_dec_to_input
+        )
+
+        # The gating pre-activation (pi_gate) for the auxiliary path
+        pi_gate = sae_in_centered @ self.W_enc + self.b_gate
+        pi_gate_act = torch.relu(pi_gate)
+
+        # L1-like penalty scaled by W_dec norms
+        l1_loss = (
+            step_input.coefficients["l1"]
+            * torch.sum(pi_gate_act * self.W_dec.norm(dim=1), dim=-1).mean()
+        )
+
+        # Aux reconstruction: reconstruct x purely from gating path
+        via_gate_reconstruction = pi_gate_act @ self.W_dec + self.b_dec
+        aux_recon_loss = (
+            (via_gate_reconstruction - step_input.sae_in).pow(2).sum(dim=-1).mean()
+        )
+
+        # Return both losses separately
+        return {"l1_loss": l1_loss, "auxiliary_reconstruction_loss": aux_recon_loss}
+
+    def log_histograms(self) -> dict[str, NDArray[Any]]:
+        """Log histograms of the weights and biases."""
+        b_gate_dist = self.b_gate.detach().float().cpu().numpy()
+        b_mag_dist = self.b_mag.detach().float().cpu().numpy()
+        return {
+            **super().log_histograms(),
+            "weights/b_gate": b_gate_dist,
+            "weights/b_mag": b_mag_dist,
+        }
+
+    @torch.no_grad()
+    def initialize_decoder_norm_constant_norm(self, norm: float = 0.1):
+        """Initialize decoder with constant norm"""
+        self.W_dec.data /= torch.norm(self.W_dec.data, dim=1, keepdim=True)
+        self.W_dec.data *= norm
+
+    def get_coefficients(self) -> dict[str, float | TrainCoefficientConfig]:
+        return {
+            "l1": TrainCoefficientConfig(
+                value=self.cfg.l1_coefficient,
+                warm_up_steps=self.cfg.l1_warm_up_steps,
+            ),
+        }
+
+    def to_inference_config_dict(self) -> dict[str, Any]:
+        return filter_valid_dataclass_fields(
+            self.cfg.to_dict(), GatedSAEConfig, ["architecture"]
+        )
+
+
+def _init_weights_gated(
+    sae: SAE[GatedSAEConfig] | TrainingSAE[GatedTrainingSAEConfig],
+) -> None:
+    sae.b_gate = nn.Parameter(
+        torch.zeros(sae.cfg.d_sae, dtype=sae.dtype, device=sae.device)
+    )
+    # Ensure r_mag is initialized to zero as in original
+    sae.r_mag = nn.Parameter(
+        torch.zeros(sae.cfg.d_sae, dtype=sae.dtype, device=sae.device)
+    )
+    sae.b_mag = nn.Parameter(
+        torch.zeros(sae.cfg.d_sae, dtype=sae.dtype, device=sae.device)
+    )

sae_lens/saes/jumprelu_sae.py

@@ -0,0 +1,348 @@
+from dataclasses import dataclass
+from typing import Any
+
+import numpy as np
+import torch
+from jaxtyping import Float
+from torch import nn
+from typing_extensions import override
+
+from sae_lens.saes.sae import (
+    SAE,
+    SAEConfig,
+    TrainCoefficientConfig,
+    TrainingSAE,
+    TrainingSAEConfig,
+    TrainStepInput,
+    TrainStepOutput,
+)
+from sae_lens.util import filter_valid_dataclass_fields
+
+
+def rectangle(x: torch.Tensor) -> torch.Tensor:
+    return ((x > -0.5) & (x < 0.5)).to(x)
+
+
+class Step(torch.autograd.Function):
+    @staticmethod
+    def forward(
+        x: torch.Tensor,
+        threshold: torch.Tensor,
+        bandwidth: float,  # noqa: ARG004
+    ) -> torch.Tensor:
+        return (x > threshold).to(x)
+
+    @staticmethod
+    def setup_context(
+        ctx: Any, inputs: tuple[torch.Tensor, torch.Tensor, float], output: torch.Tensor
+    ) -> None:
+        x, threshold, bandwidth = inputs
+        del output
+        ctx.save_for_backward(x, threshold)
+        ctx.bandwidth = bandwidth
+
+    @staticmethod
+    def backward(  # type: ignore[override]
+        ctx: Any, grad_output: torch.Tensor
+    ) -> tuple[None, torch.Tensor, None]:
+        x, threshold = ctx.saved_tensors
+        bandwidth = ctx.bandwidth
+        threshold_grad = torch.sum(
+            -(1.0 / bandwidth) * rectangle((x - threshold) / bandwidth) * grad_output,
+            dim=0,
+        )
+        return None, threshold_grad, None
+
+
+class JumpReLU(torch.autograd.Function):
+    @staticmethod
+    def forward(
+        x: torch.Tensor,
+        threshold: torch.Tensor,
+        bandwidth: float,  # noqa: ARG004
+    ) -> torch.Tensor:
+        return (x * (x > threshold)).to(x)
+
+    @staticmethod
+    def setup_context(
+        ctx: Any, inputs: tuple[torch.Tensor, torch.Tensor, float], output: torch.Tensor
+    ) -> None:
+        x, threshold, bandwidth = inputs
+        del output
+        ctx.save_for_backward(x, threshold)
+        ctx.bandwidth = bandwidth
+
+    @staticmethod
+    def backward(  # type: ignore[override]
+        ctx: Any, grad_output: torch.Tensor
+    ) -> tuple[torch.Tensor, torch.Tensor, None]:
+        x, threshold = ctx.saved_tensors
+        bandwidth = ctx.bandwidth
+        x_grad = (x > threshold) * grad_output  # We don't apply STE to x input
+        threshold_grad = torch.sum(
+            -(threshold / bandwidth)
+            * rectangle((x - threshold) / bandwidth)
+            * grad_output,
+            dim=0,
+        )
+        return x_grad, threshold_grad, None
+
+
+@dataclass
+class JumpReLUSAEConfig(SAEConfig):
+    """
+    Configuration class for a JumpReLUSAE.
+    """
+
+    @override
+    @classmethod
+    def architecture(cls) -> str:
+        return "jumprelu"
+
+
+class JumpReLUSAE(SAE[JumpReLUSAEConfig]):
+    """
+    JumpReLUSAE is an inference-only implementation of a Sparse Autoencoder (SAE)
+    using a JumpReLU activation. For each unit, if its pre-activation is
+    <= threshold, that unit is zeroed out; otherwise, it follows a user-specified
+    activation function (e.g., ReLU etc.).
+
+    It implements:
+      - initialize_weights: sets up parameters, including a threshold.
+      - encode: computes the feature activations using JumpReLU.
+      - decode: reconstructs the input from the feature activations.
+
+    The BaseSAE.forward() method automatically calls encode and decode,
+    including any error-term processing if configured.
+    """
+
+    b_enc: nn.Parameter
+    threshold: nn.Parameter
+
+    def __init__(self, cfg: JumpReLUSAEConfig, use_error_term: bool = False):
+        super().__init__(cfg, use_error_term)
+
+    @override
+    def initialize_weights(self) -> None:
+        super().initialize_weights()
+        self.threshold = nn.Parameter(
+            torch.zeros(self.cfg.d_sae, dtype=self.dtype, device=self.device)
+        )
+        self.b_enc = nn.Parameter(
+            torch.zeros(self.cfg.d_sae, dtype=self.dtype, device=self.device)
+        )
+
+    def encode(
+        self, x: Float[torch.Tensor, "... d_in"]
+    ) -> Float[torch.Tensor, "... d_sae"]:
+        """
+        Encode the input tensor into the feature space using JumpReLU.
+        The threshold parameter determines which units remain active.
+        """
+        sae_in = self.process_sae_in(x)
+        hidden_pre = self.hook_sae_acts_pre(sae_in @ self.W_enc + self.b_enc)
+
+        # 1) Apply the base "activation_fn" from config (e.g., ReLU).
+        base_acts = self.activation_fn(hidden_pre)
+
+        # 2) Zero out any unit whose (hidden_pre <= threshold).
+        #    We cast the boolean mask to the same dtype for safe multiplication.
+        jump_relu_mask = (hidden_pre > self.threshold).to(base_acts.dtype)
+
+        # 3) Multiply the normally activated units by that mask.
+        return self.hook_sae_acts_post(base_acts * jump_relu_mask)
+
+    def decode(
+        self, feature_acts: Float[torch.Tensor, "... d_sae"]
+    ) -> Float[torch.Tensor, "... d_in"]:
+        """
+        Decode the feature activations back to the input space.
+        Follows the same steps as StandardSAE: apply scaling, transform, hook, and optionally reshape.
+        """
+        sae_out_pre = feature_acts @ self.W_dec + self.b_dec
+        sae_out_pre = self.hook_sae_recons(sae_out_pre)
+        sae_out_pre = self.run_time_activation_norm_fn_out(sae_out_pre)
+        return self.reshape_fn_out(sae_out_pre, self.d_head)
+
+    @torch.no_grad()
+    def fold_W_dec_norm(self):
+        """
+        Override to properly handle threshold adjustment with W_dec norms.
+        When we scale the encoder weights, we need to scale the threshold
+        by the same factor to maintain the same sparsity pattern.
+        """
+        # Save the current threshold before calling parent method
+        current_thresh = self.threshold.clone()
+
+        # Get W_dec norms that will be used for scaling
+        W_dec_norms = self.W_dec.norm(dim=-1)
+
+        # Call parent implementation to handle W_enc, W_dec, and b_enc adjustment
+        super().fold_W_dec_norm()
+
+        # Scale the threshold by the same factor as we scaled b_enc
+        # This ensures the same features remain active/inactive after folding
+        self.threshold.data = current_thresh * W_dec_norms
+
+
+@dataclass
+class JumpReLUTrainingSAEConfig(TrainingSAEConfig):
+    """
+    Configuration class for training a JumpReLUTrainingSAE.
+    """
+
+    jumprelu_init_threshold: float = 0.01
+    jumprelu_bandwidth: float = 0.05
+    l0_coefficient: float = 1.0
+    l0_warm_up_steps: int = 0
+
+    @override
+    @classmethod
+    def architecture(cls) -> str:
+        return "jumprelu"
+
+
+class JumpReLUTrainingSAE(TrainingSAE[JumpReLUTrainingSAEConfig]):
+    """
+    JumpReLUTrainingSAE is a training-focused implementation of a SAE using a JumpReLU activation.
+
+    Similar to the inference-only JumpReLUSAE, but with:
+      - A learnable log-threshold parameter (instead of a raw threshold).
+      - Forward passes that add noise during training, if configured.
+      - A specialized auxiliary loss term for sparsity (L0 or similar).
+
+    Methods of interest include:
+    - initialize_weights: sets up W_enc, b_enc, W_dec, b_dec, and log_threshold.
+    - encode_with_hidden_pre_jumprelu: runs a forward pass for training, optionally adding noise.
+    - training_forward_pass: calculates MSE and auxiliary losses, returning a TrainStepOutput.
+    """
+
+    b_enc: nn.Parameter
+    log_threshold: nn.Parameter
+
+    def __init__(self, cfg: JumpReLUTrainingSAEConfig, use_error_term: bool = False):
+        super().__init__(cfg, use_error_term)
+
+        # We'll store a bandwidth for the training approach, if needed
+        self.bandwidth = cfg.jumprelu_bandwidth
+
+        # In typical JumpReLU training code, we may track a log_threshold:
+        self.log_threshold = nn.Parameter(
+            torch.ones(self.cfg.d_sae, dtype=self.dtype, device=self.device)
+            * np.log(cfg.jumprelu_init_threshold)
+        )
+
+    @override
+    def initialize_weights(self) -> None:
+        """
+        Initialize parameters like the base SAE, but also add log_threshold.
+        """
+        super().initialize_weights()
+        # Encoder Bias
+        self.b_enc = nn.Parameter(
+            torch.zeros(self.cfg.d_sae, dtype=self.dtype, device=self.device)
+        )
+
+    @property
+    def threshold(self) -> torch.Tensor:
+        """
+        Returns the parameterized threshold > 0 for each unit.
+        threshold = exp(log_threshold).
+        """
+        return torch.exp(self.log_threshold)
+
+    def encode_with_hidden_pre(
+        self, x: Float[torch.Tensor, "... d_in"]
+    ) -> tuple[Float[torch.Tensor, "... d_sae"], Float[torch.Tensor, "... d_sae"]]:
+        sae_in = self.process_sae_in(x)
+
+        hidden_pre = sae_in @ self.W_enc + self.b_enc
+        feature_acts = JumpReLU.apply(hidden_pre, self.threshold, self.bandwidth)
+
+        return feature_acts, hidden_pre  # type: ignore
+
+    @override
+    def calculate_aux_loss(
+        self,
+        step_input: TrainStepInput,
+        feature_acts: torch.Tensor,
+        hidden_pre: torch.Tensor,
+        sae_out: torch.Tensor,
+    ) -> dict[str, torch.Tensor]:
+        """Calculate architecture-specific auxiliary loss terms."""
+        l0 = torch.sum(Step.apply(hidden_pre, self.threshold, self.bandwidth), dim=-1)  # type: ignore
+        l0_loss = (step_input.coefficients["l0"] * l0).mean()
+        return {"l0_loss": l0_loss}
+
+    @override
+    def get_coefficients(self) -> dict[str, float | TrainCoefficientConfig]:
+        return {
+            "l0": TrainCoefficientConfig(
+                value=self.cfg.l0_coefficient,
+                warm_up_steps=self.cfg.l0_warm_up_steps,
+            ),
+        }
+
+    @torch.no_grad()
+    def fold_W_dec_norm(self):
+        """
+        Override to properly handle threshold adjustment with W_dec norms.
+        """
+        # Save the current threshold before we call the parent method
+        current_thresh = self.threshold.clone()
+
+        # Get W_dec norms
+        W_dec_norms = self.W_dec.norm(dim=-1).unsqueeze(1)
+
+        # Call parent implementation to handle W_enc and W_dec adjustment
+        super().fold_W_dec_norm()
+
+        # Fix: Use squeeze() instead of squeeze(-1) to match old behavior
+        self.log_threshold.data = torch.log(current_thresh * W_dec_norms.squeeze())
+
+    def _create_train_step_output(
+        self,
+        sae_in: torch.Tensor,
+        sae_out: torch.Tensor,
+        feature_acts: torch.Tensor,
+        hidden_pre: torch.Tensor,
+        loss: torch.Tensor,
+        losses: dict[str, torch.Tensor],
+    ) -> TrainStepOutput:
+        """
+        Helper to produce a TrainStepOutput from the trainer.
+        The old code expects a method named _create_train_step_output().
+        """
+        return TrainStepOutput(
+            sae_in=sae_in,
+            sae_out=sae_out,
+            feature_acts=feature_acts,
+            hidden_pre=hidden_pre,
+            loss=loss,
+            losses=losses,
+        )
+
+    @torch.no_grad()
+    def initialize_decoder_norm_constant_norm(self, norm: float = 0.1):
+        """Initialize decoder with constant norm"""
+        self.W_dec.data /= torch.norm(self.W_dec.data, dim=1, keepdim=True)
+        self.W_dec.data *= norm
+
+    def process_state_dict_for_saving(self, state_dict: dict[str, Any]) -> None:
+        """Convert log_threshold to threshold for saving"""
+        if "log_threshold" in state_dict:
+            threshold = torch.exp(state_dict["log_threshold"]).detach().contiguous()
+            del state_dict["log_threshold"]
+            state_dict["threshold"] = threshold
+
+    def process_state_dict_for_loading(self, state_dict: dict[str, Any]) -> None:
+        """Convert threshold to log_threshold for loading"""
+        if "threshold" in state_dict:
+            threshold = state_dict["threshold"]
+            del state_dict["threshold"]
+            state_dict["log_threshold"] = torch.log(threshold).detach().contiguous()
+
+    def to_inference_config_dict(self) -> dict[str, Any]:
+        return filter_valid_dataclass_fields(
+            self.cfg.to_dict(), JumpReLUSAEConfig, ["architecture"]
+        )