| |
|
|
| from __future__ import annotations |
|
|
| import warnings |
| from typing import TYPE_CHECKING |
|
|
| import torch |
| import torch.nn as nn |
| from transformers.utils import logging |
|
|
| from fla.modules.activations import ACT2FN |
| from fla.modules.layernorm_gated import RMSNormGated |
|
|
| with warnings.catch_warnings(): |
| warnings.simplefilter('ignore') |
| try: |
| from mamba_ssm.ops.triton.selective_state_update import selective_state_update |
| from mamba_ssm.ops.triton.ssd_combined import mamba_chunk_scan_combined, mamba_split_conv1d_scan_combined |
| except ImportError: |
| selective_state_update, mamba_chunk_scan_combined, mamba_split_conv1d_scan_combined = None, None, None |
| try: |
| from causal_conv1d import causal_conv1d_fn, causal_conv1d_update |
| except ImportError: |
| causal_conv1d_update, causal_conv1d_fn = None, None |
| is_fast_path_available = selective_state_update is not None |
|
|
| if TYPE_CHECKING: |
| from fla.models.mamba2.modeling_mamba2 import Mamba2Cache |
|
|
| logger = logging.get_logger(__name__) |
|
|
|
|
| def apply_mask_to_padding_states(hidden_states, attention_mask): |
| """ |
| Tunes out the hidden states for padding tokens, see https://github.com/state-spaces/mamba/issues/66 |
| """ |
| if attention_mask is not None and attention_mask.shape[1] > 1 and attention_mask.shape[0] > 1: |
| dtype = hidden_states.dtype |
| hidden_states = (hidden_states * attention_mask[:, :, None]).to(dtype) |
|
|
| return hidden_states |
|
|
|
|
| def pad_tensor_by_size(input_tensor: torch.Tensor, pad_size: int): |
| """ |
| Padding x tensor with `pad_size` on the seq_len dim (dim=1) |
| |
| Assumes that we only have tensors of either size 4 or 3 |
| """ |
| pad_shape = (0, 0, 0, 0, 0, pad_size, 0, 0) if len(input_tensor.shape) == 4 else (0, 0, 0, pad_size, 0, 0) |
|
|
| return torch.nn.functional.pad(input_tensor, pad_shape, mode="constant", value=0) |
|
|
|
|
| def reshape_into_chunks(input_tensor, pad_size, chunk_size): |
| """ |
| Padding input_tensor with `pad_size` on the seq_len dim (dim=1) and |
| simultaneously splitting it into chunk sequences. |
| |
| Assumes that we only have tensors of either size 4 or 3 |
| """ |
| |
| input_tensor = pad_tensor_by_size(input_tensor, pad_size) |
|
|
| if len(input_tensor.shape) == 3: |
| |
| return input_tensor.reshape(input_tensor.shape[0], -1, chunk_size, input_tensor.shape[2]) |
| else: |
| |
| |
| return input_tensor.reshape( |
| input_tensor.shape[0], -1, chunk_size, input_tensor.shape[2], input_tensor.shape[3], |
| ) |
|
|
|
|
| def segment_sum(input_tensor): |
| """ |
| More stable segment sum calculation. Uses cumulative sums and masking instead of direct subtractions. |
| """ |
| chunk_size = input_tensor.size(-1) |
| |
| |
| input_tensor = input_tensor[..., None].expand(*input_tensor.size(), chunk_size) |
| |
| mask = torch.tril(torch.ones(chunk_size, chunk_size, device=input_tensor.device, dtype=torch.bool), diagonal=-1) |
| input_tensor = input_tensor.masked_fill(~mask, 0) |
| |
| tensor_segsum = torch.cumsum(input_tensor, dim=-2) |
|
|
| |
| mask = torch.tril(torch.ones(chunk_size, chunk_size, device=input_tensor.device, dtype=torch.bool), diagonal=0) |
| tensor_segsum = tensor_segsum.masked_fill(~mask, -torch.inf) |
| return tensor_segsum |
|
|
|
|
| class Mamba2(nn.Module): |
| """ |
| Compute ∆, A, B, C, and D the state space parameters and compute the `contextualized_states`. |
| A, D are input independent (see Mamba paper [1] Section 3.5.2 "Interpretation of A" for why A isn't selective) |
| ∆, B, C are input-dependent (this is a key difference between Mamba and the linear time invariant S4, |
| and is why Mamba is called **selective** state spaces) |
| """ |
|
|
| def __init__( |
| self, |
| num_heads: int, |
| head_dim: int = 64, |
| hidden_size: int = 2048, |
| state_size: int = 128, |
| expand: int = 2, |
| n_groups: int = 1, |
| conv_kernel: int = 4, |
| use_conv_bias: bool = False, |
| hidden_act: str = "silu", |
| rms_norm: bool = True, |
| chunk_size: int = 256, |
| time_step_rank: float = 256, |
| time_step_limit: tuple[float, float] = (0.0, float("inf")), |
| time_step_min: float = 0.001, |
| time_step_max: float = 0.1, |
| use_bias: bool = True, |
| norm_eps: float = 1e-5, |
| layer_idx: int = None, |
| backend: str = "cuda", |
| ) -> Mamba2: |
| super().__init__() |
|
|
| self.num_heads = num_heads |
| self.head_dim = head_dim |
| self.hidden_size = hidden_size |
| self.ssm_state_size = state_size |
| self.expand = expand |
| self.intermediate_size = int(expand * hidden_size) |
| self.n_groups = n_groups |
|
|
| self.conv_kernel_size = conv_kernel |
| self.use_conv_bias = use_conv_bias |
| self.activation = hidden_act |
| self.act = ACT2FN[hidden_act] |
|
|
| self.rms_norm = rms_norm |
| self.norm_eps = norm_eps |
|
|
| self.chunk_size = chunk_size |
|
|
| self.time_step_rank = int(time_step_rank) |
| self.time_step_limit = time_step_limit |
| self.time_step_min = time_step_min |
| self.time_step_max = time_step_max |
|
|
| self.conv_dim = self.intermediate_size + 2 * self.n_groups * self.ssm_state_size |
| self.conv1d = nn.Conv1d( |
| in_channels=self.conv_dim, |
| out_channels=self.conv_dim, |
| bias=use_conv_bias, |
| kernel_size=conv_kernel, |
| groups=self.conv_dim, |
| padding=conv_kernel - 1, |
| ) |
|
|
| |
| projection_size = self.intermediate_size + self.conv_dim + self.num_heads |
| self.in_proj = nn.Linear( |
| self.hidden_size, |
| projection_size, |
| bias=use_bias, |
| ) |
| |
|
|
| |
| |
| self.dt_bias = nn.Parameter(torch.ones(self.num_heads)) |
|
|
| |
| |
| A = torch.arange(1, self.num_heads + 1) |
| self.A_log = nn.Parameter(torch.log(A)) |
| self.A_log._no_weight_decay = True |
| self.norm = RMSNormGated( |
| self.intermediate_size, eps=self.norm_eps, norm_before_gate=False, |
| ) |
| self.D = nn.Parameter(torch.ones(self.num_heads)) |
| self.D._no_weight_decay = True |
|
|
| self.out_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=use_bias) |
| self.use_bias = use_bias |
|
|
| self.layer_idx = layer_idx |
|
|
| if not is_fast_path_available: |
| logger.warning_once( |
| "The fast path is not available because one of " |
| "`(selective_state_update)` is None. " |
| "Falling back to the naive implementation. " |
| "To install follow https://github.com/state-spaces/mamba/#installation", |
| ) |
| import os |
| backend = os.environ.get('FLA_CONV_BACKEND', backend) |
| assert backend in ['cuda', 'triton'], f"Unsupported backend: {backend}" |
| if backend == 'cuda' and causal_conv1d_fn is None: |
| logger.warning_once( |
| "The CUDA backend is not available because `causal_conv1d` is None. " |
| "Falling back to the Triton backend. " |
| "To install follow https://github.com/Dao-AILab/causal-conv1d", |
| ) |
| backend = 'triton' |
| if backend == 'triton': |
| from fla.modules.convolution import causal_conv1d as causal_conv1d_triton |
| from fla.modules.convolution import causal_conv1d_update as causal_conv1d_update_triton |
| self.causal_conv1d_fn = causal_conv1d_triton |
| self.causal_conv1d_update = causal_conv1d_update_triton |
| logger.warning( |
| "Mamba2 does not recommend using Triton's conv1d backend, " |
| "as it is untested and may contain bugs.", |
| ) |
| else: |
| self.causal_conv1d_fn = causal_conv1d_fn |
| self.causal_conv1d_update = causal_conv1d_update |
| self.backend = backend |
|
|
| def cuda_kernels_forward( |
| self, |
| hidden_states: torch.Tensor, |
| cache_params: Mamba2Cache | None = None, |
| cache_position: torch.LongTensor | None = None, |
| attention_mask: torch.Tensor | None = None, |
| ): |
| |
| hidden_states = apply_mask_to_padding_states(hidden_states, attention_mask) |
| projected_states = self.in_proj(hidden_states) |
|
|
| |
| batch_size, seq_len, _ = hidden_states.shape |
| groups_time_state_size = self.n_groups * self.ssm_state_size |
| d_mlp = ( |
| projected_states.shape[-1] |
| - 2 * self.intermediate_size |
| - 2 * self.n_groups * self.ssm_state_size |
| - self.num_heads |
| ) // 2 |
|
|
| |
| if cache_params is not None and cache_position is not None and cache_position[0] > 0: |
| _, _, gate, hidden_states_B_C, dt = projected_states.squeeze(1).split( |
| [d_mlp, d_mlp, self.intermediate_size, self.conv_dim, self.num_heads], dim=-1, |
| ) |
|
|
| |
| hidden_states_B_C = self.causal_conv1d_update( |
| hidden_states_B_C.contiguous(), |
| cache_params.conv_states[self.layer_idx], |
| self.conv1d.weight.squeeze(1), |
| self.conv1d.bias, |
| self.activation, |
| ) |
|
|
| hidden_states, B, C = torch.split( |
| hidden_states_B_C, |
| [ |
| self.intermediate_size, |
| groups_time_state_size, |
| groups_time_state_size, |
| ], |
| dim=-1, |
| ) |
|
|
| |
| A = -torch.exp(self.A_log.float()) |
| A = A[:, None, ...][:, :, None].expand(-1, self.head_dim, self.ssm_state_size).to(dtype=torch.float32) |
| dt = dt[:, :, None].expand(-1, -1, self.head_dim) |
| dt_bias = self.dt_bias[:, None, ...].expand(-1, self.head_dim) |
| D = self.D[:, None, ...].expand(-1, self.head_dim) |
| B = B.view(batch_size, self.n_groups, B.shape[1] // self.n_groups) |
| C = C.view(batch_size, self.n_groups, C.shape[1] // self.n_groups) |
| hidden_states_reshaped = hidden_states.view(batch_size, self.num_heads, self.head_dim) |
|
|
| hidden_states = selective_state_update( |
| cache_params.ssm_states[self.layer_idx], |
| hidden_states_reshaped, |
| dt, |
| A, |
| B, |
| C, |
| D, |
| z=None, |
| dt_bias=dt_bias, |
| dt_softplus=True, |
| ) |
| hidden_states = hidden_states.view(batch_size, self.num_heads * self.head_dim) |
| hidden_states = self.norm(hidden_states, gate) |
|
|
| |
| out = self.out_proj(hidden_states)[:, None, ...] |
|
|
| |
| else: |
| A = -torch.exp(self.A_log.float()) |
| dt_limit_kwargs = {} if self.time_step_limit == (0.0, float("inf")) else {"dt_limit": self.time_step_limit} |
|
|
| |
| if self.training and cache_params is None: |
| out = mamba_split_conv1d_scan_combined( |
| projected_states, |
| self.conv1d.weight.squeeze(1), |
| self.conv1d.bias, |
| self.dt_bias, |
| A, |
| D=self.D, |
| chunk_size=self.chunk_size, |
| seq_idx=None, |
| activation=self.activation, |
| rmsnorm_weight=self.norm.weight, |
| rmsnorm_eps=self.norm.eps, |
| outproj_weight=self.out_proj.weight, |
| outproj_bias=self.out_proj.bias, |
| headdim=self.head_dim, |
| ngroups=self.n_groups, |
| norm_before_gate=False, |
| return_final_states=False, |
| **dt_limit_kwargs, |
| ) |
|
|
| else: |
| _, _, gate, hidden_states_B_C, dt = projected_states.split( |
| [d_mlp, d_mlp, self.intermediate_size, self.conv_dim, self.num_heads], dim=-1, |
| ) |
|
|
| |
| |
| if cache_params is not None: |
| hidden_states_B_C_transposed = hidden_states_B_C.transpose(1, 2) |
| conv_states = nn.functional.pad( |
| hidden_states_B_C_transposed, |
| (cache_params.conv_kernel_size - hidden_states_B_C_transposed.shape[-1], 0), |
| ) |
| cache_params.update_conv_state( |
| layer_idx=self.layer_idx, new_conv_state=conv_states, cache_init=True, |
| ) |
|
|
| if self.activation not in ["silu", "swish"]: |
| hidden_states_B_C = self.act( |
| self.conv1d(hidden_states_B_C.transpose(1, 2))[..., :seq_len].transpose(1, 2), |
| ) |
| else: |
| _conv1d_output = self.causal_conv1d_fn( |
| x=hidden_states_B_C.transpose(1, 2).contiguous(), |
| weight=self.conv1d.weight.squeeze(1), |
| bias=self.conv1d.bias, |
| activation=self.activation, |
| ) |
| if self.backend == 'cuda': |
| hidden_states_B_C = _conv1d_output |
| hidden_states_B_C = hidden_states_B_C.transpose(1, 2) |
| elif self.backend == 'triton': |
| hidden_states_B_C, _ = _conv1d_output |
| hidden_states_B_C = hidden_states_B_C.transpose(1, 2).contiguous() |
| else: |
| raise ValueError(f"Unsupported backend: {self.backend}") |
|
|
| hidden_states_B_C = apply_mask_to_padding_states(hidden_states_B_C, attention_mask) |
| hidden_states, B, C = torch.split( |
| hidden_states_B_C, |
| [self.intermediate_size, groups_time_state_size, groups_time_state_size], |
| dim=-1, |
| ) |
|
|
| |
| scan_output, ssm_state = mamba_chunk_scan_combined( |
| hidden_states.view(batch_size, seq_len, -1, self.head_dim), |
| dt, |
| A, |
| B.view(batch_size, seq_len, self.n_groups, -1), |
| C.view(batch_size, seq_len, self.n_groups, -1), |
| chunk_size=self.chunk_size, |
| D=self.D, |
| z=None, |
| seq_idx=None, |
| return_final_states=True, |
| dt_bias=self.dt_bias, |
| dt_softplus=True, |
| **dt_limit_kwargs, |
| ) |
|
|
| |
| if ssm_state is not None and cache_params is not None: |
| cache_params.update_ssm_state(layer_idx=self.layer_idx, new_ssm_state=ssm_state) |
|
|
| scan_output = scan_output.view(batch_size, seq_len, -1) |
| |
| scan_output = self.norm(scan_output, gate) |
|
|
| |
| out = self.out_proj(scan_output) |
| return out |
|
|
| |
| def torch_forward( |
| self, |
| input_states, |
| cache_params: Mamba2Cache | None = None, |
| cache_position: torch.LongTensor | None = None, |
| attention_mask: torch.Tensor | None = None, |
| ): |
| batch_size, seq_len, _ = input_states.shape |
| dtype = input_states.dtype |
|
|
| |
| input_states = apply_mask_to_padding_states(input_states, attention_mask) |
| projected_states = self.in_proj(input_states) |
| d_mlp = (projected_states.shape[-1] - 2 * self.intermediate_size - |
| 2 * self.n_groups * self.ssm_state_size - self.num_heads) // 2 |
| _, _, gate, hidden_states_B_C, dt = projected_states.split( |
| [d_mlp, d_mlp, self.intermediate_size, self.conv_dim, self.num_heads], dim=-1, |
| ) |
|
|
| |
| if cache_params is not None and cache_position is not None and cache_position[0] > 0: |
| cache_params.update_conv_state(layer_idx=self.layer_idx, new_conv_state=hidden_states_B_C, cache_init=False) |
|
|
| |
| conv_states = cache_params.conv_states[self.layer_idx].to(device=self.conv1d.weight.device) |
|
|
| hidden_states_B_C = torch.sum( |
| conv_states * self.conv1d.weight.squeeze(1), dim=-1, |
| ) |
| if self.use_conv_bias: |
| hidden_states_B_C = hidden_states_B_C + self.conv1d.bias |
| hidden_states_B_C = self.act(hidden_states_B_C) |
| else: |
| |
| if cache_params is not None: |
| hidden_states_B_C_transposed = hidden_states_B_C.transpose(1, 2) |
| conv_states = nn.functional.pad( |
| hidden_states_B_C_transposed, (cache_params.conv_kernel_size - hidden_states_B_C_transposed.shape[-1], 0), |
| ) |
| cache_params.update_conv_state(layer_idx=self.layer_idx, new_conv_state=conv_states, cache_init=True) |
|
|
| hidden_states_B_C = self.act(self.conv1d(hidden_states_B_C.transpose(1, 2))[..., :seq_len].transpose(1, 2)) |
|
|
| hidden_states_B_C = apply_mask_to_padding_states(hidden_states_B_C, attention_mask) |
| hidden_states, B, C = torch.split( |
| hidden_states_B_C, |
| [self.intermediate_size, self.n_groups * self.ssm_state_size, self.n_groups * self.ssm_state_size], |
| dim=-1, |
| ) |
|
|
| |
| A = -torch.exp(self.A_log.float()) |
| if cache_params is not None and cache_position is not None and cache_position[0] > 0: |
| |
| cache_device = cache_params.ssm_states.device |
|
|
| |
| |
| dt = dt[:, 0, :][:, None, ...] |
| dt = dt.transpose(1, 2).expand(batch_size, dt.shape[-1], self.head_dim) |
| |
| dt_bias = self.dt_bias[..., None].expand(self.dt_bias.shape[0], self.head_dim) |
|
|
| dt = torch.nn.functional.softplus(dt + dt_bias.to(dt.dtype)) |
| dt = torch.clamp(dt, self.time_step_limit[0], self.time_step_limit[1]) |
| A = A[..., None, None].expand(self.num_heads, self.head_dim, self.ssm_state_size).to(dtype=torch.float32) |
| |
| dA = (torch.exp(dt[..., None] * A)).to(device=cache_device) |
|
|
| |
| |
| |
| B = B.reshape(batch_size, self.n_groups, -1)[..., None, :] |
| B = B.expand(batch_size, self.n_groups, self.num_heads // self.n_groups, B.shape[-1]).contiguous() |
| B = B.reshape(batch_size, -1, B.shape[-1]) |
| |
| dB = dt[..., None] * B[..., None, :] |
|
|
| |
| |
| hidden_states = hidden_states.reshape(batch_size, -1, self.head_dim) |
| dBx = (dB * hidden_states[..., None]).to(device=cache_device) |
|
|
| |
| cache_params.update_ssm_state( |
| layer_idx=self.layer_idx, |
| new_ssm_state=cache_params.ssm_states[self.layer_idx] * dA + dBx, |
| ) |
|
|
| |
| |
| C = C.reshape(batch_size, self.n_groups, -1)[..., None, :] |
| C = C.expand(batch_size, self.n_groups, self.num_heads // self.n_groups, C.shape[-1]).contiguous() |
| C = C.reshape(batch_size, -1, C.shape[-1]) |
| |
|
|
| ssm_states = cache_params.ssm_states[self.layer_idx].to(device=C.device, dtype=C.dtype) |
| |
| |
| ssm_states_reshaped = ssm_states.view(batch_size * self.num_heads, self.head_dim, self.ssm_state_size) |
| C_reshaped = C.view(batch_size * self.num_heads, self.ssm_state_size, 1) |
| y = torch.bmm(ssm_states_reshaped, C_reshaped) |
| y = y.view(batch_size, self.num_heads, self.head_dim) |
|
|
| |
| |
| D = self.D[..., None].expand(self.D.shape[0], self.head_dim) |
| y = (y + hidden_states * D).to(y.dtype) |
|
|
| |
| y = y.reshape(batch_size, -1)[:, None, ...] |
| else: |
| |
| dt = nn.functional.softplus(dt + self.dt_bias) |
| dt = torch.clamp(dt, self.time_step_limit[0], self.time_step_limit[1]) |
| hidden_states = hidden_states.reshape(batch_size, seq_len, -1, self.head_dim).float() |
| B = B.reshape(batch_size, seq_len, -1, self.ssm_state_size).float() |
| C = C.reshape(batch_size, seq_len, -1, self.ssm_state_size).float() |
| B = B.repeat(1, 1, self.num_heads // self.n_groups, 1) |
| C = C.repeat(1, 1, self.num_heads // self.n_groups, 1) |
| pad_size = (self.chunk_size - seq_len % self.chunk_size) % self.chunk_size |
|
|
| D_residual = self.D[..., None] * pad_tensor_by_size(hidden_states, pad_size) |
|
|
| |
| hidden_states = hidden_states * dt[..., None] |
| A = A.to(hidden_states.dtype) * dt |
|
|
| |
| hidden_states, A, B, C = [reshape_into_chunks(t, pad_size, self.chunk_size) for t in (hidden_states, A, B, C)] |
|
|
| |
| A = A.permute(0, 3, 1, 2) |
| A_cumsum = torch.cumsum(A, dim=-1) |
|
|
| |
| |
| L = torch.exp(segment_sum(A)) |
|
|
| |
| |
| G_intermediate = C[:, :, :, None, :, :] * B[:, :, None, :, :, :] |
| G = G_intermediate.sum(dim=-1) |
|
|
| |
| M_intermediate = G[..., None] * L.permute(0, 2, 3, 4, 1)[..., None] |
| M = M_intermediate.sum(dim=-1) |
|
|
| |
| Y_diag = (M[..., None] * hidden_states[:, :, None]).sum(dim=3) |
|
|
| |
| |
| decay_states = torch.exp(A_cumsum[:, :, :, -1:] - A_cumsum) |
| B_decay = B * decay_states.permute(0, -2, -1, 1)[..., None] |
| states = (B_decay[..., None, :] * hidden_states[..., None]).sum(dim=2) |
|
|
| |
| |
| if cache_params is not None and cache_position is not None and cache_position[0] > 0: |
| previous_states = cache_params.ssm_states[self.layer_idx][:, None, ...].to(device=states.device) |
| else: |
| previous_states = torch.zeros_like(states[:, :1]) |
| states = torch.cat([previous_states, states], dim=1) |
| decay_chunk = torch.exp(segment_sum(nn.functional.pad(A_cumsum[:, :, :, -1], (1, 0)))) |
| decay_chunk = decay_chunk.transpose(1, 3) |
| new_states = (decay_chunk[..., None, None] * states[:, :, None, ...]).sum(dim=1) |
| states, ssm_state = new_states[:, :-1], new_states[:, -1] |
|
|
| |
| |
| state_decay_out = torch.exp(A_cumsum) |
| C_times_states = (C[..., None, :] * states[:, :, None, ...]) |
| state_decay_out_permuted = state_decay_out.permute(0, 2, 3, 1) |
| Y_off = (C_times_states.sum(-1) * state_decay_out_permuted[..., None]) |
|
|
| |
| y = Y_diag + Y_off |
| |
| y = y.reshape(batch_size, -1, self.num_heads, self.head_dim) |
|
|
| y = y + D_residual |
| |
| if pad_size > 0: |
| y = y[:, :seq_len, :, :] |
| y = y.reshape(batch_size, seq_len, -1) |
|
|
| |
| if ssm_state is not None and cache_params is not None: |
| cache_params.update_ssm_state(layer_idx=self.layer_idx, new_ssm_state=ssm_state) |
|
|
| scan_output = self.norm(y, gate) |
|
|
| |
|
|
| |
| contextualized_states = self.out_proj(scan_output.to(dtype)) |
| return contextualized_states |
| |
|
|
| def forward( |
| self, |
| hidden_states, |
| cache_params: Mamba2Cache | None = None, |
| cache_position: torch.LongTensor | None = None, |
| attention_mask: torch.Tensor | None = None, |
| ): |
| if is_fast_path_available and "cuda" in self.in_proj.weight.device.type: |
| return self.cuda_kernels_forward(hidden_states, cache_params, cache_position, attention_mask) |
| dtype = hidden_states.dtype |
| if attention_mask is not None and attention_mask.shape[1] > 1 and attention_mask.shape[0] > 1: |
| |
| hidden_states = (hidden_states * attention_mask[:, :, None]).to(dtype) |
|
|
| return self.torch_forward(hidden_states, cache_params, cache_position, attention_mask) |
|
|