""" Modular Instella-MoE for transformers 4.57.1. This file imports the numerically-unchanged building blocks from the installed `transformers.models.deepseek_v3` package and defines ONLY the classes that carry a FarSkip or gated-attention delta: * InstellaMoEForCausalLM * InstellaMoEPreTrainedModel * InstellaMoEModel - unwraps the residual tuple before the final norm * FarSkipDecoderLayer - tuple-residual (residual, residual_no_routed) dataflow * FarSkipMoE - returns (routed, shared) separately (FarSkip needs both) * MLAGatedAttention - adds sigmoid `gate_proj` before `o_proj` """ from typing import Optional, Union import torch from torch import nn from transformers.cache_utils import Cache, DynamicCache from transformers.generation import GenerationMixin from transformers.masking_utils import create_causal_mask from transformers.modeling_layers import GradientCheckpointingLayer from transformers.modeling_outputs import BaseModelOutputWithPast, CausalLMOutputWithPast from transformers.modeling_utils import ALL_ATTENTION_FUNCTIONS, PreTrainedModel from transformers.processing_utils import Unpack from transformers.utils import TransformersKwargs, auto_docstring, can_return_tuple from transformers.utils.generic import check_model_inputs from transformers.models.deepseek_v3.modeling_deepseek_v3 import ( DeepseekV3RMSNorm, DeepseekV3RotaryEmbedding, DeepseekV3MLP, DeepseekV3MoE, DeepseekV3TopkRouter, DeepseekV3Attention, apply_rotary_pos_emb, apply_rotary_pos_emb_interleave, eager_attention_forward, ) from .configuration_instella_moe import InstellaMoEConfig class MLAGatedAttention(DeepseekV3Attention): """DeepSeek-V3 MLA with optional gated attention (attn_output * sigmoid(gate_proj(x))).""" def __init__(self, config: InstellaMoEConfig, layer_idx: int): super().__init__(config, layer_idx) self.gated_attention = getattr(config, "gated_attention", False) if self.gated_attention: self.gate_proj = nn.Linear( config.hidden_size, self.num_heads * self.v_head_dim, bias=False ) def forward( self, hidden_states: torch.Tensor, position_embeddings: tuple[torch.Tensor, torch.Tensor], attention_mask: Optional[torch.Tensor], past_key_values: Optional[Cache] = None, cache_position: Optional[torch.LongTensor] = None, **kwargs: Unpack[TransformersKwargs], ) -> tuple[torch.Tensor, Optional[torch.Tensor]]: batch_size, seq_length = hidden_states.shape[:-1] query_shape = (batch_size, seq_length, -1, self.qk_head_dim) key_shape = (batch_size, seq_length, -1, self.qk_nope_head_dim + self.v_head_dim) if self.q_lora_rank is None: q_states = self.q_proj(hidden_states) else: q_states = self.q_b_proj(self.q_a_layernorm(self.q_a_proj(hidden_states))) q_states = q_states.view(query_shape).transpose(1, 2) q_pass, q_rot = torch.split(q_states, [self.qk_nope_head_dim, self.qk_rope_head_dim], dim=-1) compressed_kv = self.kv_a_proj_with_mqa(hidden_states) k_pass, k_rot = torch.split(compressed_kv, [self.kv_lora_rank, self.qk_rope_head_dim], dim=-1) k_pass = self.kv_b_proj(self.kv_a_layernorm(k_pass)).view(key_shape).transpose(1, 2) k_pass, value_states = torch.split(k_pass, [self.qk_nope_head_dim, self.v_head_dim], dim=-1) k_rot = k_rot.view(batch_size, 1, seq_length, self.qk_rope_head_dim) cos, sin = position_embeddings if self.config.rope_interleave: q_rot, k_rot = apply_rotary_pos_emb_interleave(q_rot, k_rot, cos, sin) else: q_rot, k_rot = apply_rotary_pos_emb(q_rot, k_rot, cos, sin) k_rot = k_rot.expand(*k_pass.shape[:-1], -1) query_states = torch.cat((q_pass, q_rot), dim=-1) key_states = torch.cat((k_pass, k_rot), dim=-1) if past_key_values is not None: cache_kwargs = {"sin": sin, "cos": cos, "cache_position": cache_position} key_states, value_states = past_key_values.update( key_states, value_states, self.layer_idx, cache_kwargs ) if self.config._attn_implementation == "flash_attention_2" and self.qk_head_dim != self.v_head_dim: value_states = nn.functional.pad(value_states, [0, self.qk_head_dim - self.v_head_dim]) attention_interface = eager_attention_forward if self.config._attn_implementation != "eager": attention_interface = ALL_ATTENTION_FUNCTIONS[self.config._attn_implementation] attn_output, attn_weights = attention_interface( self, query_states, key_states, value_states, attention_mask, dropout=0.0 if not self.training else self.attention_dropout, scaling=self.scaling, **kwargs, ) if self.config._attn_implementation == "flash_attention_2" and self.qk_head_dim != self.v_head_dim: attn_output = attn_output[:, :, :, : self.v_head_dim] attn_output = attn_output.reshape(batch_size, seq_length, -1).contiguous() if self.gated_attention: attn_output = attn_output * torch.sigmoid(self.gate_proj(hidden_states)) attn_output = self.o_proj(attn_output) return attn_output, attn_weights class FarSkipMoE(DeepseekV3MoE): """FarSkip-Collective MoE that returns routed and shared outputs separately so FarSkip can route them into the two residual streams independently.""" def forward(self, hidden_states): residuals = hidden_states orig_shape = hidden_states.shape topk_indices, topk_weights = self.gate(hidden_states) hidden_states = hidden_states.view(-1, hidden_states.shape[-1]) routed = self.moe(hidden_states, topk_indices, topk_weights).view(*orig_shape) shared = self.shared_experts(residuals) # First element is the full MoE output (routed + shared) so the main residual # stream stays numerically identical to stock DeepSeek-V3; `shared` is returned # separately so FarSkip can build the routed-free residual stream. return routed + shared, shared class FarSkipDecoderLayer(GradientCheckpointingLayer): """ FarSkip-Collective connectivity decoder layer """ def __init__(self, config: InstellaMoEConfig, layer_idx: int): super().__init__() self.hidden_size = config.hidden_size self.self_attn = MLAGatedAttention(config=config, layer_idx=layer_idx) if layer_idx >= config.first_k_dense_replace: self.mlp = FarSkipMoE(config) else: self.mlp = DeepseekV3MLP(config) self.input_layernorm = DeepseekV3RMSNorm(config.hidden_size, eps=config.rms_norm_eps) self.post_attention_layernorm = DeepseekV3RMSNorm(config.hidden_size, eps=config.rms_norm_eps) self.config = config self.layer_idx = layer_idx self.farskip = ( config.farskip and layer_idx >= config.farskip_start_idx and layer_idx <= min(config.farskip_end_idx, config.num_hidden_layers - 1) ) def forward( self, hidden_states, attention_mask: Optional[torch.Tensor] = None, position_ids: Optional[torch.LongTensor] = None, past_key_values: Optional[Cache] = None, use_cache: Optional[bool] = False, cache_position: Optional[torch.LongTensor] = None, position_embeddings: Optional[tuple[torch.Tensor, torch.Tensor]] = None, **kwargs: Unpack[TransformersKwargs], ): if self.farskip: if not isinstance(hidden_states, tuple): # first farskip layer residual = hidden_states input_to_attn = hidden_states input_to_mlp = hidden_states else: residual = hidden_states[0] input_to_attn = hidden_states[1] input_to_mlp = residual if self.config.attn_only_farskip: input_to_mlp = None if self.config.mlp_only_farskip: input_to_attn = residual else: if isinstance(hidden_states, tuple): hidden_states = hidden_states[0] residual = hidden_states input_to_attn = hidden_states input_to_mlp = None input_to_attn = self.input_layernorm(input_to_attn) attn_output, _ = self.self_attn( hidden_states=input_to_attn, position_embeddings=position_embeddings, attention_mask=attention_mask, past_key_values=past_key_values, cache_position=cache_position, **kwargs, ) residual = residual + attn_output if input_to_mlp is None: input_to_mlp = residual input_to_mlp = self.post_attention_layernorm(input_to_mlp) if isinstance(self.mlp, FarSkipMoE): mlp_output, mlp_shared_output = self.mlp(input_to_mlp) residual_no_routed = residual + mlp_shared_output residual = residual + mlp_output # residual_no_routed is combine-free and feeds the next block's attention hidden_states = (residual, residual_no_routed) else: hidden_states = residual + self.mlp(input_to_mlp) return hidden_states @auto_docstring class InstellaMoEPreTrainedModel(PreTrainedModel): config: InstellaMoEConfig config_class = InstellaMoEConfig base_model_prefix = "model" supports_gradient_checkpointing = True _no_split_modules = ["FarSkipDecoderLayer"] _skip_keys_device_placement = ["past_key_values"] _supports_flash_attn = True _supports_sdpa = True _supports_flex_attn = True _can_compile_fullgraph = False _supports_attention_backend = True _can_record_outputs = { "hidden_states": FarSkipDecoderLayer, "attentions": MLAGatedAttention, } def _init_weights(self, module): super()._init_weights(module) if isinstance(module, DeepseekV3TopkRouter): module.weight.data.normal_(mean=0.0, std=self.config.initializer_range) @auto_docstring class InstellaMoEModel(InstellaMoEPreTrainedModel): def __init__(self, config: InstellaMoEConfig): super().__init__(config) self.padding_idx = config.pad_token_id self.vocab_size = config.vocab_size self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size, self.padding_idx) self.layers = nn.ModuleList( [FarSkipDecoderLayer(config, layer_idx) for layer_idx in range(config.num_hidden_layers)] ) self.norm = DeepseekV3RMSNorm(config.hidden_size, eps=config.rms_norm_eps) self.rotary_emb = DeepseekV3RotaryEmbedding(config=config) self.gradient_checkpointing = False self.post_init() @check_model_inputs @auto_docstring def forward( self, input_ids: Optional[torch.LongTensor] = None, attention_mask: Optional[torch.Tensor] = None, position_ids: Optional[torch.LongTensor] = None, past_key_values: Optional[Cache] = None, inputs_embeds: Optional[torch.FloatTensor] = None, cache_position: Optional[torch.LongTensor] = None, use_cache: Optional[bool] = None, **kwargs: Unpack[TransformersKwargs], ) -> BaseModelOutputWithPast: if (input_ids is None) ^ (inputs_embeds is not None): raise ValueError("You must specify exactly one of input_ids or inputs_embeds") if inputs_embeds is None: inputs_embeds = self.embed_tokens(input_ids) if use_cache and past_key_values is None: past_key_values = DynamicCache(config=self.config) if cache_position is None: past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0 cache_position = torch.arange( past_seen_tokens, past_seen_tokens + inputs_embeds.shape[1], device=inputs_embeds.device ) if position_ids is None: position_ids = cache_position.unsqueeze(0) causal_mask = create_causal_mask( config=self.config, input_embeds=inputs_embeds, attention_mask=attention_mask, cache_position=cache_position, past_key_values=past_key_values, position_ids=position_ids, ) hidden_states = inputs_embeds position_embeddings = self.rotary_emb(hidden_states, position_ids) for decoder_layer in self.layers[: self.config.num_hidden_layers]: hidden_states = decoder_layer( hidden_states, attention_mask=causal_mask, position_ids=position_ids, past_key_values=past_key_values, cache_position=cache_position, position_embeddings=position_embeddings, **kwargs, ) if isinstance(hidden_states, tuple): hidden_states = hidden_states[0] # routed-inclusive residual stream hidden_states = self.norm(hidden_states) return BaseModelOutputWithPast( last_hidden_state=hidden_states, past_key_values=past_key_values, ) @auto_docstring class InstellaMoEForCausalLM(InstellaMoEPreTrainedModel, GenerationMixin): _tied_weights_keys = ["lm_head.weight"] _tp_plan = {"lm_head": "colwise_rep"} _pp_plan = {"lm_head": (["hidden_states"], ["logits"])} def __init__(self, config): super().__init__(config) self.model = InstellaMoEModel(config) self.vocab_size = config.vocab_size self.lm_head = nn.Linear(config.hidden_size, config.vocab_size, bias=False) self.post_init() @can_return_tuple @auto_docstring def forward( self, input_ids: Optional[torch.LongTensor] = None, attention_mask: Optional[torch.Tensor] = None, position_ids: Optional[torch.LongTensor] = None, past_key_values: Optional[Cache] = None, inputs_embeds: Optional[torch.FloatTensor] = None, labels: Optional[torch.LongTensor] = None, use_cache: Optional[bool] = None, cache_position: Optional[torch.LongTensor] = None, logits_to_keep: Union[int, torch.Tensor] = 0, **kwargs: Unpack[TransformersKwargs], ) -> CausalLMOutputWithPast: outputs: BaseModelOutputWithPast = self.model( input_ids=input_ids, attention_mask=attention_mask, position_ids=position_ids, past_key_values=past_key_values, inputs_embeds=inputs_embeds, use_cache=use_cache, cache_position=cache_position, **kwargs, ) hidden_states = outputs.last_hidden_state slice_indices = slice(-logits_to_keep, None) if isinstance(logits_to_keep, int) else logits_to_keep logits = self.lm_head(hidden_states[:, slice_indices, :]) loss = None if labels is not None: loss = self.loss_function(logits=logits, labels=labels, vocab_size=self.config.vocab_size, **kwargs) return CausalLMOutputWithPast( loss=loss, logits=logits, past_key_values=outputs.past_key_values, hidden_states=outputs.hidden_states, attentions=outputs.attentions, ) __all__ = [ "InstellaMoEPreTrainedModel", "InstellaMoEModel", "InstellaMoEForCausalLM", ]