# Copyright (c) Meta Platforms, Inc. and affiliates. from dataclasses import dataclass from enum import Enum from typing import Optional, Union, Tuple import torch from torch import nn from torch.nn import functional as F from torch.nn.attention.flex_attention import ( BlockMask, flex_attention, _mask_mod_signature, ) class _NoProbe: # inference no-op (Meta lingua activation-probe is train-only) @staticmethod def log_stats(x, name=None): return x probe = _NoProbe() flex_attention_comp = torch.compile(flex_attention, dynamic=True, mode='max-autotune') class InitStdFactor(Enum): DISABLED = "disabled" # Init std is divided by 1.0 GLOBAL_DEPTH = "global_depth" # Init std is divided by sqrt(2*n_layers) CURRENT_DEPTH = "current_depth" # Init std is divided by sqrt(2*depth) DIM_RATIO = "dim_ratio" # Init std is divided by model_dim/4096 @dataclass class BaseTransformerArgs: dim: int = 1024 n_layers: int = 10 head_dim: Optional[int] = None n_heads: Optional[int] = None n_kv_heads: Optional[int] = None ffn_dim_multiplier: Optional[float] = None multiple_of: int = 256 norm_eps: float = 1e-5 rope_theta: float = 10000.0 init_base_std: Optional[float] = None init_std_factor: str = "disabled" max_seqlen: int = 1024 rope_dim: int = 1 # 0 = NoPE, 1 = 1D-RoPE, 4 = 4D=RoPE. tok_idx_type: Optional[str] = "t_coarse" def cross_entropy(pred, target, **kwargs): return F.nll_loss( F.log_softmax(pred.flatten(end_dim=-2).float(), -1), target.flatten(end_dim=-1), **kwargs, ) def repeat_kv(x: torch.Tensor, n_rep: int, dim: int) -> torch.Tensor: """torch.repeat_interleave(x, dim=2, repeats=n_rep)""" assert dim == 2, "Only dim=2 is supported. Check the implementation for other dims." bs, slen, n_kv_heads, head_dim = x.shape if n_rep == 1: return x return ( x[:, :, :, None, :] .expand(bs, slen, n_kv_heads, n_rep, head_dim) .reshape(bs, slen, n_kv_heads * n_rep, head_dim) ) def precompute_freqs_cis(dim: int, end: int, theta: float = 10000.0): """ Precompute the frequency tensor for complex exponentials (cis) with given dimensions. This function calculates a frequency tensor with complex exponentials using the given dimension 'dim' and the end index 'end'. The 'theta' parameter scales the frequencies. The returned tensor contains complex values in complex64 data type. Args: dim (int): Dimension of the frequency tensor. end (int): End index for precomputing frequencies. theta (float, optional): Scaling factor for frequency computation. Defaults to 10000.0. Returns: torch.Tensor: Precomputed frequency tensor with complex exponentials. """ freqs = 1.0 / (theta ** (torch.arange(0, dim, 2)[: (dim // 2)].float() / dim)) t = torch.arange(end, device=freqs.device) freqs = torch.outer(t, freqs).float() cos, sin = freqs.cos(), freqs.sin() return torch.stack((cos, -sin, sin, cos), dim=-1).view(*freqs.size(), 2, 2) def reshape_for_broadcast(freqs_cis: torch.Tensor, x: torch.Tensor, seq_dim: int): """ Reshape frequency tensor for broadcasting it with another tensor. This function reshapes the frequency tensor to have the same shape as the target tensor 'x' for the purpose of broadcasting the frequency tensor during element-wise operations. Args: freqs_cis (torch.Tensor): Frequency tensor to be reshaped. x (torch.Tensor): Target tensor for broadcasting compatibility. seq_dim (int): Sequence dimension index. Returns: torch.Tensor: Reshaped frequency tensor. """ ndim = x.ndim assert 0 <= seq_dim < ndim assert freqs_cis.shape == ( x.shape[seq_dim], x.shape[-3], 2, 2, ), f"freqs_cis vs x: {(freqs_cis.shape, x.shape)}. freqs_cis should be{(x.shape[seq_dim], x.shape[-3], 2, 2)}." shape = [ d if i == seq_dim or i == ndim - 3 else 1 for i, d in enumerate(x.shape[:-2]) ] + [2, 2] return freqs_cis.view(*shape) def apply_rotary_emb( xq: torch.Tensor, xk: torch.Tensor, seq_dim: int, freqs_cis: torch.Tensor, ) -> Tuple[torch.Tensor, torch.Tensor]: xq_ = xq.reshape(*xq.shape[:-1], -1, 1, 2) # B S D -> B S D/2 1 2 xk_ = xk.reshape(*xk.shape[:-1], -1, 1, 2) # B S D -> B S D/2 1 2 freqs_cis = reshape_for_broadcast( freqs_cis, xq_, seq_dim ).float() # S D/2 2 2 -> 1 S 1 D/2 2 2 xq_out = (xq_ * freqs_cis).sum(5).flatten(3) xk_out = (xk_ * freqs_cis).sum(5).flatten(3) return xq_out.type_as(xq), xk_out.type_as(xk) # Rotary embedding as in xformer class RotaryEmbedding(torch.nn.Module): """ RotaryEmbedding Module """ def __init__(self, theta: float, head_dim: int, max_seqlen: int = 1024, rope_dim: int = 1): super().__init__() self.theta = theta self.head_dim = head_dim self.max_seqlen = max_seqlen self.rope_dim = rope_dim assert head_dim % rope_dim == 0, f"head_dim must be divisible by rope_dim, got {head_dim} and {rope_dim}" self.register_buffer( "freqs_cis", precompute_freqs_cis(dim=head_dim//rope_dim, end=max_seqlen, theta=theta), persistent=False, ) def reset_parameters(self): self.freqs_cis[...] = precompute_freqs_cis( dim=self.head_dim//self.rope_dim, end=self.max_seqlen, theta=self.theta ) def forward( self, seqlen: Optional[int] = None, tok_idx: Optional[torch.Tensor] = None ): """ Return freqs_cis corresponding to consecutive seqlen positions or the corresponding tok_idx positions Args: seqlen (int): Contiguous sequence length tok_idx (torch.Tensor[int]): Position indices of each token. This overrides seqlen. Returns: Tuple(torch.Tensor, torch.Tensor): Embedded input tensor and freqs_cis """ tok_idx = None # HARDCODE (CW)! SEE NOTE BELOW. WILL USE SEQLEN PATH. test = (seqlen is not None) or (tok_idx is not None) assert test, "Should provide atleast seqlen or tok_idx" if tok_idx is not None: return self.freqs_cis[tok_idx] # NOTE: DONT WANT TO INDEX WITH TOK_IDX HERE AND THEN AGAIN INSIDE ATTENTION.FORWARD - DOUBLE DOING elif seqlen is not None: return self.freqs_cis[0:seqlen] class RMSNorm(nn.Module): """ Initialize the RMSNorm normalization layer. Args: dim (int): The dimension of the input tensor. eps (float, optional): A small value added to the denominator for numerical stability. Default is 1e-6. Attributes: eps (float): A small value added to the denominator for numerical stability. weight (nn.Parameter): Learnable scaling parameter. """ def __init__(self, dim: int, eps: float = 1e-6, channel_dim=-1): super().__init__() self.eps = eps self.channel_dim = channel_dim if channel_dim != -1: #channel_dim is the index of the channel dimension, dim is the number of channels. assume 4 dimensions. self.weight = nn.Parameter(torch.ones([1]*channel_dim + [dim] + [1]*(4-channel_dim-1))) else: self.weight = nn.Parameter(torch.ones(dim)) def _norm(self, x: torch.Tensor): return x * torch.rsqrt((x * x).mean(self.channel_dim, keepdim=True) + self.eps) def forward(self, x: torch.Tensor, y: Optional[torch.Tensor] = None) -> torch.Tensor: x = probe.log_stats(x, "resid") output = self._norm(x.float()) return (output * self.weight.float()).type_as(x) def reset_parameters(self): torch.nn.init.ones_(self.weight) # type: ignore class TiedLinear(nn.Module): def __init__(self, tied_module: nn.Module) -> None: super().__init__() self.tied_module = tied_module if not hasattr(tied_module, "weight"): raise AttributeError( "Provided module does not have attribute 'weight'. Please check your tied_module." ) def __call__(self, x: torch.Tensor) -> torch.Tensor: return F.linear(x, self.tied_module.weight) class Attention(nn.Module): def __init__( self, dim: int, head_dim: int, n_heads: int, n_kv_heads: int, rope_theta: float, rope_dim: int, ): super().__init__() self.dim = dim self.head_dim = head_dim self.rope_theta = rope_theta self.rope_dim = rope_dim self.n_heads = n_heads self.n_kv_heads = n_kv_heads self.heads_per_group = self.n_heads // self.n_kv_heads self.wq = nn.Linear( dim, n_heads * head_dim, bias=False, ) self.wk = nn.Linear( dim, n_kv_heads * head_dim, bias=False, ) self.wv = nn.Linear( dim, n_kv_heads * head_dim, bias=False, ) self.wo = nn.Linear( n_heads * head_dim, dim, bias=False, ) def forward( self, x: torch.Tensor, freq_cis: torch.Tensor, tok_idx: Optional[torch.Tensor] = None, mask: Optional[Union[BlockMask, str]] = None, attn_impl: str = "sdpa", ) -> torch.Tensor: # B S D bsz, seq_len, dim = x.shape xq = self.wq(x.view_as(x)) xk = self.wk(x.view_as(x)) xv = self.wv(x.view_as(x)) output_shape = xq.shape # B S D -> B S H Dh (where D = H*Dh) xq = xq.view(bsz, seq_len, self.n_heads, self.head_dim) xk = xk.view(bsz, seq_len, self.n_kv_heads, self.head_dim) xv = xv.view(bsz, seq_len, self.n_kv_heads, self.head_dim) if self.rope_dim==0: pass elif self.rope_dim==1: if tok_idx is not None: xq, xk = apply_rotary_emb(xq, xk, 1, freq_cis[tok_idx]) # this edit mirrors what is inside RotaryEmbedding class. To use tok_idx else: xq, xk = apply_rotary_emb(xq, xk, 1, freq_cis[0:seq_len]) # This is how it was. (SEEMS TO ASSUME WE ARE USING MAX_SEQLEN, NOT TOK_IDX) elif self.rope_dim==4: freqcis_parts = [] for i in range(self.rope_dim): freqcis_parts.append(freq_cis[tok_idx[:, i]]) freqcis_4RoPE = torch.cat(freqcis_parts, dim=1) # Now apply 4D-axial-RoPE xq, xk = apply_rotary_emb(xq, xk, 1, freqcis_4RoPE) else: print(f"I dont know how to handle {self.rope_dim=} inside lingua.transformer.Attention.forward") import IPython; print('\n\nDebug:'); IPython.embed(); import time; time.sleep(0.3) # print(x, xq, xk, xv, freq_cis, tok_idx, seq_len) # This condition helps us be easily compatible # with inference by adding a pluggable KVCache if hasattr(self, "kv_cache"): xk, xv = self.kv_cache.update(xk, xv, tok_idx) xk = repeat_kv(xk, self.heads_per_group, dim=2) xv = repeat_kv(xv, self.heads_per_group, dim=2) if attn_impl == "flex_attention": assert mask is None or isinstance(mask, BlockMask) xq, xk, xv = map(lambda e: e.transpose(1, 2), (xq, xk, xv)) if xq.device.type == "mps": # MPS does not support flex_attention; fall back to SDPA with dense mask if mask is not None: S = xq.shape[2] q_idx = torch.arange(S, device='cpu') kv_idx = torch.arange(S, device='cpu') dense_bool = mask.mask_mod(0, 0, q_idx.unsqueeze(1), kv_idx.unsqueeze(0)) attn_mask = torch.zeros(1, 1, S, S, dtype=xq.dtype, device=xq.device) attn_mask.masked_fill_(~dense_bool.unsqueeze(0).unsqueeze(0).to(xq.device), float("-inf")) else: attn_mask = None output = F.scaled_dot_product_attention(xq, xk, xv, attn_mask=attn_mask) elif xq.device.type == "cuda": output = flex_attention_comp(xq, xk, xv, block_mask=mask) else: output = flex_attention(xq, xk, xv, block_mask=mask) output = output.transpose(1, 2).contiguous() # B H S D -> B S H D elif attn_impl == "sdpa": xq, xk, xv = map(lambda e: e.transpose(1, 2), (xq, xk, xv)) assert mask is None or isinstance(mask, (str, torch.Tensor)) is_causal = (mask == "causal") if isinstance(mask, str) else False mask = mask if isinstance(mask, torch.Tensor) else None output = F.scaled_dot_product_attention( xq, xk, xv, is_causal=is_causal, attn_mask=mask, ) output = output.transpose(1, 2).contiguous() # B H S D -> B S H D else: raise NotImplementedError( f"Attention implementation {attn_impl} not supported" ) output = self.wo(output.reshape(output_shape)) return output def reset_parameters(self, init_std=None, factor=1.0): init_std = init_std or (self.dim ** (-0.5)) for w in [self.wq, self.wk, self.wv]: nn.init.trunc_normal_( w.weight, mean=0.0, std=init_std, a=-3 * init_std, b=3 * init_std, ) nn.init.trunc_normal_( self.wo.weight, mean=0.0, std=init_std / factor, a=-3 * init_std, b=3 * init_std, ) class FeedForward(nn.Module): def __init__( self, dim: int, hidden_dim: int, multiple_of: int, ffn_dim_multiplier: Optional[float], mp_size: int = 1, ): super().__init__() hidden_dim = int(2 * hidden_dim / 3) if ffn_dim_multiplier is not None: hidden_dim = int(ffn_dim_multiplier * hidden_dim) hidden_dim = multiple_of * ((hidden_dim + multiple_of - 1) // multiple_of) assert hidden_dim % mp_size == 0 self.dim = dim self.hidden_dim = hidden_dim self.w1 = nn.Linear( dim, hidden_dim, bias=False, ) self.w3 = nn.Linear( dim, hidden_dim, bias=False, ) self.w2 = nn.Linear( hidden_dim, dim, bias=False, ) def forward(self, x: torch.Tensor) -> torch.Tensor: # B S D x1 = self.w1(x.view_as(x)) x3 = self.w3(x.view_as(x)) output = self.w2(F.silu(x1) * x3) return output def reset_parameters(self, init_std=None, factor=1.0): in_init_std = init_std or (self.dim ** (-0.5)) out_init_std = init_std or (self.hidden_dim ** (-0.5)) in_init_std = in_init_std out_init_std = out_init_std / factor for w in [self.w1, self.w3]: nn.init.trunc_normal_( w.weight, mean=0.0, std=in_init_std, a=-3 * in_init_std, b=3 * in_init_std, ) nn.init.trunc_normal_( self.w2.weight, mean=0.0, std=out_init_std, a=-3 * out_init_std, b=3 * out_init_std, ) class TransformerBlock(nn.Module): def __init__(self, args: BaseTransformerArgs): super().__init__() assert (args.head_dim is not None) or ( args.n_heads is not None ), "Should specify at least head_dim or n_heads" self.head_dim = args.head_dim or args.dim // args.n_heads self.n_heads = args.n_heads or args.dim // args.head_dim self.n_kv_heads = args.n_kv_heads or self.n_heads assert args.n_heads % self.n_kv_heads == 0 assert args.dim % args.n_heads == 0 self.attention = Attention( dim=args.dim, head_dim=self.head_dim, n_heads=self.n_heads, n_kv_heads=self.n_kv_heads, rope_theta=args.rope_theta, rope_dim=args.rope_dim, ) self.feed_forward = FeedForward( dim=args.dim, hidden_dim=4 * args.dim, multiple_of=args.multiple_of, ffn_dim_multiplier=args.ffn_dim_multiplier, ) self.attention_norm = RMSNorm(args.dim, eps=args.norm_eps) self.ffn_norm = RMSNorm(args.dim, eps=args.norm_eps) def forward( self, x: torch.Tensor, freq_cis: torch.Tensor, tok_idx: Optional[torch.Tensor] = None, mask: Optional[Union[BlockMask, str]] = None, attn_impl: str = "sdpa", do_idx: Optional[torch.Tensor] = None, print_layerwise_activation_stats: bool = False, ) -> torch.Tensor: if print_layerwise_activation_stats and do_idx is not None: # Print all the activation stats for the dropped and non-dropped tokens if do_idx is provided x_normed = self.attention_norm(x) print(f"\n\t Encoder attn_norm (drop-out): mean={x[:, do_idx, :].mean().item():.6f}, std={x[:, do_idx, :].std().item():.6f}", end=" --> ") print(f"mean={x_normed[:, do_idx, :].mean().item():.6f}, std={x_normed[:, do_idx, :].std().item():.6f}") print(f"\t Encoder attn_norm (non-drop): mean={x[:, ~do_idx, :].mean().item():.6f}, std={x[:, ~do_idx, :].std().item():.6f}", end=" --> ") print(f"mean={x_normed[:, ~do_idx, :].mean().item():.6f}, std={x_normed[:, ~do_idx, :].std().item():.6f}") h = x + self.attention( # lingua.transformer.Attention x_normed, freq_cis, tok_idx=tok_idx, mask=mask, attn_impl=attn_impl, ) h_normed = self.ffn_norm(h) print(f"\n\t Encoder ffn_norm (drop-out): mean={h[:, do_idx, :].mean().item():.6f}, std={h[:, do_idx, :].std().item():.6f}", end=" --> ") print(f"mean={h_normed[:, do_idx, :].mean().item():.6f}, std={h_normed[:, do_idx, :].std().item():.6f}") print(f"\t Encoder ffn_norm (non-drop): mean={h[:, ~do_idx, :].mean().item():.6f}, std={h[:, ~do_idx, :].std().item():.6f}", end=" --> ") print(f"mean={h_normed[:, ~do_idx, :].mean().item():.6f}, std={h_normed[:, ~do_idx, :].std().item():.6f}") out = h + self.feed_forward(h_normed) # lingua.transformer.FeedForward else: h = x + self.attention( self.attention_norm(x), freq_cis, tok_idx=tok_idx, mask=mask, attn_impl=attn_impl, ) out = h + self.feed_forward(self.ffn_norm(h)) return out def init_weights(self, init_std=None, factor=1.0): self.attention.reset_parameters(init_std, factor) self.attention_norm.reset_parameters() self.feed_forward.reset_parameters(init_std, factor) self.ffn_norm.reset_parameters()