keras-hub-nightly 0.21.0.dev202505050407__py3-none-any.whl → 0.21.0.dev202505060405__py3-none-any.whl

keras_hub/src/models/mixtral/mixtral_decoder.py

@@ -0,0 +1,494 @@
+import keras
+from keras import ops
+
+from keras_hub.src.layers.modeling.transformer_layer_utils import (
+    compute_causal_mask,
+)
+from keras_hub.src.layers.modeling.transformer_layer_utils import (
+    merge_padding_and_attention_mask,
+)
+from keras_hub.src.models.mixtral.mixtral_attention import (
+    CachedMixtralAttention,
+)
+from keras_hub.src.models.mixtral.mixtral_layer_norm import (
+    MixtralLayerNormalization,
+)
+from keras_hub.src.utils.keras_utils import clone_initializer
+
+
+def compute_load_balancing_loss(
+    router_logits, num_experts, top_k, attention_mask=None
+):
+    """Compute the load balancing auxiliary loss for a single MoE layer.
+
+    Args:
+        router_logits: Tensor of shape (batch_size * seq_len, num_experts).
+        num_experts: Integer, total number of experts.
+        top_k: Integer, number of experts to select per token.
+        attention_mask: Tensor of shape (batch_size, seq_len), optional mask
+            for padding.
+    Returns:
+        Scalar tensor representing the auxiliary loss.
+    """
+    # Compute routing probabilities
+    routing_weights = ops.softmax(
+        router_logits, axis=-1
+    )  # Shape: (batch_size * seq_len, num_experts)
+
+    # Get top-k experts
+    top_k_weights, selected_experts = ops.top_k(
+        routing_weights, k=top_k
+    )  # Shape: (batch_size * seq_len, top_k) for both
+
+    # Create one-hot encoding for selected experts
+    expert_mask = ops.one_hot(
+        selected_experts, num_experts
+    )  # Shape: (batch_size * seq_len, top_k, num_experts)
+
+    if attention_mask is not None:
+        # Flatten attention_mask to match router_logits
+        seq_len = ops.shape(attention_mask)[1]
+        batch_seq_len = ops.shape(router_logits)[0]
+        # Dynamically compute the batch size to match router_logits
+        target_batch_size = batch_seq_len // seq_len
+        # Slice attention_mask to match the expected batch size
+        attention_mask = ops.slice(
+            attention_mask, [0, 0], [target_batch_size, seq_len]
+        )
+        flat_mask = ops.reshape(
+            attention_mask, (-1,)
+        )  # Shape: (batch_size * seq_len,)
+        flat_mask = ops.cast(flat_mask, dtype="float32")
+        # Expand mask for broadcasting
+        expert_attention_mask = ops.expand_dims(
+            flat_mask, axis=-1
+        )  # Shape: (batch_size * seq_len, 1)
+        expert_attention_mask = ops.expand_dims(
+            expert_attention_mask, axis=1
+        )  # Shape: (batch_size * seq_len, 1, 1)
+
+        # Compute masked token counts
+        tokens_per_expert = ops.sum(
+            expert_mask * expert_attention_mask, axis=0
+        )  # Shape: (top_k, num_experts)
+        mask_sum = ops.sum(expert_attention_mask, axis=0)  # Shape: (1, 1)
+        tokens_per_expert = tokens_per_expert / ops.maximum(mask_sum, 1e-9)
+
+        # Compute masked router probabilities
+        router_prob_per_expert = ops.sum(
+            routing_weights * flat_mask[:, None], axis=0
+        )  # Shape: (num_experts,)
+        router_prob_per_expert = router_prob_per_expert / ops.maximum(
+            ops.sum(flat_mask), 1e-9
+        )
+    else:
+        # Unmasked means
+        tokens_per_expert = ops.mean(
+            expert_mask, axis=0
+        )  # Shape: (top_k, num_experts)
+        router_prob_per_expert = ops.mean(
+            routing_weights, axis=0
+        )  # Shape: (num_experts,)
+
+    # Average over top_k dimension
+    tokens_per_expert = ops.mean(
+        tokens_per_expert, axis=0
+    )  # Shape: (num_experts,)
+
+    # Compute the loss
+    overall_loss = ops.sum(tokens_per_expert * router_prob_per_expert)
+    return overall_loss * num_experts
+
+
+class MixtralMoeExperts(keras.layers.Layer):
+    """Batched feed-forward experts for Mixtral (pure keras.ops)."""
+
+    def __init__(
+        self,
+        num_experts,
+        hidden_dim,
+        intermediate_dim,
+        activation_fn="silu",
+        kernel_initializer="glorot_uniform",
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.num_experts = num_experts
+        self.hidden_dim = hidden_dim
+        self.intermediate_dim = intermediate_dim
+        self.activation = keras.activations.get(activation_fn)
+        self.kernel_initializer = keras.initializers.get(kernel_initializer)
+
+    def build(self, _):
+        # Weight for gate dense layer:
+        # [num_experts, hidden_dim, intermediate_dim]
+        self._expert_feedforward_gate_dense = self.add_weight(
+            shape=(self.num_experts, self.hidden_dim, self.intermediate_dim),
+            initializer=self.kernel_initializer,
+            trainable=True,
+            dtype=self.variable_dtype,
+            name="expert_feedforward_gate_dense",
+        )
+        # Weight for intermediate dense layer:
+        # [num_experts, hidden_dim, intermediate_dim]
+        self._expert_feedforward_intermediate_dense = self.add_weight(
+            shape=(self.num_experts, self.hidden_dim, self.intermediate_dim),
+            initializer=self.kernel_initializer,
+            trainable=True,
+            dtype=self.variable_dtype,
+            name="expert_feedforward_intermediate_dense",
+        )
+        # Weight for output dense layer:
+        # [num_experts, intermediate_dim, hidden_dim]
+        self._expert_feedforward_output_dense = self.add_weight(
+            shape=(self.num_experts, self.intermediate_dim, self.hidden_dim),
+            initializer=self.kernel_initializer,
+            trainable=True,
+            name="expert_feedforward_output_dense",
+        )
+        self.built = True
+
+    def call(self, hidden_states):
+        # Compute gate output for all experts:
+        # [num_experts, tokens, intermediate_dim]
+        gate = ops.einsum(
+            "th,ehm->etm", hidden_states, self._expert_feedforward_gate_dense
+        )
+        gate = ops.cast(gate, "float32")  # Match PyTorch SiLU precision
+        gate = self.activation(gate)
+        gate = ops.cast(gate, self.compute_dtype)
+
+        # Compute intermediate output for all experts:
+        # [num_experts, tokens, intermediate_dim]
+        intermediate = ops.einsum(
+            "th,ehm->etm",
+            hidden_states,
+            self._expert_feedforward_intermediate_dense,
+        )
+        hidden = intermediate * gate  # Element-wise multiplication
+
+        # Compute final output: [num_experts, tokens, hidden_dim]
+        out = ops.einsum(
+            "eti,eih->eth", hidden, self._expert_feedforward_output_dense
+        )
+        return out
+
+
+class MixtralSparseMoeBlock(keras.layers.Layer):
+    """Mixtral sparse MoE block rewritten in batched style."""
+
+    def __init__(
+        self,
+        hidden_dim,
+        intermediate_dim,
+        num_experts,
+        top_k=2,
+        router_jitter_noise=0.0,
+        layer_norm_epsilon=1e-5,
+        router_aux_loss_coef=0.02,
+        kernel_initializer="glorot_uniform",
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.hidden_dim = hidden_dim
+        self.intermediate_dim = intermediate_dim
+        self.num_experts = num_experts
+        self.top_k = top_k
+        self.router_jitter_noise = router_jitter_noise
+        self.layer_norm_epsilon = layer_norm_epsilon
+        self.router_aux_loss_coef = router_aux_loss_coef
+        self.kernel_initializer = keras.initializers.get(kernel_initializer)
+
+    def build(self, decoder_sequence_shape):
+        # Router dense layer to compute logits for expert selection
+        self._sparse_feedforward_gate_dense = keras.layers.Dense(
+            self.num_experts,
+            kernel_initializer=self.kernel_initializer,
+            use_bias=False,
+            dtype=self.dtype_policy,
+            name="sparse_feedforward_gate_dense",
+        )
+        self._sparse_feedforward_gate_dense.build(decoder_sequence_shape)
+
+        # Batched expert bank
+        self.expert_bank = MixtralMoeExperts(
+            num_experts=self.num_experts,
+            hidden_dim=self.hidden_dim,
+            intermediate_dim=self.intermediate_dim,
+            kernel_initializer=self.kernel_initializer,
+            name="experts",
+            dtype=self.dtype_policy,
+        )
+        self.expert_bank.build(decoder_sequence_shape)
+        self.built = True
+
+    def call(self, hidden_states, attention_mask=None, training=False):
+        batch_size, seq_len, _ = ops.shape(hidden_states)
+        hidden_states_flattened = ops.reshape(
+            hidden_states, (-1, self.hidden_dim)
+        )
+
+        # Apply jitter noise during training if specified
+        if training and self.router_jitter_noise > 0:
+            random_factors = ops.random.uniform(
+                shape=ops.shape(hidden_states_flattened),
+                minval=1.0 - self.router_jitter_noise,
+                maxval=1.0 + self.router_jitter_noise,
+                dtype=hidden_states_flattened.dtype,
+            )
+            hidden_states_flattened = hidden_states_flattened * random_factors
+
+        # Compute router logits and probabilities
+        router_logits = self._sparse_feedforward_gate_dense(
+            hidden_states_flattened
+        )
+        router_probs = ops.softmax(router_logits, axis=-1)
+
+        top_p, top_i = ops.top_k(router_probs, k=self.top_k)
+        sum_topk = ops.sum(top_p, axis=-1, keepdims=True)
+        top_p = top_p / sum_topk  # Normalize top-k probabilities
+
+        one_hot = ops.one_hot(top_i, self.num_experts)
+        one_hot = ops.cast(one_hot, top_p.dtype)
+        routing_full = ops.sum(one_hot * top_p[..., None], axis=1)
+        routing_full = ops.transpose(routing_full, (1, 0))
+        routing_full = ops.cast(routing_full, hidden_states_flattened.dtype)
+
+        expert_out = self.expert_bank(hidden_states_flattened)
+
+        weighted_out = expert_out * routing_full[:, :, None]
+        expert_contribution = ops.sum(weighted_out, axis=0)
+
+        out = ops.reshape(
+            expert_contribution, (batch_size, seq_len, self.hidden_dim)
+        )
+
+        if training:
+            aux_loss = compute_load_balancing_loss(
+                router_logits=router_logits,
+                num_experts=self.num_experts,
+                top_k=self.top_k,
+                attention_mask=attention_mask,
+            )
+            self.add_loss(self.router_aux_loss_coef * aux_loss)
+
+        return out, router_logits
+
+
+class MixtralTransformerDecoder(keras.layers.Layer):
+    def __init__(
+        self,
+        intermediate_dim,
+        num_query_heads,
+        num_key_value_heads,
+        num_experts,
+        top_k=2,
+        router_jitter_noise=0.0,
+        output_router_logits=False,
+        rope_max_wavelength=10000,
+        rope_scaling_factor=1.0,
+        activation="silu",
+        layer_norm_epsilon=1e-5,
+        router_aux_loss_coef=0.02,
+        kernel_initializer="glorot_uniform",
+        sliding_window=512,
+        dropout=0,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        self.intermediate_dim = intermediate_dim
+        self.num_query_heads = num_query_heads
+        self.num_key_value_heads = num_key_value_heads
+
+        self.num_experts = num_experts
+        self.top_k = top_k
+        self.router_jitter_noise = router_jitter_noise
+
+        self.rope_max_wavelength = rope_max_wavelength
+        self.rope_scaling_factor = rope_scaling_factor
+
+        self.dropout = dropout
+
+        self.sliding_window = sliding_window
+        self.activation = keras.activations.get(activation)
+        self.layer_norm_epsilon = layer_norm_epsilon
+        self.kernel_initializer = keras.initializers.get(kernel_initializer)
+
+        self.router_aux_loss_coef = router_aux_loss_coef
+        self.output_router_logits = output_router_logits
+
+        self.supports_masking = True
+
+    def build(self, decoder_sequence_shape):
+        self._decoder_sequence_shape = decoder_sequence_shape
+        self.hidden_dim = decoder_sequence_shape[-1]
+
+        # Self attention layer.
+        self._self_attention_layer = CachedMixtralAttention(
+            num_query_heads=self.num_query_heads,
+            num_key_value_heads=self.num_key_value_heads,
+            rope_max_wavelength=self.rope_max_wavelength,
+            rope_scaling_factor=self.rope_scaling_factor,
+            sliding_window=self.sliding_window,
+            kernel_initializer=clone_initializer(self.kernel_initializer),
+            dropout=self.dropout,
+            dtype=self.dtype_policy,
+            name="self_attention",
+        )
+        self._self_attention_layer.build(decoder_sequence_shape)
+
+        self._self_attention_layernorm = MixtralLayerNormalization(
+            epsilon=self.layer_norm_epsilon,
+            dtype=self.dtype_policy,
+            name="self_attention_layernorm",
+        )
+        self._self_attention_layernorm.build(decoder_sequence_shape)
+        self._self_attention_dropout = keras.layers.Dropout(
+            rate=self.dropout,
+            dtype=self.dtype_policy,
+            name="self_attention_dropout",
+        )
+
+        self._sparse_moe_block = MixtralSparseMoeBlock(
+            hidden_dim=self.hidden_dim,
+            intermediate_dim=self.intermediate_dim,
+            num_experts=self.num_experts,
+            top_k=self.top_k,
+            router_jitter_noise=self.router_jitter_noise,
+            router_aux_loss_coef=self.router_aux_loss_coef,
+            dtype=self.dtype_policy,
+        )
+        self._sparse_moe_block.build(decoder_sequence_shape)
+
+        self._feedforward_layernorm = MixtralLayerNormalization(
+            epsilon=self.layer_norm_epsilon,
+            dtype=self.dtype_policy,
+            name="feedforward_layernorm",
+        )
+        self._feedforward_layernorm.build(decoder_sequence_shape)
+
+        self.built = True
+
+    def call(
+        self,
+        decoder_sequence,
+        decoder_padding_mask=None,
+        decoder_attention_mask=None,
+        self_attention_cache=None,
+        self_attention_cache_update_index=None,
+        training=None,
+    ):
+        self_attention_mask = self._compute_self_attention_mask(
+            decoder_sequence=decoder_sequence,
+            decoder_padding_mask=decoder_padding_mask,
+            decoder_attention_mask=decoder_attention_mask,
+            self_attention_cache=self_attention_cache,
+            self_attention_cache_update_index=self_attention_cache_update_index,
+        )
+        residual = decoder_sequence
+
+        x = self._self_attention_layernorm(decoder_sequence)
+
+        # Self attention block.
+        x = self._self_attention_layer(
+            hidden_states=x,
+            attention_mask=self_attention_mask,
+            cache=self_attention_cache,
+            cache_update_index=self_attention_cache_update_index,
+        )
+
+        if self_attention_cache is not None:
+            x, self_attention_cache = x
+
+        x = self._self_attention_dropout(x, training=training)
+
+        x = x + residual
+        residual = x
+
+        x = self._feedforward_layernorm(x)
+        x, router_logits = self._sparse_moe_block(
+            x, attention_mask=decoder_padding_mask
+        )
+
+        decoder_output = x + residual
+
+        output = (decoder_output,)
+
+        if self_attention_cache is not None:
+            output += (self_attention_cache,)
+
+        if self.output_router_logits:
+            output += (router_logits,)
+
+        return output[0] if len(output) == 1 else output
+
+    def _compute_self_attention_mask(
+        self,
+        decoder_sequence,
+        decoder_padding_mask,
+        decoder_attention_mask,
+        self_attention_cache,
+        self_attention_cache_update_index,
+    ):
+        decoder_mask = merge_padding_and_attention_mask(
+            decoder_sequence, decoder_padding_mask, decoder_attention_mask
+        )
+        batch_size = ops.shape(decoder_sequence)[0]
+        input_length = output_length = ops.shape(decoder_sequence)[1]
+        # We need to handle a rectangular causal mask when doing cached
+        # decoding. For generative inference, `decoder_sequence` will
+        # generally be length 1, and `cache` will be the full generation length.
+        if self_attention_cache is not None:
+            input_length = ops.shape(self_attention_cache)[2]
+
+        cache_update_index = (
+            0
+            if self_attention_cache_update_index is None
+            else self_attention_cache_update_index
+        )
+
+        # The lower traingular attention mask
+        causal_mask = compute_causal_mask(
+            batch_size, input_length, output_length, cache_update_index
+        )
+
+        # Mixtral uses a banded attention mask if sliding window is not None
+        if self.sliding_window is not None:
+            # ops.trui/tril has issues with dynamic shape on the tensorflow
+            # causal_mask = ops.triu(causal_mask, k=-self.sliding_window)
+            i = ops.arange(output_length)[:, None] + cache_update_index
+            j = ops.arange(input_length)[None, :]
+            causal_mask_upper = ops.cast(i < j + self.sliding_window, "int32")
+            causal_mask = ops.minimum(causal_mask, causal_mask_upper)
+
+        return (
+            ops.minimum(decoder_mask, causal_mask)
+            if decoder_mask is not None
+            else causal_mask
+        )
+
+    def compute_output_shape(self, decoder_sequence_shape):
+        return decoder_sequence_shape
+
+    def get_config(self):
+        config = super().get_config()
+        config.update(
+            {
+                "intermediate_dim": self.intermediate_dim,
+                "num_query_heads": self.num_query_heads,
+                "rope_max_wavelength": self.rope_max_wavelength,
+                "rope_scaling_factor": self.rope_scaling_factor,
+                "num_key_value_heads": self.num_key_value_heads,
+                "num_experts": self.num_experts,
+                "top_k": self.top_k,
+                "router_jitter_noise": self.router_jitter_noise,
+                "sliding_window": self.sliding_window,
+                "activation": keras.activations.serialize(self.activation),
+                "layer_norm_epsilon": self.layer_norm_epsilon,
+                "kernel_initializer": keras.initializers.serialize(
+                    self.kernel_initializer
+                ),
+                "dropout": self.dropout,
+            }
+        )
+        return config

keras_hub/src/models/mixtral/mixtral_layer_norm.py

@@ -0,0 +1,34 @@
+import keras
+from keras import ops
+
+
+# NOTE: `keras.layers.LayerNormalization(rms_scaling=True)`
+# does not produce same results
+class MixtralLayerNormalization(keras.layers.Layer):
+    """A normalization layer for Mixtral that implements RMS normalization."""
+
+    def __init__(self, epsilon=1e-6, **kwargs):
+        super().__init__(**kwargs)
+        self.epsilon = epsilon
+
+    def build(self, input_shape):
+        dim = input_shape[-1]
+        self.scale = self.add_weight(
+            name="scale",
+            trainable=True,
+            shape=(dim,),
+            initializer="ones",
+            dtype=self.variable_dtype,
+        )
+        self.built = True
+
+    def call(self, x):
+        x = ops.cast(x, "float32")
+        var = ops.mean(ops.power(x, 2), axis=-1, keepdims=True)
+        x = x * ops.rsqrt(var + self.epsilon)
+        return ops.cast(x * self.scale, self.compute_dtype)
+
+    def get_config(self):
+        config = super().get_config()
+        config.update({"epsilon": self.epsilon})
+        return config

keras_hub/src/models/mixtral/mixtral_tokenizer.py

@@ -0,0 +1,21 @@
+from keras_hub.src.api_export import keras_hub_export
+from keras_hub.src.models.mixtral.mixtral_backbone import MixtralBackbone
+from keras_hub.src.tokenizers.sentence_piece_tokenizer import (
+    SentencePieceTokenizer,
+)
+
+
+@keras_hub_export(
+    [
+        "keras_hub.tokenizers.MixtralTokenizer",
+        "keras_hub.models.MixtralTokenizer",
+    ]
+)
+class MixtralTokenizer(SentencePieceTokenizer):
+    backbone_cls = MixtralBackbone
+
+    def __init__(self, proto, **kwargs):
+        self._add_special_token("<s>", "start_token")
+        self._add_special_token("</s>", "end_token")
+        self.pad_token_id = 0
+        super().__init__(proto=proto, **kwargs)

keras_hub/src/models/qwen/qwen_attention.py

@@ -287,7 +287,9 @@ class QwenAttention(keras.layers.Layer):
         if self.use_sliding_window_attention:
             attention_mask = self._mask_sliding_window(
                 attention_mask,
-                cache_update_index=cache_update_index,
+                cache_update_index=cache_update_index
+                if cache_update_index
+                else 0,
             )
         attention_scores = self._masked_softmax(
             attention_scores, attention_mask

keras_hub/src/models/qwen/qwen_presets.py

@@ -0,0 +1,61 @@
+"""Qwen preset configurations."""
+
+backbone_presets = {
+    "qwen2.5_0.5b_en": {
+        "metadata": {
+            "description": ("24-layer Qwen model with 0.5 billion parameters."),
+            "params": 494032768,
+            "path": "qwen",
+        },
+        "kaggle_handle": "kaggle://keras/qwen/keras/qwen2.5_0.5b_en",
+    },
+    "qwen2.5_3b_en": {
+        "metadata": {
+            "description": ("36-layer Qwen model with 3.1 billion parameters."),
+            "params": 3085938688,
+            "path": "qwen",
+        },
+        "kaggle_handle": "kaggle://keras/qwen/keras/qwen2.5_3b_en",
+    },
+    "qwen2.5_7b_en": {
+        "metadata": {
+            "description": ("48-layer Qwen model with 7 billion parameters."),
+            "params": 6993420288,
+            "path": "qwen",
+        },
+        "kaggle_handle": "kaggle://keras/qwen/keras/qwen2.5_7b_en/2",
+    },
+    "qwen2.5_instruct_0.5b_en": {
+        "metadata": {
+            "description": (
+                "Instruction fine-tuned 24-layer Qwen model with 0.5 ",
+                "billion parameters.",
+            ),
+            "params": 494032768,
+            "path": "qwen",
+        },
+        "kaggle_handle": "kaggle://keras/qwen/keras/qwen2.5_instruct_0.5b_en",
+    },
+    "qwen2.5_instruct_32b_en": {
+        "metadata": {
+            "description": (
+                "Instruction fine-tuned 64-layer Qwen model with 32 ",
+                "billion parameters.",
+            ),
+            "params": 32763876352,
+            "path": "qwen",
+        },
+        "kaggle_handle": "kaggle://keras/qwen/keras/qwen2.5_instruct_32b_en",
+    },
+    "qwen2.5_instruct_72b_en": {
+        "metadata": {
+            "description": (
+                "Instruction fine-tuned 80-layer Qwen model with 72 ",
+                "billion parameters.",
+            ),
+            "params": 72706203648,
+            "path": "qwen",
+        },
+        "kaggle_handle": "kaggle://keras/qwen/keras/qwen2.5_instruct_72b_en",
+    },
+}