avarok_core/

config.rs

// SPDX-License-Identifier: AGPL-3.0-only

use anyhow::Result;
use serde::Deserialize;

/// Deserialize a u32 that may be JSON null (treat null as 0).
fn nullable_u32<'de, D: serde::Deserializer<'de>>(d: D) -> std::result::Result<u32, D::Error> {
    Option::<u32>::deserialize(d).map(|v| v.unwrap_or(0))
}

/// `eos_token_id`, which HF allows to be `null`, a scalar, **or an array**.
///
/// GLM-5.3-Flash declares three stop tokens as an array, and before Slice 9 that made its
/// `config.json` fail to parse outright ("invalid type: sequence, expected u32") — every family
/// arm deserializes `eos_token_id` as a bare `u32`. This yields **element 0** as the primary;
/// the COMPLETE set is recovered separately into [`ModelConfig::eos_token_ids`] by
/// `parse_config`, so nothing is discarded.
///
/// Backward compatible by construction: an array was previously a hard error, so no config that
/// parses today can change meaning. A parser that wants a different primary (`step3p7` takes the
/// LAST element) still rewrites the field before deserializing, and that choice is preserved.
fn eos_token_id_field<'de, D: serde::Deserializer<'de>>(
    d: D,
) -> std::result::Result<u32, D::Error> {
    #[derive(Deserialize)]
    #[serde(untagged)]
    enum OneOrMany {
        One(u32),
        Many(Vec<u32>),
    }
    Ok(match Option::<OneOrMany>::deserialize(d)? {
        None => 0,
        Some(OneOrMany::One(v)) => v,
        Some(OneOrMany::Many(v)) => v.first().copied().unwrap_or(0),
    })
}

/// Which dtype ladder GLM-5.3's MoE router runs in.
///
/// 🔴 **This is a SEMANTIC switch, not a precision preference.** Slice 10 measured the two
/// ladders selecting a different top-8 expert set on ~89–95 % of tokens (layers 3/23/44,
/// T=2048), moving 20–26 % of routed weight mass onto experts the other ladder did not pick.
/// Treating it as a harmless rounding choice is how a "faster router" silently becomes a
/// different model.
///
/// Deliberately its OWN field, not derived from the quantization config or from
/// `PrecisionSchedule::router_dtype` (which is a weight-STORAGE schedule with no compute
/// meaning, and no consumers). Inferring a semantic from an unrelated knob is the defect this
/// avoids.
///
/// GLM-scoped on purpose: no other Atlas model has a contested router ladder, and widening this
/// into a cross-model routing refactor would be scope Atlas has not asked for.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Glm5NextRouterMode {
    /// **CANONICAL / REFERENCE.** HF `transformers` 5.16.1 semantics:
    /// `F.linear(hidden.type(float32), weight.type(float32))`, and sigmoid / correction bias /
    /// top-k / renormalisation all in fp32. This is the production default and must not change
    /// without review.
    #[default]
    HfFp32,
    /// **COMPATIBILITY / ORACLE REPRODUCTION.** Reproduces what vLLM currently does for
    /// `glm5_next_text`: `GateLinear.out_dtype` resolves to `None` (the fp32 special case in
    /// `_get_moe_router_dtype` fires only for `glm_moe_dsa` or an explicit `moe_router_dtype`),
    /// so the gate GEMM runs in the model dtype and `grouped_topk` does no upcast.
    ///
    /// Exists so Atlas can reproduce the frozen vLLM oracle's routing for A/B work. **Never a
    /// production default.**
    VllmBf16,
}

impl Glm5NextRouterMode {
    /// Parse the `moe_router_dtype` config field — the same name vLLM reads.
    ///
    /// Absent ⇒ [`Self::HfFp32`]. That is the opposite of vLLM's fallthrough, and deliberately
    /// so: absent means "the checkpoint did not say", and the reference implementation's answer
    /// for that case is fp32.
    pub fn from_config_str(s: &str) -> Option<Self> {
        match s {
            "float32" | "fp32" => Some(Self::HfFp32),
            "bfloat16" | "bf16" => Some(Self::VllmBf16),
            _ => None,
        }
    }

    /// True when router math must be carried in fp32.
    pub fn is_fp32(self) -> bool {
        matches!(self, Self::HfFp32)
    }
}

/// Layer type in a hybrid transformer model.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum LayerType {
    FullAttention,
    SlidingAttention,
    LinearAttention,
    /// Standalone MoE FFN layer (Nemotron-H: no mixer, just expert routing + FFN).
    Moe,
    /// Sparse attention over a per-query selected subset of the KV cache
    /// (`deepseek_sparse_attention`): a full-rank mixer whose visible key set is
    /// chosen at runtime by an indexer, not fixed by a window.
    ///
    /// Distinct from [`Self::FullAttention`] on purpose. Both attend over the whole
    /// cache in principle, but a sparse layer additionally needs indexer state, an
    /// indexer weight family, and a per-query top-k selection step — so scheduling,
    /// cache sizing and weight binding all have to be able to tell them apart. GLM-5.3
    /// was previously flattened onto `FullAttention` at parse time, which round-tripped
    /// `deepseek_sparse_attention` into a lie.
    SparseAttention,
}

impl LayerType {
    /// Does this layer attend over a KV cache (as opposed to carrying recurrent state
    /// or being FFN-only)?
    pub fn is_attention(self) -> bool {
        matches!(
            self,
            Self::FullAttention | Self::SlidingAttention | Self::SparseAttention
        )
    }

    /// The string this layer type round-trips to in a HuggingFace `layer_types` array.
    pub fn hf_name(self) -> &'static str {
        match self {
            Self::FullAttention => "full_attention",
            Self::SlidingAttention => "sliding_attention",
            Self::LinearAttention => "linear_attention",
            Self::Moe => "moe",
            Self::SparseAttention => "deepseek_sparse_attention",
        }
    }
}

/// Model configuration parsed from HuggingFace config.json.
///
/// Single source of truth for model dimensions. All kernel launch
/// parameters and buffer sizes derive from this struct.
#[derive(Debug, Clone, Deserialize)]
pub struct ModelConfig {
    // ── Core dimensions ──
    pub hidden_size: usize,
    #[serde(default)]
    pub num_hidden_layers: usize,
    #[serde(default)]
    pub intermediate_size: usize,
    #[serde(default)]
    pub vocab_size: usize,

    // ── Full attention ──
    #[serde(default)]
    pub num_attention_heads: usize,
    /// Per-layer Q-head counts for heterogeneous attention models. Empty means
    /// every layer uses `num_attention_heads`.
    #[serde(default)]
    pub num_attention_heads_per_layer: Vec<usize>,
    /// GQA: number of K/V heads (≤ `num_attention_heads`). MQA when 1.
    #[serde(default)]
    pub num_key_value_heads: usize,
    #[serde(default)]
    pub head_dim: usize,
    /// Fraction of `head_dim` that gets RoPE-rotated. 1.0 = full RoPE,
    /// 0.5 = half-rotated (Phi-style). Default 1.0.
    #[serde(default = "default_partial_rotary")]
    pub partial_rotary_factor: f64,

    // ── Linear attention (SSM / GDN) ──
    // "linear" = the recurrent state-space / gated-delta-net pathway used
    // by hybrid models (Qwen3.5/3.6, Nemotron-Nano, MiniMax). Per-token
    // updates run in O(1) state instead of O(seq) attention.
    #[serde(default)]
    pub linear_num_key_heads: usize,
    #[serde(default)]
    pub linear_key_head_dim: usize,
    #[serde(default)]
    pub linear_num_value_heads: usize,
    #[serde(default)]
    pub linear_value_head_dim: usize,
    /// 1D causal-conv kernel size on the SSM input (typically 3 or 4).
    #[serde(default = "default_conv_kernel")]
    pub linear_conv_kernel_dim: usize,

    // ── MoE ──
    #[serde(default)]
    pub num_experts: usize,
    /// LongCat-Flash zero-computation "identity" experts: the router scores
    /// `num_experts + zero_expert_num` logits, and a token routed to an
    /// expert id `>= num_experts` receives the INPUT itself scaled by the
    /// routing weight instead of an expert FFN. 0 = no zero-experts.
    #[serde(default)]
    pub zero_expert_num: usize,
    /// Top-K experts activated per token (the "A" in 35B-A3B = 3B
    /// active params).
    #[serde(default = "default_one")]
    pub num_experts_per_tok: usize,
    #[serde(default)]
    pub moe_intermediate_size: usize,
    #[serde(default)]
    pub shared_expert_intermediate_size: usize,
    /// Renormalize routing probabilities so the K active experts sum
    /// to 1 after top-K selection. Qwen3.5+ sets true; older Qwen2 MoE
    /// variants set false.
    #[serde(default)]
    pub norm_topk_prob: bool,
    /// MoE block stride: layer `i` uses MoE iff `i % decoder_sparse_step
    /// == 0`. 1 = every layer is MoE. Mistral / DeepSeek-style stagger
    /// uses 2.
    #[serde(default = "default_one")]
    pub decoder_sparse_step: usize,

    // ── Hybrid layer layout ──
    /// Per-layer kind (FullAttention | LinearAttention | …) parsed from
    /// HF config. When empty, falls back to `full_attention_interval`.
    #[serde(default)]
    pub layer_types: Vec<LayerType>,
    /// Per-layer kind for the **extra** layers that sit past `num_hidden_layers`:
    /// multi-token-prediction / NextN blocks. Empty for models that have none.
    ///
    /// Kept separate from `layer_types` on purpose. GLM-5.3-Flash's layer 45 is a real
    /// decoder layer with its own attention block, but `num_hidden_layers` is 45 and
    /// `config.layer_types` has 45 entries covering 0..=44 — so layer 45 has no honest
    /// slot there. Appending it would make every length check and every "iterate the text
    /// stack" loop silently include a speculative-decoding layer. Look it up through
    /// [`ModelConfig::layer_type_at`], which routes indices past the text stack here.
    #[serde(default)]
    pub mtp_layer_types: Vec<LayerType>,
    /// Stride for full-attention layers in hybrid models when
    /// `layer_types` is empty: every Nth layer is FullAttention, the
    /// rest LinearAttention. 1 = every layer is full attention.
    #[serde(default = "default_one")]
    pub full_attention_interval: usize,
    /// Gemma-4 hybrid-attention sliding window size (0 = full attention).
    /// Sliding layers only attend to the last `sliding_window` KV positions;
    /// full layers (every 6th in Gemma-4) ignore this (effectively 0).
    /// Parsed from HF config.json `sliding_window` field. Uses `nullable_u32`
    /// because Nemotron-H (and some other models) set it to `null` in JSON.
    #[serde(default, deserialize_with = "nullable_u32")]
    pub sliding_window: u32,

    // ── Position embeddings ──
    #[serde(default)]
    pub max_position_embeddings: usize,
    #[serde(default = "default_rope_theta")]
    pub rope_theta: f64,

    // ── Normalization ──
    #[serde(default = "default_rms_eps")]
    pub rms_norm_eps: f64,

    // ── Tokenizer ──
    /// BOS token ID (null → 0 for models without explicit BOS).
    #[serde(default, deserialize_with = "nullable_u32")]
    pub bos_token_id: u32,
    /// Which dtype ladder GLM-5.3's MoE router runs in. See [`Glm5NextRouterMode`] — this is a
    /// semantic switch, and `HfFp32` is the production default.
    #[serde(default)]
    pub glm5next_router_mode: Glm5NextRouterMode,
    /// The PRIMARY stop token. See [`ModelConfig::eos_ids`] for the complete set — a config may
    /// declare several, and this holds only the first.
    #[serde(default, deserialize_with = "eos_token_id_field")]
    pub eos_token_id: u32,
    /// The COMPLETE stop-token set. HF configs are allowed to declare `eos_token_id` as an
    /// array, and several real checkpoints do — GLM-5.3-Flash declares three:
    /// `154820 <|endoftext|>`, `154827 <|user|>`, `154829 <|observation|>`. `eos_token_id`
    /// above holds only the PRIMARY one (element 0), which is what every scalar consumer and
    /// every chat template wants; collapsing to it and discarding the rest is what made an
    /// agent model unable to stop on its own turn terminators.
    ///
    /// Populated by `parse_config` for every model family from the raw JSON, scalar or array.
    /// Empty means "not populated" (a hand-built `ModelConfig`), NOT "no stop tokens" — read it
    /// through [`ModelConfig::eos_ids`], never directly.
    #[serde(default)]
    pub eos_token_ids: Vec<u32>,
    #[serde(default)]
    pub tie_word_embeddings: bool,
    /// CLI override (`--lm-head-dtype`) for LM-head quantization, set at serve time
    /// (not from config.json). `Some(true)` = force BF16 lm_head; `Some(false)` = force
    /// the model's quantized lm_head; `None` = use the model-config-driven default.
    /// Consumed by `skip_lm_head_quantization()`. Replaces the AVAROK_LMHEAD_BF16 env var.
    #[serde(default)]
    pub lm_head_bf16_override: Option<bool>,
    /// When `skip_lm_head_quantization()` == false, quantize the LM head to FP8
    /// (E4M3, per-row scales, decoded via `w8a16_gemv`) instead of NVFP4.
    /// Set by `--lm-head-dtype fp8`. Additive: leaves the NVFP4/BF16 paths
    /// byte-identical when false.
    #[serde(default)]
    pub lm_head_fp8: bool,

    // ── Model type ──
    #[serde(default)]
    pub model_type: String,

    // ── MTP ──
    #[serde(default)]
    pub mtp_num_hidden_layers: usize,

    // ── DSpark ──
    /// Number of query positions generated by one semi-autoregressive draft pass.
    /// Zero means the checkpoint does not declare checkpoint-native DSpark.
    #[serde(default)]
    pub dspark_block_size: usize,
    /// Token used to initialize the non-anchor positions in a DSpark block.
    #[serde(default)]
    pub dspark_noise_token_id: u32,
    /// Target layers whose hidden states are concatenated for the DSpark input.
    #[serde(default)]
    pub dspark_target_layer_ids: Vec<usize>,
    /// Width of the low-rank Markov token transition head.
    #[serde(default)]
    pub dspark_markov_rank: usize,

    // ── Nemotron-H / Mamba-2 ──
    #[serde(default)]
    pub hybrid_override_pattern: String,
    #[serde(default)]
    pub mamba_num_heads: usize,
    #[serde(default)]
    pub mamba_head_dim: usize,
    #[serde(default)]
    pub ssm_state_size: usize,
    #[serde(default)]
    pub n_groups: usize,
    #[serde(default)]
    pub expand: usize,
    /// Nemotron-H uses `n_routed_experts` (mapped to `num_experts` in parse_config).
    #[serde(default)]
    pub n_routed_experts: usize,
    /// Nemotron-H uses `norm_eps` (mapped to `rms_norm_eps` in parse_config).
    #[serde(default)]
    pub norm_eps: f64,
    /// Nemotron-H conv kernel size (mapped to `linear_conv_kernel_dim` in parse_config).
    #[serde(default)]
    pub conv_kernel: usize,
    /// Nemotron-H shared expert intermediate (mapped to shared_expert_intermediate_size).
    #[serde(default)]
    pub moe_shared_expert_intermediate_size: usize,
    /// Nemotron-H routed scaling factor for expert outputs.
    #[serde(default = "default_one_f64")]
    pub routed_scaling_factor: f64,
    /// KDA forget-gate lower bound (`linear_attn_config.gate_lower_bound`). GLM-5.3 declares
    /// -5.0; it bounds the log-decay `kda_gate` produces, so a defaulted 0.0 would clamp the
    /// decay to a completely different range. Read by the `glm5_next` parser, never guessed.
    /// K3 production JSON also supplies -5.0. The 0.40B twin omits the key: leave 0.0 and
    /// map to FLA unbounded (`None`) in `kda_from`.
    #[serde(default)]
    pub linear_gate_lower_bound: f32,
    /// SwiGLU clamp bound (`swiglu_limit`). 0.0 = the model does not clamp.
    ///
    /// 🔴 GLM-5.3-Flash declares `swiglu_limit = 10.0`, and the clamp is **asymmetric**:
    /// `gate` is upper-bounded only, `up` is bounded both ways. Read, never defaulted for a
    /// model that declares it — a missing clamp is invisible on well-scaled activations and
    /// silently wrong on the tails (see `kernels/gb10/common/glm5next_ffn.cu`).
    #[serde(default)]
    pub swiglu_limit: f32,
    /// Decoder-layer indices that use a dense MLP instead of routed experts.
    #[serde(default)]
    pub mlp_only_layers: Vec<usize>,
    /// LatentMoE: latent projection dimension for routed experts (Super 120B).
    /// When present, routed experts operate in latent space `[moe_latent_size]`
    /// instead of full `[hidden_size]`. Absent for Nano 30B.
    #[serde(default)]
    pub moe_latent_size: usize,
    /// Per-layer MoE intermediate sizes (Nemotron-H Puzzle heterogeneous channel
    /// pruning). Length == `num_hidden_layers`; 0 for non-MoE layers. Empty =
    /// fall back to scalar `moe_intermediate_size` for every MoE layer.
    #[serde(default, skip_deserializing, skip_serializing)]
    pub moe_intermediate_sizes: Vec<usize>,
    /// Per-layer top-K expert counts (Puzzle). Same layout as
    /// `moe_intermediate_sizes`. Empty = use scalar `num_experts_per_tok`.
    #[serde(default, skip_deserializing, skip_serializing)]
    pub num_experts_per_toks: Vec<usize>,

    // ── MLA (Multi-head Latent Attention) — Mistral Small 4 / DeepSeek-V2+ ──
    /// KV latent dimension for compressed cache. 0 = standard attention (no MLA).
    #[serde(default)]
    pub kv_lora_rank: usize,
    /// Per-layer KV cache dimensions (num_kv_heads, head_dim). Populated by
    /// loaders for heterogeneous-attention models (e.g. Gemma-4 with sliding
    /// and full attention having different head counts and dims). Empty for
    /// homogeneous models.
    #[serde(default, skip_deserializing, skip_serializing)]
    pub kv_layer_dims: Vec<(usize, usize)>,
    /// Query latent dimension for low-rank Q projection. 0 = standard Q.
    #[serde(default)]
    pub q_lora_rank: usize,
    /// Non-rotary portion of Q/K per head (NoPE component).
    #[serde(default)]
    pub qk_nope_head_dim: usize,
    /// Rotary portion of Q/K per head (RoPE component).
    #[serde(default)]
    pub qk_rope_head_dim: usize,
    /// Value dimension per head (may differ from head_dim in MLA).
    #[serde(default)]
    pub v_head_dim: usize,

    // ── N-gram embeddings — LongCat-Flash-Lite / Qwen3.8-Flash-Next ──
    // (arxiv 2601.21204: capacity via hashed n-gram lookup tables instead of
    // more experts.) `emb_split_num * (emb_neighbor_num - 1)` embedding
    // tables, each ~`ngram_vocab_size_ratio * vocab_size` rows at
    // `hidden_size / num_tables` dims; ids are a polynomial rolling hash of
    // the current + previous n-1 TOKEN IDS (never hidden states), each
    // looked-up vector is projected to hidden and ADDED to the base token
    // embedding, and the sum is scaled by 1/(1 + num_tables). Reference:
    // bench/ngram_ref/{modeling_longcat_ngram.py, ngram_parity.py}.
    /// N-gram table size multiplier: each table has ~ratio*vocab_size rows
    /// (LongCat-Lite: 78 → ~10.2M rows/table). 0 = no n-gram embeddings.
    #[serde(default)]
    pub ngram_vocab_size_ratio: usize,
    /// Largest n-gram size N (LongCat-Lite: 4 → bigram/trigram/4-gram).
    #[serde(default)]
    pub emb_neighbor_num: usize,
    /// Independent hash splits K per n-gram size (LongCat-Lite: 4).
    #[serde(default)]
    pub emb_split_num: usize,
    /// Rows per n-gram HEAD, absolute (`ngram_vocab_size_base`).
    ///
    /// The Qwen4-Exp form of the same idea LongCat expresses as a ratio:
    /// LongCat says "ratio x vocab_size rows per table", Qwen says
    /// "20,000,000 rows per head" outright. Mutually exclusive with
    /// `ngram_vocab_size_ratio` — whichever the checkpoint declares wins,
    /// and the authoritative per-head sizes/offsets ship as I64 tensors
    /// (`ngram_heads_vocab_sizes` / `ngram_heads_offsets`) which the loader
    /// reads rather than re-deriving. 0 = not a base-form checkpoint.
    #[serde(default)]
    pub ngram_vocab_size_base: usize,
    /// Physical shard count of the n-gram table (`split_ngram_parts`).
    ///
    /// PURELY a file-layout fact, NOT an architectural one: Qwen4-Exp stores
    /// one logical `[sum(head_vocabs), ngram_dim]` table as 128 equal
    /// `shard_N.weight` tensors. The head ranges are independent of the
    /// shard boundaries and a head can straddle several shards, so the row
    /// cache must address the logical table and translate. 0 = unsharded.
    #[serde(default)]
    pub ngram_split_parts: usize,
    /// Decoder layers that carry a PLE (per-layer-embedding) n-gram
    /// injection (`ple_layer_ids`). Qwen4-Exp injects at ONE layer, not at
    /// the token embedding the way LongCat does — which is why this is a
    /// layer list and not a flag. Empty = no PLE.
    #[serde(default)]
    pub ple_layer_ids: Vec<usize>,
    /// Depthwise conv width inside the PLE block (`ple_conv_kernel_size`).
    /// 0 = no conv.
    #[serde(default)]
    pub ple_conv_kernel_size: usize,

    // ── DeepSeek-V4 low-rank / grouped output projection + mHC ──
    /// Output projection latent dimension for low-rank O projection.
    /// DeepSeek-V4 uses `o_lora_rank` to compress the output projection.
    /// 0 = standard O (no low-rank compression).
    #[serde(default)]
    pub o_lora_rank: usize,
    /// Number of block-diagonal groups for the grouped O projection (wo_a).
    /// DeepSeek-V4-Flash splits the n_heads*head_dim attention output into
    /// `o_groups` independent groups, each projected to `o_lora_rank` before the
    /// follow-up wo_b mixes the `o_groups*o_lora_rank` vector back to hidden_size.
    /// 0 = ungrouped (dense O).
    #[serde(default)]
    pub o_groups: usize,
    /// YaRN attention-temperature `mscale` (`rope_scaling.mscale`). HF default
    /// is 1.0 when absent. DeepSeek folds `_mscale` into the rope cos/sin.
    #[serde(default)]
    pub yarn_mscale: f32,
    /// YaRN attention-temperature `mscale_all_dim` (`rope_scaling.mscale_all_dim`).
    /// HF default is 0.0 when absent. Used in the `_mscale` ratio that scales
    /// the rope cos/sin (and, when non-zero, the softmax scale).
    #[serde(default)]
    pub yarn_mscale_all_dim: f32,
    /// Number of hyper-connection residual streams per block (`hc_mult`).
    /// 0 = disabled (every model except DeepSeek-V4). DeepSeek-V4 uses 4.
    #[serde(default)]
    pub hc_mult: usize,
    /// Number of Sinkhorn normalization iterations for the HC mixing matrix
    /// (`hc_sinkhorn_iters`). DeepSeek-V4 default is 20.
    #[serde(default)]
    pub hc_sinkhorn_iters: usize,
    /// Numerical-stability epsilon for HC sigmoid/softmax/Sinkhorn (`hc_eps`).
    /// DeepSeek-V4 default is 1e-6.
    #[serde(default)]
    pub hc_eps: f32,
    /// Rank of the hyper-connection input mixer (`hc_lowrank`).
    ///
    /// Qwen4-Exp mixes the `hc_mult` residual streams through a LOW-RANK
    /// pair — `input_mix_weight_down [r, hc_mult*hidden]` then
    /// `input_mix_weight_up [hc_mult*hidden, r]` — where DeepSeek-V4 uses a
    /// Sinkhorn-normalized square matrix. The two share `hc_mult` and the
    /// stream-major layout but NOT the mixing math, so a non-zero value here
    /// selects the low-rank variant. 0 = DeepSeek-V4's Sinkhorn form.
    #[serde(default)]
    pub hc_lowrank: usize,
    /// The checkpoint carries NO final normalization before `lm_head`: the
    /// real one is applied inside the hyper-connection mixer while the
    /// residual streams collapse. Applying the engine's ones-placeholder RMS
    /// anyway still DIVIDES the hidden by its per-token RMS, which flattens
    /// the logits by a per-token factor (measured 1.16-1.63x vs the reference
    /// forward on qwen4_exp) -- an uninvited temperature multiplier that
    /// argmax survives but sampling does not. When set, the final-norm step
    /// becomes an identity copy.
    #[serde(default)]
    pub final_norm_identity: bool,
    /// Per-layer compression ratios for hybrid attention (CSA/HCA).
    /// 0 = full attention, >0 = compressed attention with that ratio.
    /// Length equals num_hidden_layers. Empty = all layers full attention.
    #[serde(default)]
    pub compress_ratios: Vec<usize>,
    /// Number of semantic-indexer heads used by DeepSeek-V4 CSA layers.
    #[serde(default)]
    pub index_n_heads: usize,
    /// Per-head dimension of the DeepSeek-V4 semantic indexer.
    #[serde(default)]
    pub index_head_dim: usize,
    /// Maximum compressed-history rows selected per query by the semantic indexer.
    #[serde(default)]
    pub index_topk: usize,
    /// Indexer compression ratio, recorded WITHOUT populating
    /// `compress_ratios`.
    ///
    /// Qwen3.8-Flash-Next's QSA indexer is inert below its budget — selection
    /// is `topk(min(budget/ratio, complete_blocks))`, so at
    /// `seq_len <= index_topk` every block is chosen and dense attention is
    /// exact. Keeping `compress_ratios` empty stops DeepSeek-V4's compressor
    /// being dispatched in its place; keeping the ratio here lets a loader
    /// refuse above the budget instead of silently attending densely.
    /// 0 = no indexer.
    #[serde(default)]
    pub index_compress_ratio: usize,
    /// GLM-5.3 DSA: tokens per k-pool (`index_kpool`). The pool budget is
    /// `index_topk / index_kpool`, so this is not cosmetic — it sets how many
    /// candidates the top-k actually ranks. 0 = model has no k-pooling.
    #[serde(default)]
    pub index_kpool: usize,
    /// GLM-5.3 DSA: always append the trailing partial pool's tokens to the
    /// selection, widening the emitted index row by `index_kpool - 1`.
    #[serde(default)]
    pub index_kpool_always_select_tail: bool,
    /// Number of hash-based attention layers (DeepSeek-V4 HCA). 0 = none.
    #[serde(default)]
    pub num_hash_layers: usize,

    // ── DeepSeek-V4.1: shared compressed attention ──
    /// RoPE base used by the compressor, distinct from `rope_theta`
    /// (`deepseek41.attention.compress_rope_freq_base`). 0.0 = not set.
    #[serde(default)]
    pub compress_rope_theta: f32,
    /// Layers that PRODUCE the compressed KV consumed by every other layer.
    /// V4.1 ships `[2, 8, 14, 20]`: four producers for forty blocks, which is
    /// why its KV cache is ~2.25 KiB/token at FP8 rather than per-layer.
    /// Empty = every layer produces its own KV (V4 behaviour).
    #[serde(default)]
    pub kv_source_layer_ids: Vec<usize>,
    /// Layers that PRODUCE indexer keys, shared the same way
    /// (`[2, 8, 14, 20, 24, 28, 32, 36]` on V4.1). Empty = per-layer.
    #[serde(default)]
    pub index_source_layer_ids: Vec<usize>,
    /// Layer whose output drives the candidate prefilter. `None` = no
    /// prefilter. V4.1 uses layer 20.
    #[serde(default)]
    pub candidate_source_layer_id: Option<usize>,
    /// Candidate prefilter: blocks kept by the top-k. 0 = no prefilter.
    #[serde(default)]
    pub candidate_topk_blocks: usize,
    /// Candidate prefilter: tokens per block. 0 = no prefilter.
    #[serde(default)]
    pub candidate_block_size: usize,

    // ── DeepSeek-V4.1: engram ──
    /// Blocks carrying an engram hash table. V4.1 ships `[1, 14]`.
    /// Empty = no engram (V4 has none at all).
    #[serde(default)]
    pub engram_layer_ids: Vec<usize>,
    /// Rows in each engram table, one entry per `engram_layer_ids` entry.
    /// V4.1: `[384006168, 384016682]` — 768M rows total, ~60 GiB at Q2_K.
    /// These tables CANNOT be resident and are the reason the model needs a
    /// row cache rather than a load.
    #[serde(default)]
    pub engram_num_embeddings: Vec<u64>,
    /// Longest n-gram hashed into the table (V4.1: 4).
    #[serde(default)]
    pub engram_max_ngram_size: usize,
    /// Logical vocab the hash is taken over, BEFORE compression (V4.1: 16000000).
    #[serde(default)]
    pub engram_vocab_size: usize,
    /// Engram attention heads (V4.1: 8).
    #[serde(default)]
    pub engram_n_heads: usize,
    /// Per-head engram dimension (V4.1: 256). A resident row is
    /// `engram_head_dim` BF16 values = 512 B, against 84 B on disk at Q2_K.
    #[serde(default)]
    pub engram_head_dim: usize,
    /// Pad id used by the engram hash (V4.1: 2). Distinct from the tokenizer's.
    #[serde(default)]
    pub engram_pad_token_id: u32,
    /// Compressed vocab the token_map projects into (V4.1: 99092).
    #[serde(default)]
    pub engram_compressed_vocab_size: usize,
    /// Engram hash multipliers (V4.1: 8 values).
    #[serde(default)]
    pub engram_multipliers: Vec<u64>,
    /// Engram hash primes (V4.1: 48 values).
    #[serde(default)]
    pub engram_primes: Vec<u64>,
    /// Engram per-slot table offsets (V4.1: 48 values).
    #[serde(default)]
    pub engram_offsets: Vec<u64>,

    // ── YaRN RoPE scaling (Mistral Small 4) ──
    /// YaRN scaling factor (`yarn.factor`). 0.0 = YaRN disabled, use plain RoPE.
    #[serde(default)]
    pub yarn_factor: f32,
    /// YaRN low-rotation cutoff (`yarn.alpha` in Mistral params,
    /// `beta_slow` in HF transformers terminology).
    #[serde(default)]
    pub yarn_beta_slow: f32,
    /// YaRN high-rotation cutoff (`yarn.beta` in Mistral params,
    /// `beta_fast` in HF transformers terminology).
    #[serde(default)]
    pub yarn_beta_fast: f32,
    /// YaRN original context length used for the correction range
    /// (`yarn.original_max_position_embeddings`).
    #[serde(default)]
    pub yarn_original_max_position_embeddings: usize,
    /// Multiplier applied to both YaRN cosine and sine values. 1.0 means no
    /// attention-temperature scaling.
    #[serde(default = "default_one_f32")]
    pub yarn_attention_factor: f32,
    /// llama_4_scaling Q temperature beta (`llama_4_scaling.beta`).
    /// Q is multiplied by `1 + beta * log(1 + floor(pos / original_max_pos))`
    /// after RoPE. 0.0 = disabled. Mistral Small 4 uses 0.1.
    #[serde(default)]
    pub llama_4_scaling_beta: f32,
    /// llama_4_scaling original context length for the Q temperature scale.
    #[serde(default)]
    pub llama_4_scaling_original_max_position_embeddings: usize,

    // ── Vision (Qwen3-VL only) ──
    /// Vision encoder configuration parsed from `vision_config` in config.json.
    /// None for text-only models.
    #[serde(skip)]
    pub vision: Option<VisionConfig>,

    /// Advertised quantization format + algorithm + per-module ignore list.
    /// Populated from `config.json::quantization_config` or a sibling
    /// `hf_quant_config.json` at `parse_config` time. `None` for
    /// un-quantized BF16/FP16 checkpoints. Consumed by the `QuantFormat`
    /// dispatcher (`crates/spark-model/src/quant_format/`) to pick the
    /// correct on-disk loader without guessing from tensor names.
    #[serde(skip)]
    pub quantization_config: Option<QuantizationConfig>,

    // ── Architecture flags (set by parse_config, not from JSON) ──
    /// Whether Q projection includes an output gate (Q+Gate interleaved, 2x q_dim).
    /// False for Qwen3-VL, Nemotron-H, Mistral (ungated Q).
    #[serde(skip)]
    pub attn_gated: bool,
    /// The GDN gated-norm's gate activation is SIGMOID rather than SiLU.
    ///
    /// The reference constructs its `RMSNormGated` with
    /// `activation = output_gate_type or hidden_act`, so on a checkpoint
    /// with `output_gate_type: "sigmoid"` (Qwen3.8-Flash-Next) BOTH the
    /// attention output gate and the GDN norm gate are sigmoid. Every other
    /// Qwen-family GDN model gates with SiLU. Found by the qwen4_exp phase-E
    /// bisect: recurrence proven correct, norm stage off at cos 0.81, and
    /// sigmoid closed it to 0.0.
    #[serde(default)]
    pub gdn_norm_sigmoid: bool,
    /// Whether config.json wraps the LLM config in a nested field (e.g., `text_config`).
    /// Determines weight prefix auto-detection behavior.
    #[serde(skip)]
    pub nested_config: bool,
    /// MRoPE (multi-modal rotary position embedding) section sizes in
    /// `[T, H, W]` order. `[0, 0, 0]` = scalar RoPE (default for Qwen3.5
    /// and earlier). Qwen3.6 uses `[11, 11, 10]`. Summed × 2 == rotary_dim.
    #[serde(skip)]
    pub mrope_section: [usize; 3],
    /// MRoPE channel layout: `true` = round-robin `[T H W T H W …]` (Qwen3.6),
    /// `false` = contiguous `[T…T | H…H | W…W]` (Qwen3-VL non-interleaved).
    /// Ignored when `mrope_section == [0, 0, 0]`.
    #[serde(skip)]
    pub mrope_interleaved: bool,

    // ── Weight key prefix (set by parser for conditional generation models) ──
    #[serde(skip)]
    pub weight_prefix: String,

    /// `--profile`: skip CUDA graphs, sync and time each layer.
    ///
    /// Carried here rather than through `AVAROK_PROFILE`, which `serve.rs` used
    /// to `set_var` at runtime under a `// SAFETY: called before any threads
    /// are spawned` comment that was **already false** — the tokio pool, the
    /// startup blocking thread, the signal listener, the TUI thread and the
    /// OOM watchdog all exist by then, and a concurrent `getenv` during
    /// `setenv` is UB. A field on the config the model already receives has
    /// none of that hazard.
    #[serde(skip)]
    pub profile: bool,

    // ── Expert Parallelism (set at runtime, not from config.json) ──
    #[serde(skip)]
    pub ep_rank: usize,
    #[serde(skip)]
    pub ep_world_size: usize,

    // ── Tensor Parallelism (set at runtime, not from config.json) ──
    /// TP rank within the TP sub-communicator. 0 if `tp_world_size==1`.
    #[serde(skip)]
    pub tp_rank: usize,
    /// Number of TP ranks. 1 = no TP. Composes with EP statically:
    /// attention/MLP weights are TP-sharded; MoE expert weights are EP-sharded.
    #[serde(skip)]
    pub tp_world_size: usize,

    // ── Served context (set at runtime from `--max-seq-len`) ──
    /// The serve's `--max-seq-len`. 0 when nobody set it (a unit test, an offline tool),
    /// which every reader must treat as "unknown" and fall back from — never as zero
    /// context. Distinct from `max_position_embeddings`, which is the checkpoint's claim
    /// (1,048,576 on GLM-5.3) rather than what this process reserved memory for.
    #[serde(skip)]
    pub serve_max_seq_len: usize,

    // ── FP8 KV cache calibration (set at runtime from CLI) ──
    /// Number of warmup tokens for online FP8 KV scale calibration.
    /// 0 = disabled (use static scales from checkpoint or uncalibrated 1.0).
    #[serde(skip)]
    pub fp8_kv_calibration_tokens: usize,
    /// Headroom multiplier on the first-observe absmax when freezing the online
    /// FP8 KV scale (`--fp8-kv-headroom`, default 2.0). The first observe sees
    /// only the first prefill chunk, so the frozen scale covers headroom× its
    /// observed max — later tokens that grow don't clip, at <1 bit of precision.
    #[serde(skip)]
    pub fp8_kv_headroom: f32,

    // ── Gemma-4 specific ──
    /// Final logit softcapping: logits = cap * tanh(logits / cap).
    /// 0.0 = disabled (default for all models except Gemma-4 which uses 30.0).
    #[serde(skip)]
    pub final_logit_softcapping: f32,
    /// Embedding scale factor: embeddings *= scale after lookup.
    /// 0.0 = disabled (default). Gemma models use sqrt(hidden_size).
    #[serde(skip)]
    pub embed_scale: f32,

    // ── MiniMax M2 specific ──
    /// MoE routing activation. "" = default softmax. "sigmoid" = DeepSeek-V3
    /// / MiniMax-M2 style: raw gate logits pass through sigmoid to produce
    /// per-expert scores in (0,1), independent (not normalized across
    /// experts). Top-k selection may use a bias term (see `moe_routing_bias`).
    #[serde(default)]
    pub scoring_func: String,
    /// If true, a per-expert `e_score_correction_bias` tensor is added to
    /// routing scores *for top-k selection only* (not dispatch weighting).
    /// This is the DeepSeek-V3 loss-free balancing trick. The bias tensor
    /// itself lives in the checkpoint (typically one `[num_experts]` vector
    /// per MoE layer).
    #[serde(default)]
    pub use_routing_bias: bool,
    /// QK normalization granularity. "" = none (Qwen3-Next default).
    /// "per_layer" = each attention layer has its own learned q_layernorm /
    /// k_layernorm weight of shape `[head_dim]`, applied after Q/K projection
    /// and before RoPE (MiniMax M2).
    #[serde(default)]
    pub qk_norm_type: String,
    /// Number of sequential MTP draft modules. 0 = no MTP. 1 = existing
    /// Atlas MTP path (Qwen3.5). 3 = MiniMax M2 (each module is a single
    /// transformer layer that predicts one future token).
    #[serde(default)]
    pub num_mtp_modules: usize,
    /// Transformer layers per MTP module. 1 for MiniMax M2 (3 modules × 1
    /// layer = 3 future-token predictors).
    #[serde(default)]
    pub mtp_transformer_layers: usize,
    /// Explicit rotary dimension from config (bypasses partial_rotary_factor
    /// computation). MiniMax M2 ships `rotary_dim: 64` while head_dim=128,
    /// so the rotary factor is 0.5 — we honor the explicit int value when
    /// present for byte-exact rope dim.
    #[serde(default)]
    pub rotary_dim: usize,

    /// Target-model layer indices to capture intermediate hidden states from
    /// for DFlash speculative decoding. Sourced from the drafter's
    /// `dflash_config.target_layer_ids` (e.g., `[1, 10, 19, 28, 37]` for
    /// Qwen3.6-35B-A3B-DFlash). Empty when DFlash is disabled — its presence
    /// gates `TransformerModel::dflash_hidden_save` allocation and the
    /// per-layer capture hooks. Order matters: shallow-to-deep concatenation
    /// is what the drafter's `fc` projection expects.
    #[serde(default)]
    pub dflash_capture_layers: Vec<usize>,
    /// Resolved DFlash drafter γ (block size), set by the factory alongside
    /// `dflash_capture_layers`. Sizes the SSM verify intermediate pools at
    /// the ACTUAL K = γ+1 instead of the legacy 17-wide ceiling — at γ=8,
    /// C=8 that ceiling alone cost ~12 GB of pool (2026-08-19 256K/C8 boot
    /// ledger). `None` = DFlash inactive (or unknown → 17-wide fallback).
    pub dflash_gamma: Option<usize>,

    /// LoRA adapter rank ceiling (`--max-lora-rank`). `0` = LoRA disabled.
    /// Set programmatically before model build (never parsed from the HF
    /// `config.json`); the only consumer is `BufferSizes`, which sizes the
    /// adapter delta scratch from it. `adapter_*` naming avoids the MLA
    /// `*lora_rank` collision (`config.rs:182-207`).
    #[serde(default)]
    pub adapter_max_rank: usize,

    // ── Kimi K3 (KDA + gated MLA + AttnRes + Stable LatentMoE) ──
    /// AttnRes residual-mix block size (`attn_res_block_size`). 0 = no AttnRes.
    #[serde(default)]
    pub attn_res_block_size: usize,
    /// KDA full-rank output gate (`linear_attn_config.use_full_rank_gate`).
    #[serde(default)]
    pub use_full_rank_gate: bool,
    /// MLA NoPE (`mla_use_nope`).
    #[serde(default)]
    pub mla_use_nope: bool,
    /// MLA output gate (`mla_use_output_gate`).
    #[serde(default)]
    pub mla_use_output_gate: bool,
    /// LatentMoE RMS after the routed down-project (`latent_moe_use_norm`).
    #[serde(default)]
    pub latent_moe_use_norm: bool,
    /// HF `hidden_act` (K3 production: `situ`). Empty = family default.
    #[serde(default)]
    pub hidden_act: String,
    /// SiTU-GLU β (`activation_situ_beta`). 0.0 = unused.
    #[serde(default)]
    pub activation_situ_beta: f32,
    /// SiTU-GLU linear β (`activation_situ_linear_beta`). 0.0 = unused.
    #[serde(default)]
    pub activation_situ_linear_beta: f32,
    /// Shared-expert count (`num_shared_experts` / `n_shared_experts`).
    #[serde(default)]
    pub n_shared_experts: usize,
}

/// Advertised weight-quantization layout, as declared in the HF
/// `config.json`'s `quantization_config` block (or a sibling
/// `hf_quant_config.json`). This is the authoritative signal for
/// format dispatch — the `QuantFormat` trait prefers this over
/// tensor-name sniffing, matching the dispatch model used by vLLM /
/// TensorRT-LLM / SGLang.
///
/// `quant_method` is the serialization scheme:
///   * `"compressed-tensors"` — Neural Magic / llm-compressor. Uses
///     `weight_packed` + `weight_global_scale` + `input_global_scale`.
///     Commonly paired with `format = "nvfp4-pack-quantized"` or
///     `"float-quantized"`.
///   * `"modelopt"` — NVIDIA TensorRT ModelOpt. Uses `weight` (as the
///     packed FP4 payload when `quant_algo == "NVFP4"`) + `weight_scale`
///     + `weight_scale_2` + `input_scale`.
///   * `"fp8"` — native FP8 block-scaled (e.g. `Qwen/Qwen3.5-35B-A3B-FP8`)
///     with `weight_scale_inv` sibling tensors.
///
/// `ignore_modules` holds the already-expanded list of module-path
/// patterns that should be loaded as dense BF16 rather than quantized.
/// Patterns use HF glob semantics (`*` matches any non-`.` sub-path).
#[derive(Debug, Clone)]
pub struct QuantizationConfig {
    /// Raw `quant_method` string from the config. Stable values:
    /// `"compressed-tensors"`, `"modelopt"`, `"fp8"`.
    pub quant_method: String,
    /// ModelOpt-specific algorithm label: `"NVFP4"`, `"FP8"`, …
    /// Empty string for schemes that don't declare one (e.g. plain FP8).
    pub quant_algo: String,
    /// Optional `format` string (compressed-tensors uses this for
    /// `"nvfp4-pack-quantized"` and friends).
    pub format: String,
    /// Module-path globs that should stay BF16 (the "ignore list" in
    /// ModelOpt terminology; `targets`/`exclude_modules` in compressed-
    /// tensors). Example entries: `"lm_head"`,
    /// `"model.layers.*.self_attn*"`.
    pub ignore_modules: Vec<String>,
}

/// Is GLM-5.3's vision tower enabled for this process?
///
/// **Default OFF.** Binding the tower is a MEMORY decision, not a correctness
/// one: it is 1.05 GiB per rank, and the measurement that lived in
/// `Glm5NextWeightLoader::binds_vision_encoder` says K=3 at 32 K needs
/// 13.58 GiB against 12.07 GiB free — the tower is exactly the difference
/// between `--speculative --num-drafts 2` fitting and not. The certified
/// text recipe must keep the footprint it was certified with, so images are
/// something an operator asks for, never something a port turns on for them.
///
/// THREE sites read this and they must agree, which is why it is one function:
/// the config parser (so `config.vision` stays `None` and an image request is
/// refused at the API edge with the existing "no vision config" error), the
/// loader's `binds_vision_encoder` (so the checkpoint loader withholds
/// `model.visual.*` instead of uploading it), and `load_vision_encoder` via
/// `config.vision`. Off, every one of them behaves exactly as it did before
/// the tower was ported.
pub fn glm_vision_enabled() -> bool {
    glm_vision_enabled_from(std::env::var("AVAROK_GLM_VISION").ok().as_deref())
}

/// The policy half of [`glm_vision_enabled`], split out so both states are
/// testable — setting an environment variable is `unsafe` in this edition and
/// a test that did it would race every other test in the binary.
///
/// Only an explicit affirmative enables. Anything else — unset, empty, `0`,
/// `off`, a typo — leaves the tower off, because the failure mode of guessing
/// wrong in that direction is an OOM on a certified serve.
pub fn glm_vision_enabled_from(value: Option<&str>) -> bool {
    matches!(
        value.map(|v| v.trim().to_ascii_lowercase()).as_deref(),
        Some("1" | "true" | "yes" | "on")
    )
}

#[cfg(test)]
mod glm_vision_gate_tests {
    use super::glm_vision_enabled_from;

    /// Off is the default, and "off" has to cover every way an operator can
    /// fail to say yes — the cost of reading a typo as "on" is a 1.05 GiB/rank
    /// allocation on a serve that was certified without it.
    #[test]
    fn only_an_explicit_affirmative_enables_the_tower() {
        for off in [
            None,
            Some(""),
            Some("0"),
            Some("off"),
            Some("false"),
            Some("no"),
            Some("yes please"),
        ] {
            assert!(!glm_vision_enabled_from(off), "{off:?} must not enable");
        }
        for on in ["1", "true", "TRUE", "Yes", " on "] {
            assert!(glm_vision_enabled_from(Some(on)), "{on:?} must enable");
        }
    }
}

/// Vision encoder configuration for Qwen3-VL models.
#[derive(Debug, Clone)]
pub struct VisionConfig {
    /// Number of ViT transformer blocks (depth=27).
    pub depth: usize,
    /// ViT hidden dimension (1152).
    pub hidden_size: usize,
    /// Number of attention heads (16).
    pub num_heads: usize,
    /// Spatial patch size in pixels (16).
    pub patch_size: usize,
    /// Temporal patch size: still images are replicated this many times (2).
    pub temporal_patch_size: usize,
    /// 2×2 spatial merge: this many patch-lengths merged into one token (2).
    pub spatial_merge_size: usize,
    /// ViT MLP intermediate size (4304).
    pub intermediate_size: usize,
    /// Projection output dimension = LLM hidden_size (2048).
    pub out_hidden_size: usize,
    /// Layer indices after which deepstack mergers are applied ([8, 16, 24]).
    pub deepstack_visual_indexes: Vec<usize>,
    /// Placeholder token ID that marks where vision embeddings get spliced
    /// into the text embedding stream. Qwen3-VL uses 151655; Qwen3.6 uses
    /// 248056. When 0 the runtime falls back to the legacy Qwen3-VL value.
    pub image_pad_token_id: u32,
    /// Placeholder token ID for VIDEO frames, the temporal sibling of
    /// [`Self::image_pad_token_id`]. Qwen3.6/3.8 use 248057. A distinct token
    /// is what lets the position builder tell a video item from an image one
    /// in the token stream, which matters because their MRoPE treatment
    /// differs: an image holds T constant across its whole pad run, a video
    /// advances T once per temporal group. When 0 the runtime falls back to
    /// the family default.
    pub video_pad_token_id: u32,
    /// Resolved vision AREA bound in pixels: the operator's
    /// `--vision-max-pixels`, else the checkpoint's `preprocessor_config.json`,
    /// else `None`.
    ///
    /// ★ THE SINGLE SOURCE OF TRUTH, and it exists because there used to be
    /// two. The CPU preprocessor clamped every image to 1280px on the long
    /// side while the GPU encoder allocated its buffers for 6400 patches —
    /// exactly 1280×1280 — with nothing in the code connecting them. They
    /// agreed only by coincidence, so raising one on 2026-08-14 made every
    /// image above 1280px fail an H2D copy with `CUDA_ERROR_INVALID_VALUE`
    /// from deep inside the scheduler.
    ///
    /// Both now derive from this field, resolved once at config load, before
    /// the encoder is constructed. `None` keeps the historical behaviour on
    /// both sides.
    pub max_pixels: Option<usize>,

    // ── Fields below exist because GLM-5.3's tower needs them. Every one has
    // a default that reproduces the Qwen3-VL behaviour exactly, so a Qwen
    // checkpoint that declares none of them is unaffected. ──
    /// Block-MLP activation. `"silu"` for GLM (a clamped SwiGLU);
    /// `"gelu_pytorch_tanh"` for the Qwen family's 2-matrix GELU MLP.
    pub hidden_act: String,
    /// Epsilon of every RMSNorm in the tower (GLM: 1e-5). Unused by the
    /// Qwen tower, whose norms are LayerNorms at a compiled 1e-6.
    pub rms_norm_eps: f32,
    /// Whether the ViT's `qkv`/`proj`/MLP Linears carry biases (GLM: true).
    pub attention_bias: bool,
    /// Hidden width of GLM's merger SwiGLU (10240). 0 when the family has no
    /// such stage.
    pub projection_intermediate_size: usize,
    /// Symmetric clamp applied inside GLM's SwiGLU, on both the block MLP and
    /// the merger (10.0). 0 disables it.
    pub swiglu_limit: f32,
    /// Base of the ViT's own rotary embedding. GLM's `vision_config` carries
    /// `rope_parameters = {rope_theta: 10000.0, rope_type: "axial"}`.
    pub rope_theta: f32,
    /// Per-channel normalization the image processor applies. GLM ships
    /// CLIP-style stats; the Qwen family ships SigLIP's 0.5/0.5/0.5, which is
    /// the default here so an absent `preprocessor_config.json` is unchanged.
    pub image_mean: [f32; 3],
    pub image_std: [f32; 3],
    /// Dynamic-resolution token budget (`processor_config.json`). GLM states
    /// its bound in MERGED tokens (16 / 8000) rather than as a pixel area;
    /// `min_pixels/max_pixels = tokens * (patch_size * merge_size)^2`.
    pub min_image_tokens: usize,
    pub max_image_tokens: usize,
    /// Patch tokens are emitted in 2x2-block-major order rather than raster.
    ///
    /// GLM's image processor and its `get_vision_position_ids` share this
    /// nesting, which is the ONLY reason the tower's `view(-1, 2, 2, C)`
    /// downsample reshape is free. A raster-ordered buffer through the same
    /// tower produces a perfectly plausible, wrong embedding — so the order is
    /// a declared property of the checkpoint, not an implementation detail of
    /// whoever writes the loop.
    pub block_major_patches: bool,
}

impl Default for VisionConfig {
    fn default() -> Self {
        Self {
            depth: 0,
            hidden_size: 0,
            num_heads: 0,
            patch_size: 0,
            temporal_patch_size: 0,
            spatial_merge_size: 0,
            intermediate_size: 0,
            out_hidden_size: 0,
            deepstack_visual_indexes: Vec::new(),
            image_pad_token_id: 0,
            video_pad_token_id: 0,
            max_pixels: None,
            hidden_act: "gelu_pytorch_tanh".to_string(),
            rms_norm_eps: 1e-6,
            attention_bias: true,
            projection_intermediate_size: 0,
            swiglu_limit: 0.0,
            rope_theta: 10_000.0,
            image_mean: [0.5, 0.5, 0.5],
            image_std: [0.5, 0.5, 0.5],
            min_image_tokens: 0,
            max_image_tokens: 0,
            block_major_patches: false,
        }
    }
}

impl VisionConfig {
    /// Dimension of the merger input (spatial_merge_size² × hidden_size).
    pub fn merger_input_size(&self) -> usize {
        self.spatial_merge_size * self.spatial_merge_size * self.hidden_size
    }
}

pub(crate) fn default_one() -> usize {
    1
}
pub(crate) fn default_one_f64() -> f64 {
    1.0
}
pub(crate) fn default_one_f32() -> f32 {
    1.0
}
pub(crate) fn default_rope_theta() -> f64 {
    10000.0
}
pub(crate) fn default_rms_eps() -> f64 {
    1e-6
}
pub(crate) fn default_partial_rotary() -> f64 {
    1.0
}
pub(crate) fn default_conv_kernel() -> usize {
    4
}

mod dispatch;
mod factory;
mod gguf;
mod kv_completeness;
#[cfg(test)]
mod kv_completeness_tests;
mod methods;
mod parsers;
#[cfg(test)]
mod tests;

pub use dispatch::parse_config;
pub use gguf::{GgufConfigInputs, GgufMeta, config_from_gguf};
pub use parsers::{
    PEFT_SUPPORTED_TARGET_MODULES, PeftAdapterConfig, allow_partial_targets,
    glm5_next_mtp_layer_index, parse_mistral_params, parse_peft_adapter_config,
    parse_quantization_config,
};
pub(crate) use parsers::{
    parse_deepseek_v4, parse_gemma4_params, parse_glm5_next, parse_kimi_k3, parse_laguna,
    parse_longcat_ngram, parse_minimax_m2, parse_qwen4_exp, parse_step3p7, parse_vision_config,
    sanitize_kimi_k3_eos,
};

pub(crate) fn finalize_config(config: &mut ModelConfig, raw: &serde_json::Value) -> Result<()> {
    if config.quantization_config.is_none() {
        config.quantization_config = parse_quantization_config(raw);
    }
    validate_config(config)
}

/// Post-parse validation for ModelConfig.
/// Checks layer_types length matches num_hidden_layers and SSM field consistency.
pub(crate) fn validate_config(config: &ModelConfig) -> Result<()> {
    if !config.layer_types.is_empty() && config.layer_types.len() != config.num_hidden_layers {
        anyhow::bail!(
            "layer_types length ({}) doesn't match num_hidden_layers ({}) in config.json",
            config.layer_types.len(),
            config.num_hidden_layers,
        );
    }

    if !config.num_attention_heads_per_layer.is_empty()
        && config.num_attention_heads_per_layer.len() != config.num_hidden_layers
    {
        anyhow::bail!(
            "num_attention_heads_per_layer length ({}) doesn't match num_hidden_layers ({}) in config.json",
            config.num_attention_heads_per_layer.len(),
            config.num_hidden_layers,
        );
    }

    let has_ssm =
        config.layer_types.contains(&LayerType::LinearAttention) || config.linear_num_key_heads > 0;
    if has_ssm && config.linear_num_key_heads == 0 && config.mamba_num_heads == 0 {
        anyhow::bail!(
            "SSM model detected but linear_num_key_heads is 0 in config.json. \
             This field is required for SSM/GDN layer initialization."
        );
    }

    if config.mamba_num_heads > 0 {
        if config.mamba_head_dim == 0 {
            anyhow::bail!("mamba_head_dim must be greater than zero");
        }
        if config.ssm_state_size == 0 {
            anyhow::bail!("ssm_state_size must be greater than zero");
        }
        if config.n_groups == 0 {
            anyhow::bail!("n_groups must be greater than zero");
        }
        if !config.mamba2_d_inner().is_multiple_of(config.n_groups) {
            anyhow::bail!("mamba_num_heads * mamba_head_dim must be divisible by n_groups");
        }
    }

    Ok(())
}