gam_models/multinomial.rs
1//! Penalized multinomial-logit (softmax) GLM driver — fixed-λ inner solve.
2//!
3//! This is the principled vector-response companion to the scalar PIRLS path:
4//! the inner-loop Newton solver for a multi-class GAM at fixed smoothing
5//! parameters λ, using the canonical multinomial-logit likelihood
6//! ([`MultinomialLogitLikelihood`]) and the existing dense block-Fisher
7//! assembly in [`gam_solve::pirls::dense_block_xtwx`] /
8//! [`gam_solve::pirls::dense_block_xtwy`].
9//!
10//! # What this module does
11//!
12//! Solve, for the reference-coded multinomial-logit GAM with `K` classes and
13//! design matrix `X ∈ ℝ^{N×P}`,
14//!
15//! ```text
16//! β̂ = argmin_β { − log L(β) + ½ Σ_{a=0}^{K-2} λ_a · β_a^T S β_a }
17//! ```
18//!
19//! where `β = [β_0; β_1; …; β_{K-2}]` is the stacked coefficient vector in
20//! output-major order (`β_a ∈ ℝ^P` is the coefficient block for class `a`),
21//! `S ∈ ℝ^{P×P}` is the smoothing penalty matrix (shared across classes,
22//! replicated as `I_{K-1} ⊗ S` over the full parameter space), and `λ_a` is
23//! a per-class smoothing parameter.
24//!
25//! The likelihood uses class `K - 1` as the reference (`η_{K-1} ≡ 0`), so the
26//! softmax gauge is fixed at the η level and no additional sum-to-zero
27//! projection is required.
28//!
29//! # Layering
30//!
31//! * **Fixed-λ inner solve** — [`fit_penalized_multinomial`] is the canonical
32//! coefficient-space Newton solver at *given* smoothing parameters `λ`,
33//! built on the shared [`crate::penalized_vector_glm`] engine.
34//!
35//! * **REML / LAML smoothing-parameter selection** — [`fit_penalized_multinomial_formula`]
36//! routes through [`crate::custom_family::fit_custom_family_with_rho_prior`]
37//! so the per-active-class `λ_a` are selected by the outer REML/LAML loop;
38//! the caller's `init_lambda` is only a warm-start seed. The multinomial
39//! [`crate::multinomial_reml::MultinomialFamily`] `CustomFamily`
40//! impl calls the fixed-λ math above as its inner solve at each ρ trial and
41//! supplies the dense per-row Hessian block for the outer trace terms.
42//!
43//! * **Formula → design integration** — `build_formula_design_for_multinomial`
44//! parses the Wilkinson formula and assembles `X` and the per-term `S`
45//! blocks; the `fit_multinomial_formula_pyfunc` FFI shim wires the Python
46//! `gamfit.fit(..., family='multinomial')` entry straight to this path.
47//!
48//! # Convergence
49//!
50//! The damped-Newton-with-backtracking scaffold lives once in the shared
51//! [`crate::penalized_vector_glm`] engine: at each iteration the
52//! assembled penalized Hessian `H + I_{K-1} ⊗ (λ_a S)` is factored via faer's
53//! symmetric-PD-with-fallback path, the full Newton step `δ = −H^{-1} ∇F` is
54//! computed, and accepted with step halving if the objective fails to decrease
55//! (up to a small backtracking budget). The convergence test is the relative
56//! coefficient step norm `‖δ‖ / (1 + ‖β‖) ≤ tol`, matching the existing pyffi
57//! reference path. This module is the softmax adapter over that engine: it
58//! supplies the dense `(K-1)×(K-1)` Fisher block, the residual, and the
59//! log-likelihood through [`MultinomialLogitLikelihood`], and owns the
60//! class-count / simplex preconditions. The independent-binomial sibling
61//! [`crate::binomial_multi`] is the same engine with a row-diagonal
62//! Fisher block instead.
63
64use crate::custom_family::{
65 BlockwiseFitOptions, ParameterBlockState, PenaltyMatrix, fit_custom_family_with_rho_prior,
66};
67use crate::multinomial_reml::MultinomialFamily;
68use crate::penalized_vector_glm::{PenalizedVectorGlmInputs, fit_penalized_vector_glm};
69use crate::vector_response::{MultinomialLogitLikelihood, validate_multinomial_simplex};
70use gam_terms::inference::formula_dsl::parse_formula;
71use crate::model_types::EstimationError;
72use crate::fit_orchestration::{
73 FitConfig, build_termspec_with_geometry_and_overrides, resolved_resource_policy,
74};
75use gam_terms::smooth::{
76 PenaltyBlockInfo, TermCollectionDesign, TermCollectionSpec, build_term_collection_design,
77};
78use crate::fit_orchestration::drivers::freeze_term_collection_from_design;
79use gam_terms::term_builder::resolve_role_col;
80use gam_problem::ResponseColumnKind;
81use gam_data::ColumnKindTag;
82use gam_data::EncodedDataset;
83use gam_runtime::resource::ProblemHints;
84use ndarray::{Array1, Array2, ArrayView1, ArrayView2, ArrayView3};
85use serde::{Deserialize, Serialize};
86use std::sync::Arc;
87
88/// Solver-only numerical stabilization floor for the formula-driven
89/// multinomial REML inner solve (gam#747).
90///
91/// Installed with [`RidgePolicy::solver_only`](gam_problem::RidgePolicy::solver_only)
92/// so it stabilizes the inner joint-Newton **linear solve** but never enters
93/// the REML objective, the penalty log-determinant, or the Laplace Hessian.
94///
95/// What it does: the multinomial smoothing penalties are rank-deficient by
96/// design (each smooth carries an unpenalized polynomial null space) and the
97/// formula may add a fully unpenalized parametric term (`x3` / `body_mass`). On
98/// near-separable hard labels the softmax curvature is ill-conditioned along
99/// those directions, so the bare Newton step `H⁻¹∇` is huge. Lifting the
100/// smallest Hessian eigenvalue to `δ` bounds the step (`‖(H+δI)⁻¹∇‖ ≤ ‖∇‖/δ`),
101/// keeping the screening iterates finite without poisoning the softmax with
102/// `inf − inf = NaN`.
103///
104/// What it deliberately does NOT do: it adds no `½·δ·‖β‖²` term to the
105/// objective and no `δ`-shift to the REML log-determinant. The earlier
106/// `explicit_stabilization_pospart` policy folded both into the criterion,
107/// which made `1e-4` a fixed-λ Gaussian prior that shrank every identified
108/// coefficient off the MLE and biased smoothing-parameter selection — a value
109/// that had to be tuned *between* under-stabilization (NaN seeds) and
110/// over-shrinkage (lost VGAM match). As a solver-only floor that tradeoff is
111/// gone: the over-shrinkage failure mode cannot occur (nothing is shrunk), the
112/// optimized objective is the true penalized REML criterion, and the floor
113/// only has to be large enough to keep the linear algebra finite.
114///
115/// The separation defect (#753) is no longer this floor's job. If the
116/// multinomial MLE is genuinely at infinity for an unpenalized/null-space
117/// direction (complete/quasi-complete separation), no solver floor makes that
118/// direction's estimate finite. The formula REML path arms the full-span
119/// Jeffreys/Firth correction CONDITIONALLY — only on separation evidence (see
120/// [`multinomial_formula_separation_evidence`] and the two-attempt logic in
121/// [`fit_penalized_multinomial_formula`]) — so an interior, well-identified fit
122/// optimizes the unbiased penalized-REML criterion with no Firth shrinkage
123/// toward the uniform simplex, while a (quasi-)separated geometry gets the
124/// proper prior that is the only thing able to bound its penalty-null
125/// directions (#715 real-data arm). The bare fixed-λ inner driver
126/// [`fit_penalized_multinomial`] (no outer REML, no Jeffreys term) surfaces the
127/// explicit `MultinomialSeparationDetected` diagnostic for the path that has no
128/// proper prior to lean on.
129const MULTINOMIAL_FORMULA_RIDGE_FLOOR: f64 = 1.0e-4;
130
131/// Inner joint-Newton KKT tolerance for the multinomial formula path.
132///
133/// The softmax Fisher weight `W = diag(p) − ppᵀ` collapses on saturated rows,
134/// so near-separable fits (penguins, #715) reach the OBJECTIVE's f64 noise
135/// floor before the default `inner_tol = 1e-6` KKT target: measured on the
136/// penguins arm (standardized columns), the trust region collapses to 1e-12
137/// with per-attempt objective changes of ~+2e-9 on |obj| ≈ 1e2 (≈ 1e-11
138/// relative — pure rounding) while the KKT residual plateaus at 2.8e-5–9.4e-5
139/// against a scaled tolerance of ~1.9e-5. Demanding a residual below the
140/// floating-point noise floor is certifiable-never: every eval is rejected by
141/// the stall guard and the whole fit fails. `1e-5` certifies the measured
142/// plateaus while still resolving β to ~1e-6 in the relevant metric — the
143/// LAML criterion consumes β̂ with error O(residual²/curvature), far below
144/// any quantity the outer ρ-search can read.
145const MULTINOMIAL_FORMULA_INNER_TOL: f64 = 1.0e-5;
146
147/// Formula-adapter penalty calibration for multinomial softmax REML.
148///
149/// The term builder's normalized penalties are calibrated on single-response
150/// Gaussian-style score curvature. A reference-coded softmax class block sees
151/// per-row active-class Fisher diagonal `p_a(1-p_a)` plus negative cross-class
152/// coupling. At the neutral simplex (`p_k = 1/K`) the active diagonal is
153/// `(K-1)/K²`, so the binary-logit calibration is `2·(K-1)/K² = 1/2` and the
154/// three-class calibration is `4/9` rather than the historical hard-coded
155/// `1/2`. Making the scale a function of `K` keeps the physical smoothness
156/// prior tied to the likelihood curvature instead of over-penalizing every
157/// class as the simplex gains categories.
158fn multinomial_formula_penalty_scale(n_classes: usize) -> f64 {
159 let k = n_classes.max(2) as f64;
160 2.0 * (k - 1.0) / (k * k)
161}
162
163/// Largest smoothing-parameter dimension where exact dense outer curvature is
164/// still worth paying for multinomial formula fits.
165///
166/// `D = (K - 1) * n_penalties`. Medium-size loaded models use exact curvature
167/// so the optimizer does not wander into over-smoothed lambda caps on
168/// near-boundary softmax surfaces. The threshold was originally calibrated at
169/// `D <= 6` when each `s()` term carried ONE penalty; the double-penalty
170/// migration (wiggliness + null-space shrinkage per term, mgcv `select=TRUE`
171/// semantics) doubled `D` for the SAME models, silently flipping the
172/// reference formula fits (2 smooths, K = 3: old `D = 4`, now `D = 8`) onto
173/// the gradient-only route — where the #715 quality arm showed every
174/// wiggliness ρ driven onto the ±10 box bound (smooths collapsed toward their
175/// polynomial null space, truth-RMSE behind VGAM). `12 = 2 × 6` preserves the
176/// original classification boundary under the doubled penalty count while
177/// keeping the four-smooth penguin species quality fixture on the exact ARC
178/// path: that model is `D = 16`, and first-order BFGS can cycle along the
179/// near-separable lambda-to-zero ridge until the wall-clock budget expires
180/// (#1082). ARC observes the same exact curvature and can halt through the
181/// bound-aware cost-stall guard once the REML surface stops making useful
182/// progress.
183const MULTINOMIAL_EXACT_OUTER_HESSIAN_MAX_DIM: usize = 16;
184
185fn multinomial_formula_use_outer_hessian(total_rho_dim: usize) -> bool {
186 total_rho_dim <= MULTINOMIAL_EXACT_OUTER_HESSIAN_MAX_DIM
187}
188
189/// Logit magnitude beyond which fitted probabilities are saturated at ordinary
190/// double precision diagnostic scale. The bare fixed-λ driver has no outer REML
191/// state and still uses this threshold to reject a non-converged saturated
192/// iterate as a separation artifact. The formula REML path does not use this as
193/// a Firth trigger: with smoothing parameters selected, a finite saturated
194/// surface can be the valid near-separated optimum that should be scored
195/// directly.
196const MULTINOMIAL_SEPARATION_ETA_THRESHOLD: f64 = 25.0;
197
198/// Calibrated convergence tolerance for the OUTER REML/LAML smoothing-parameter
199/// search on the formula multinomial path. Matches the primary GLM REML outer
200/// (`solver::fit_orchestration::materialize` uses `tol = 1e-7`, mirrored by the
201/// `LOG_LAMBDA_TOL` / `KKT_TOL_*` constants across the REML stack): tight enough
202/// that the selected λ reaches the genuine REML optimum (the recovered
203/// probability surface matches the mature reference), loose enough that the
204/// optimizer does not grind surface-irrelevant ρ digits down to the inner KKT
205/// scale (the #1082 wall-clock overrun). The caller's `tol` is floored at this
206/// value for the OUTER loop, while it continues to drive the INNER joint-Newton
207/// KKT target unchanged.
208const MULTINOMIAL_OUTER_REML_TOL: f64 = 1e-7;
209
210/// The first multinomial formula solve is a separation probe: it is accepted
211/// when the unbiased REML criterion converges to a finite interior iterate.
212/// Near-separable data such as the penguin fixture otherwise spend the caller's
213/// full outer budget on an iterate that is discarded before the Firth/Jeffreys
214/// refit. Keep enough iterations for ordinary interior fits to certify quickly,
215/// but hand slow/non-interior probes to the proper-prior refit promptly.
216const MULTINOMIAL_UNBIASED_PROBE_OUTER_MAX_ITER: usize = 20;
217
218/// Per-observation softmax Fisher-information scale for the λ-floor units.
219///
220/// The penalty enters the criterion as `½ λ βᵀ S β` with a Frobenius-normalized
221/// `S` (`‖S‖_F = 1`, see the term-builder calibration referenced by
222/// [`multinomial_formula_penalty_scale`]), so the ridge `λ S` is directly
223/// comparable to data Fisher information. One observation contributes softmax
224/// information `p(1−p)` in a class's logit direction, which is bounded by the
225/// logistic peak `p(1−p) ≤ ¼` at `p = ½`. Using this maximal per-observation
226/// information as the unit makes the floor's strength interpretable as a count
227/// of equivalent **pseudo-observations** of prior: a ridge that equals
228/// `τ · ¼ · ‖S‖_F` carries the same logit-direction curvature as `τ` real rows
229/// sitting at the most-informative point of the likelihood. This scale is
230/// `K`-independent on purpose — the `K`-dependence of the softmax block
231/// curvature already lives in the penalty matrix via
232/// [`multinomial_formula_penalty_scale`], so the floor (a bound on the
233/// multiplier of that already-scaled penalty) must not double-count it.
234const MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS: f64 = 0.25;
235
236/// Target prior strength of the λ-floor, in pseudo-observations, for a
237/// WELL-SUPPORTED class. The floor holds the unbiased REML optimizer off the
238/// zero-penalty boundary (where a boundary-overfit smooth or a Firth switch on
239/// finite data would otherwise be accepted) with a prior worth a fixed small
240/// fraction of one observation. `8e-4` pseudo-observations reproduces the
241/// previously fixture-calibrated large-support floor `τ · ¼ = 2e-4` exactly at
242/// the calibration point, now expressed as an effective-prior-strength rather
243/// than a tuned λ value.
244const MULTINOMIAL_FORMULA_PRIOR_PSEUDO_OBS: f64 = 8.0e-4;
245
246/// Reference class support `n_ref`: the effective sample size per class at which
247/// the data Fisher information `n_c · I₁` is large enough that the floor sits at
248/// its well-supported value. Below `n_ref` the per-class data information shrinks
249/// like `n_c`, so to keep the floor's prior from vanishing *relative to* that
250/// shrinking data the effective pseudo-observation count is scaled up by
251/// `n_ref / n_c` (the prior is held to a fixed fraction of the data information,
252/// not a fixed absolute λ). At `n_c = n_ref` the scale is exactly 1.
253const MULTINOMIAL_FORMULA_SPARSE_REFERENCE_SUPPORT: f64 = 50.0;
254
255/// Cap on the floor's prior strength in the very-sparse limit, in
256/// pseudo-observations. As `n_c → 0` the `n_ref / n_c` scaling diverges; the cap
257/// holds the prior at `4e-3` pseudo-observations (`τ_max · ¼ = 1e-3` at the
258/// calibration point, the previously-tuned strong-floor value) so the floor
259/// stays a proper prior rather than a hard constraint that would dominate the
260/// likelihood for a handful-of-rows class.
261const MULTINOMIAL_FORMULA_SPARSE_PRIOR_PSEUDO_OBS_MAX: f64 = 4.0e-3;
262
263/// Continuous, Fisher-information-scaled lower λ floor for the formula path,
264/// derived from the minority class's effective sample size `n_c`.
265///
266/// # Derivation (effective-prior-strength / Fisher geometry)
267///
268/// The penalty `½ λ βᵀ S β` with `‖S‖_F = 1` adds curvature `λ` to the class
269/// logit direction; one observation adds at most `I₁ = ¼` there. So a floor that
270/// sets `λ_floor = τ_eff · I₁` gives the smooth a prior worth `τ_eff`
271/// pseudo-observations. We want a fixed *absolute* prior `τ` for a well-supported
272/// class, but for a minority class with only `n_c` effective observations the
273/// data information in its block is `n_c · I₁`; holding the prior to a fixed
274/// *fraction* of that shrinking data information requires
275///
276/// ```text
277/// τ_eff(n_c) = τ · max(1, n_ref / n_c), clamped to [τ, τ_max]
278/// λ_floor(n_c) = τ_eff(n_c) · I₁
279/// ```
280///
281/// This is the *same* `base · max(1, c0/c)` envelope as before — but `base`,
282/// `sparse`, and `c0` are no longer fixture-tuned magic numbers: `base = τ·I₁`,
283/// `sparse = τ_max·I₁`, and `c0 = n_ref` are an effective-prior-strength of
284/// `τ`/`τ_max` pseudo-observations against the maximal per-observation softmax
285/// information `I₁ = ¼`. Properties preserved by construction:
286/// * reduces EXACTLY to `τ·I₁` for well-supported classes (`n_c ≥ n_ref`);
287/// * reduces EXACTLY to `τ_max·I₁` for very sparse classes
288/// (`n_c ≤ n_ref·τ/τ_max`, here `n_c ≤ 10`);
289/// * interpolates monotonically and continuously between them in the middle —
290/// no cliff at `n_c = n_ref`.
291/// At the calibration point the endpoints equal the previous `2e-4` / `1e-3`, so
292/// fixtures whose smallest class has `n_c ≥ 50` (penguins, the vgam softmax
293/// arms) are unaffected — they sit at `τ·I₁ = 2e-4` exactly as before.
294fn multinomial_formula_min_lambda(y_one_hot: ArrayView2<'_, f64>) -> f64 {
295 let base = MULTINOMIAL_FORMULA_PRIOR_PSEUDO_OBS * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
296 let sparse =
297 MULTINOMIAL_FORMULA_SPARSE_PRIOR_PSEUDO_OBS_MAX * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
298 let min_class_count = (0..y_one_hot.ncols())
299 .map(|class| y_one_hot.column(class).sum())
300 .fold(f64::INFINITY, f64::min);
301 if !min_class_count.is_finite() || min_class_count <= 0.0 {
302 return base;
303 }
304 // Effective pseudo-observation prior strength: held to a fixed fraction of
305 // the shrinking per-class data information once n_c falls below n_ref.
306 let pseudo_obs_scale =
307 (MULTINOMIAL_FORMULA_SPARSE_REFERENCE_SUPPORT / min_class_count).max(1.0);
308 (base * pseudo_obs_scale).clamp(base, sparse)
309}
310
311fn max_abs_eta_location(eta: ArrayView2<'_, f64>) -> (f64, usize, usize) {
312 let mut best = (0.0_f64, 0usize, 0usize);
313 for ((row, active_class), &value) in eta.indexed_iter() {
314 let abs = value.abs();
315 if abs > best.0 {
316 best = (abs, row, active_class);
317 }
318 }
319 best
320}
321
322/// Separation gate for the REML/LAML **formula** path.
323///
324/// Unlike the bare fixed-λ driver [`fit_penalized_multinomial`] (which has no
325/// outer REML state and so must reject a saturated, non-converged iterate as a
326/// separation artifact at the [`MULTINOMIAL_SEPARATION_ETA_THRESHOLD`] logit
327/// magnitude), the formula path can return a finite saturated mode after the
328/// coupled outer optimizer has selected smoothing parameters. A `|η| >= 25`
329/// gate is therefore wrong here: the penguins arm can legitimately have large
330/// fitted logits while still producing finite probabilities and a usable REML
331/// mode.
332///
333/// Only a genuinely NON-FINITE `η` (a NaN/Inf blow-up in the inner linear
334/// algebra) is a real formula-path failure. A finite, even saturated, `η` is
335/// accepted so the truth-recovery / match-or-beat bars are evaluated against the
336/// actual fitted surface instead of an adapter diagnostic.
337fn multinomial_formula_separation_diagnostic(
338 inner_cycles: usize,
339 outer_iterations: usize,
340 block_states: &[ParameterBlockState],
341) -> Option<EstimationError> {
342 let mut nonfinite: Option<(f64, usize, usize)> = None;
343 for (active_class, state) in block_states.iter().enumerate() {
344 for (row, &value) in state.eta.iter().enumerate() {
345 if !value.is_finite() {
346 nonfinite = Some((value, row, active_class));
347 break;
348 }
349 }
350 if nonfinite.is_some() {
351 break;
352 }
353 }
354 nonfinite.map(|(value, row_index, active_class_index)| {
355 EstimationError::MultinomialSeparationDetected {
356 iteration: inner_cycles.max(outer_iterations),
357 max_abs_eta: value.abs(),
358 active_class_index,
359 row_index,
360 }
361 })
362}
363
364/// Separation EVIDENCE gate for the conditional Firth/Jeffreys engagement on
365/// the formula REML path (#715 / #753).
366///
367/// The structural mathematics (#715 issue thread): for any coefficient
368/// direction `v` with `S v = 0` (a penalty-null direction — intercept, a
369/// smooth's polynomial null component, an unpenalized parametric term), the
370/// penalized joint Hessian satisfies `(H + S_λ) v = H v` for EVERY smoothing
371/// parameter ρ. When the data (quasi-)separate, the softmax Fisher weight
372/// `W = diag(p) − p pᵀ → 0` on the saturated rows, so `H v = JᵀWJ v → 0` along
373/// the penalty-null directions those rows support: `(H + S_λ) v ≈ 0` for every
374/// ρ — NO λ can repair it, the inner Newton can never certify a KKT point
375/// there, and every outer REML startup seed is rejected (the penguins
376/// real-data arm). The only principled cure is a PROPER prior on that
377/// quotient-null subspace — the Jeffreys/Firth term `Φ = ½ log|ZᵀHZ|`, whose
378/// Gauss–Newton curvature supplies the missing `O(1)` bound.
379///
380/// But the Firth prior is not free on interior data: unconditionally armed, it
381/// shrinks fitted class probabilities toward the uniform simplex `1/K`
382/// (an `O(1/n)` pull that the synthetic match-or-beat arm of #715 measured as
383/// a real truth-RMSE loss vs the unbiased criterion). So the formula path
384/// engages it ONLY on separation evidence, mirroring the #753 "diagnose, then
385/// arm" split:
386///
387/// * a NON-FINITE logit — the inner linear algebra blew up along an unbounded
388/// direction.
389///
390/// Returns `Some(description)` naming the witnessing logit when evidence is
391/// found, `None` for a finite fit (which is then accepted as-is, with zero
392/// Firth bias). A FAILED unbiased solve (`Err` from the rho-prior driver, e.g.
393/// "no startup seed passed") is the second evidence form and is handled
394/// directly at the call site in [`fit_penalized_multinomial_formula`].
395fn multinomial_formula_separation_evidence(block_states: &[ParameterBlockState]) -> Option<String> {
396 for (active_class, state) in block_states.iter().enumerate() {
397 for (row, &value) in state.eta.iter().enumerate() {
398 if !value.is_finite() {
399 return Some(format!(
400 "non-finite logit eta[row {row}, active class {active_class}] = {value}"
401 ));
402 }
403 }
404 }
405 None
406}
407
408/// Extra evidence used only for a NON-CONVERGED capped unbiased probe.
409///
410/// A converged finite saturated formula fit is still a valid optimum and must be
411/// scored without Firth bias. A capped probe that failed to converge while it
412/// already carries separation-scale logits is different: spending the full
413/// unbiased outer budget on the same lambda-to-zero surface is the #1082
414/// timeout. Route that case straight to the proper-prior refit.
415fn multinomial_formula_unresolved_probe_separation_evidence(
416 block_states: &[ParameterBlockState],
417) -> Option<String> {
418 if let Some(evidence) = multinomial_formula_separation_evidence(block_states) {
419 return Some(evidence);
420 }
421
422 let mut best = (0.0_f64, 0usize, 0usize);
423 for (active_class, state) in block_states.iter().enumerate() {
424 for (row, &value) in state.eta.iter().enumerate() {
425 let abs = value.abs();
426 if abs > best.0 {
427 best = (abs, row, active_class);
428 }
429 }
430 }
431 if best.0 >= MULTINOMIAL_SEPARATION_ETA_THRESHOLD {
432 Some(format!(
433 "separation-scale finite logit |eta[row {}, active class {}]| = {:.3e} \
434 after capped unbiased probe",
435 best.1, best.2, best.0
436 ))
437 } else {
438 None
439 }
440}
441
442/// Inputs to [`fit_penalized_multinomial`].
443///
444/// The penalty matrix `S` is shared across classes; per-class smoothing
445/// parameters `lambdas` (length `K - 1`) scale `S` independently for each
446/// active class. The full block-replicated penalty is `diag_a(λ_a) ⊗ S`,
447/// which is exactly what [`gam_solve::arrow_schur::KroneckerPenaltyOp`]
448/// expresses in matrix-free form when this driver is later lifted into the
449/// arrow-Schur loop.
450#[derive(Debug, Clone)]
451pub struct MultinomialFitInputs<'a> {
452 /// Design matrix `X ∈ ℝ^{N×P}` (one row per observation).
453 pub design: ArrayView2<'a, f64>,
454 /// Categorical response `Y ∈ ℝ^{N×K}`. Each row must be a point on the
455 /// probability simplex (`y_c ≥ 0`, `Σ_c y_c = 1`): a one-hot indicator for
456 /// hard classification, or a label-smoothed probability vector. Rows whose
457 /// mass departs from 1 are rejected — the softmax residual gradient and
458 /// Fisher block are the derivatives of `Σ_c y_c log p_c` only under the
459 /// simplex constraint (see `validate_multinomial_simplex`).
460 pub y_one_hot: ArrayView2<'a, f64>,
461 /// Shared smoothing penalty `S ∈ ℝ^{P×P}` (symmetric, PSD).
462 pub penalty: ArrayView2<'a, f64>,
463 /// Per-active-class smoothing parameter `λ_a` (length `K - 1`).
464 pub lambdas: ArrayView1<'a, f64>,
465 /// Optional per-row weights (length `N`); `None` ⇒ uniform 1.0.
466 pub row_weights: Option<ArrayView1<'a, f64>>,
467 /// Optional per-row Fisher-block override, shape `(N, K-1, K-1)` in the
468 /// active-class gauge (the reference class `K-1` is dropped). When `Some`,
469 /// each Newton step uses this block as the curvature `W` in place of the
470 /// analytic softmax Fisher `w_n (δ_ab p_a − p_a p_b)`; the gradient/residual
471 /// path stays analytic, so this is a curvature-only override (the
472 /// research escape-hatch for latent multinomial fits, issue #349). Each
473 /// per-row block must be symmetric, PSD, and finite — preconditions the
474 /// FFI boundary discharges before constructing this view.
475 pub fisher_w_override: Option<ArrayView3<'a, f64>>,
476 /// Maximum Newton iterations; recommend 50.
477 pub max_iter: usize,
478 /// Relative-step convergence tolerance; recommend 1e-7.
479 pub tol: f64,
480}
481
482/// Outputs of [`fit_penalized_multinomial`].
483#[derive(Debug, Clone)]
484pub struct MultinomialFitOutputs {
485 /// Active-class coefficient block, shape `(P, K-1)` (column `a` is `β_a`).
486 /// The reference class `K - 1` has `β_{K-1} ≡ 0` by construction and is
487 /// not stored.
488 pub coefficients_active: Array2<f64>,
489 /// Fitted probabilities, shape `(N, K)`.
490 pub fitted_probabilities: Array2<f64>,
491 /// Number of Newton iterations executed (including the final step that
492 /// satisfied the tolerance).
493 pub iterations: usize,
494 /// `true` if the relative-step test was satisfied; `false` if the
495 /// solver exhausted `max_iter`. (A non-converged solve is still
496 /// returned; the caller decides whether to escalate.)
497 pub converged: bool,
498 /// Penalized negative log-likelihood at the returned `β̂`:
499 /// `−log L(β̂) + ½ Σ_a λ_a · β̂_a^T S β̂_a`.
500 pub penalized_neg_log_likelihood: f64,
501 /// Unpenalized deviance `−2 log L(β̂)` for diagnostic reporting.
502 pub deviance: f64,
503 /// Joint Laplace posterior coefficient covariance `H⁻¹` at the converged
504 /// `β̂`, shape `(P·(K−1))×(P·(K−1))` (#1101). Block-ordered to match the
505 /// stacked active-class coefficient vector `β = [β_0; …; β_{K-2}]`: active
506 /// class `a`'s `P` coefficients occupy rows/cols `a·P .. (a+1)·P`, indexed
507 /// `θ[a·P + i] = β̂[i, a]`. This is the Laplace covariance from the factored
508 /// penalized Hessian `XᵀWX + diag_a(λ_a)⊗S`; it drives the delta-method
509 /// per-class probability standard errors ([`Self::predict_probabilities_with_se`])
510 /// on the fixed-λ inner-solve path.
511 pub coefficient_covariance: Array2<f64>,
512}
513
514impl MultinomialFitOutputs {
515 /// Number of active classes `M = K − 1` (columns of
516 /// [`Self::coefficients_active`]).
517 pub fn n_active_classes(&self) -> usize {
518 self.coefficients_active.ncols()
519 }
520
521 /// Per-class coefficient dimension `P` (rows of
522 /// [`Self::coefficients_active`]).
523 pub fn p_per_class(&self) -> usize {
524 self.coefficients_active.nrows()
525 }
526
527 /// Evaluate `softmax(X·β̂)` AND its delta-method per-class probability
528 /// standard error at fresh design rows `X_new` (#1101), using the joint
529 /// Laplace covariance [`Self::coefficient_covariance`].
530 ///
531 /// The softmax Jacobian is `∂p_c/∂η_b = p_c (δ_{cb} − p_b)` for active class
532 /// `b ∈ 0..M`, and `∂η_b/∂β[i,a] = X[i]·δ_{ab}`, so the gradient of the
533 /// class-`c` probability w.r.t. the block-ordered coefficient vector is
534 /// `g_c[a·P + i] = X[i]·p_c (δ_{ca} − p_a)` (the reference class `M`
535 /// contributes only through `−p_a` in every active block). The delta-method
536 /// variance is `Var(p_c) = g_cᵀ Σ g_c` with `Σ = H⁻¹`, and
537 /// `SE(p_c) = √Var(p_c)`. Returns `(probs (N,K), prob_se (N,K))`. `X_new`
538 /// must have `P` columns (the same design basis used at fit time); its row
539 /// count sets `N`. The SE is unclamped (the interval consumer applies the
540 /// simplex `[0,1]` clamp).
541 pub fn predict_probabilities_with_se(
542 &self,
543 x_new: ArrayView2<'_, f64>,
544 ) -> Result<(Array2<f64>, Array2<f64>), EstimationError> {
545 let p = self.p_per_class();
546 let m = self.n_active_classes();
547 let k = m + 1;
548 if x_new.ncols() != p {
549 crate::bail_invalid_estim!(
550 "predict_probabilities_with_se: X has {} cols, expected P={p}",
551 x_new.ncols()
552 );
553 }
554 let d = p * m;
555 let cov = &self.coefficient_covariance;
556 if cov.dim() != (d, d) {
557 crate::bail_invalid_estim!(
558 "predict_probabilities_with_se: covariance shape {:?} ≠ (P·M, P·M) = ({d}, {d})",
559 cov.dim()
560 );
561 }
562 let n_new = x_new.nrows();
563 let beta = &self.coefficients_active;
564 let mut probs = Array2::<f64>::zeros((n_new, k));
565 let mut prob_se = Array2::<f64>::zeros((n_new, k));
566 let mut eta_active = vec![0.0_f64; m];
567 let mut row_probs = vec![0.0_f64; k];
568 let mut grad = vec![0.0_f64; d];
569 for row in 0..n_new {
570 for a in 0..m {
571 let mut v = 0.0_f64;
572 for i in 0..p {
573 v += x_new[[row, i]] * beta[[i, a]];
574 }
575 eta_active[a] = v;
576 }
577 MultinomialLogitLikelihood::softmax_with_baseline(&eta_active, &mut row_probs);
578 for c in 0..k {
579 probs[[row, c]] = row_probs[c];
580 }
581 for c in 0..k {
582 let pc = row_probs[c];
583 // g_c[a·P + i] = X[i] · p_c · (δ_{ca} − p_a), a active.
584 for a in 0..m {
585 let pa = row_probs[a];
586 let factor = pc * (if c == a { 1.0 - pa } else { -pa });
587 let base = a * p;
588 for i in 0..p {
589 grad[base + i] = x_new[[row, i]] * factor;
590 }
591 }
592 // Var = gᵀ Σ g.
593 let mut var = 0.0_f64;
594 for r in 0..d {
595 let gr = grad[r];
596 if gr == 0.0 {
597 continue;
598 }
599 let mut acc = 0.0_f64;
600 for s in 0..d {
601 acc += cov[[r, s]] * grad[s];
602 }
603 var += gr * acc;
604 }
605 prob_se[[row, c]] = var.max(0.0).sqrt();
606 }
607 }
608 Ok((probs, prob_se))
609 }
610}
611
612/// Fit a penalized multinomial-logit GAM at fixed `λ`.
613///
614/// See the module docs for the optimization problem and conventions. This
615/// function is the canonical inner solve: the outer REML/LAML loop, when
616/// added, calls this at each `ρ = log λ` trial.
617pub fn fit_penalized_multinomial(
618 inputs: MultinomialFitInputs<'_>,
619) -> Result<MultinomialFitOutputs, EstimationError> {
620 let MultinomialFitInputs {
621 design,
622 y_one_hot,
623 penalty,
624 lambdas,
625 row_weights,
626 fisher_w_override,
627 max_iter,
628 tol,
629 } = inputs;
630
631 // ──────────────────────── family-specific validation ───────────────────
632 // The shared engine re-validates the geometry common to every vector-GLM
633 // (nonempty design, penalty shape, λ finiteness/non-negativity, override
634 // `(N, M, M)` shape, finite design). The multinomial family owns the
635 // class-count contract (`K ≥ 2`, λ length `K − 1`), the per-row simplex
636 // precondition under which the softmax residual/Fisher are the exact
637 // derivatives of `Σ_c y_c log p_c`, and the row-weight check the likelihood
638 // adapter consumes.
639 let n_obs = design.nrows();
640 let (y_rows, k) = y_one_hot.dim();
641 if y_rows != n_obs {
642 crate::bail_invalid_estim!(
643 "fit_penalized_multinomial: y rows {y_rows} ≠ design rows {n_obs}"
644 );
645 }
646 if k < 2 {
647 crate::bail_invalid_estim!(
648 "fit_penalized_multinomial: need at least 2 classes (got K={k})"
649 );
650 }
651 let m = k - 1;
652 if lambdas.len() != m {
653 crate::bail_invalid_estim!(
654 "fit_penalized_multinomial: lambdas length {} ≠ K-1 = {m}",
655 lambdas.len()
656 );
657 }
658 if let Some(fw) = fisher_w_override.as_ref() {
659 if fw.dim() != (n_obs, m, m) {
660 crate::bail_invalid_estim!(
661 "fit_penalized_multinomial: fisher_w_override shape {:?} ≠ (N, K-1, K-1) = ({n_obs}, {m}, {m})",
662 fw.dim()
663 );
664 }
665 }
666 if let Some(w) = row_weights.as_ref() {
667 if w.len() != n_obs {
668 crate::bail_invalid_estim!(
669 "fit_penalized_multinomial: row_weights length {} ≠ N = {n_obs}",
670 w.len()
671 );
672 }
673 for (i, &v) in w.iter().enumerate() {
674 if !(v.is_finite() && v >= 0.0) {
675 crate::bail_invalid_estim!(
676 "fit_penalized_multinomial: row_weights[{i}] must be finite and ≥ 0 (got {v})"
677 );
678 }
679 }
680 }
681 validate_multinomial_simplex(y_one_hot, "fit_penalized_multinomial")?;
682
683 // ────────────────────────── likelihood construction ───────────────────
684 let mut likelihood = MultinomialLogitLikelihood::with_classes(k)?;
685 if let Some(w) = row_weights.as_ref() {
686 likelihood = likelihood.with_row_weights(w.to_owned())?;
687 }
688
689 // ─────────────────── shared penalized vector-GLM solve ─────────────────
690 // The softmax Fisher block is dense across the `M = K − 1` active classes;
691 // the engine assembles the coupled `(P·M)×(P·M)` penalized Hessian, runs
692 // the damped Newton loop, and returns the converged `β̂` and `η = X β̂`.
693 let fit = fit_penalized_vector_glm(
694 PenalizedVectorGlmInputs {
695 design,
696 y: y_one_hot,
697 penalty,
698 lambdas,
699 fisher_w_override,
700 max_iter,
701 tol,
702 // #1587: production multinomial still uses the per-class Diagonal
703 // metric pending the REML per-class→per-term λ re-key that the
704 // reference-symmetric Centered metric requires (shared λ). The
705 // Centered engine path + its invariance proof land first.
706 class_penalty_metric: crate::penalized_vector_glm::ClassPenaltyMetric::Diagonal,
707 },
708 &likelihood,
709 "fit_penalized_multinomial",
710 )?;
711
712 let (max_abs_eta, row_index, active_class_index) = max_abs_eta_location(fit.eta.view());
713 if !fit.converged && max_abs_eta >= MULTINOMIAL_SEPARATION_ETA_THRESHOLD {
714 return Err(EstimationError::MultinomialSeparationDetected {
715 iteration: fit.iterations,
716 max_abs_eta,
717 active_class_index,
718 row_index,
719 });
720 }
721
722 let fitted_probabilities = likelihood.probabilities(fit.eta.view());
723
724 Ok(MultinomialFitOutputs {
725 coefficients_active: fit.coefficients,
726 fitted_probabilities,
727 iterations: fit.iterations,
728 converged: fit.converged,
729 penalized_neg_log_likelihood: -fit.log_likelihood + fit.penalty_term,
730 deviance: -2.0 * fit.log_likelihood,
731 coefficient_covariance: fit.coefficient_covariance,
732 })
733}
734
735// ---------------------------------------------------------------------------
736// Formula-driven multinomial pipeline
737// ---------------------------------------------------------------------------
738//
739// Slice A of the multinomial integration: a single public entry that takes
740// a parsed `EncodedDataset`, a Wilkinson-style formula, and a uniform initial
741// smoothing parameter, then runs the full
742//
743// parse → termspec → design (X, S blocks) → one-hot Y → REML λ-selection
744//
745// pipeline. `fit_penalized_multinomial_formula` drives the outer REML/LAML
746// loop (via the custom-family path) to select an independent λ per (class,
747// term); `init_lambda` (default 1.0) is only the warm-start seed for every
748// block. The reference class is the last level of the categorical response
749// column as recorded in the dataset schema.
750
751/// Saved-model payload for a multinomial fit driven by a Wilkinson formula.
752///
753/// This is what the FFI returns to Python. It carries everything the Python
754/// `MultinomialModel.predict` path needs to evaluate `softmax(X_new · β)` on
755/// fresh data using the *training* basis / penalty structure (no refit on
756/// predict, no re-derivation of class levels).
757#[derive(Debug, Clone, Serialize, Deserialize)]
758pub struct MultinomialSavedModel {
759 /// The training formula, verbatim. Stored so Python's `summary()` and
760 /// any round-trip persistence path can echo what was fit.
761 pub formula: String,
762 /// Names of the *training* response levels in canonical order. The last
763 /// entry is the reference class (η = 0); the first `K - 1` carry the
764 /// active linear-predictor blocks. Class permutations are forbidden:
765 /// this list is fixed at fit time and predictions emit columns in the
766 /// same order.
767 pub class_levels: Vec<String>,
768 /// Index of the reference class within `class_levels` — currently always
769 /// `class_levels.len() - 1`, exposed as a field so future "user-pinned
770 /// reference" gauges (e.g. `family='multinomial', reference='setosa'`)
771 /// can land without changing the on-disk shape.
772 pub reference_class_index: usize,
773 /// Resolved term-collection spec used to build `X` at fit time. Replayed
774 /// on predict via [`gam_terms::smooth::build_term_collection_design`].
775 pub resolved_termspec: TermCollectionSpec,
776 /// Active-class coefficient block, shape `(P, K-1)`. Column `a` is the
777 /// coefficient vector for class `class_levels[a]`. Stored flat in
778 /// row-major order to keep the serde payload self-describing.
779 pub coefficients_flat: Vec<f64>,
780 /// `P` — coefficient count per active class. Matches the column count of
781 /// the design matrix the saved `resolved_termspec` produces.
782 pub p_per_class: usize,
783 /// Number of active classes (`K - 1`).
784 pub n_active_classes: usize,
785 /// Original training column headers, in dataset-column order. Needed at
786 /// predict time so the FFI can align a fresh `Dataset` to the training
787 /// schema before evaluating the basis.
788 pub training_headers: Vec<String>,
789 /// REML/LAML-selected smoothing parameters, one per `(active class, smooth
790 /// term)`, flattened in block-major order: all of class 0's per-term λ,
791 /// then class 1's, and so on. Per-term penalties (#561) mean each active
792 /// class block selects an *independent* λ for every smooth term, so this
793 /// vector has length `Σ_a (#terms in class a)` = `(K − 1) · #terms`. Use
794 /// [`MultinomialSavedModel::lambdas_per_block`] to segment it by class. An
795 /// unpenalized model (no smooth terms) yields an empty vector.
796 pub lambdas: Vec<f64>,
797 /// Number of smoothing parameters (smooth terms) in each active class
798 /// block, parallel to `class_levels[0..K-1]`. Segments the flat `lambdas`
799 /// vector: class `a`'s λ are `lambdas[Σ_{b<a} lambdas_per_block[b] ..][..
800 /// lambdas_per_block[a]]`. Every entry is identical in the shared-design
801 /// architecture (all classes share the same term structure), but it is
802 /// stored explicitly so consumers never have to assume that.
803 pub lambdas_per_block: Vec<usize>,
804 /// Newton iterations executed; recorded for the summary report.
805 pub iterations: usize,
806 /// `true` if the inner Newton solver hit the relative-step tolerance.
807 pub converged: bool,
808 /// Penalized negative log-likelihood at the returned `β̂`.
809 pub penalized_neg_log_likelihood: f64,
810 /// Unpenalized deviance `−2 log L(β̂)`.
811 pub deviance: f64,
812 /// Per-active-class effective degrees of freedom (hat-matrix trace),
813 /// length `K - 1`. Populated when the REML driver reports an
814 /// inference block; falls back to `None` for the legacy fixed-λ path.
815 #[serde(default)]
816 pub edf_per_class: Option<Vec<f64>>,
817 /// Per-PENALTY effective degrees of freedom, one entry per smoothing
818 /// parameter (length `== lambdas.len()`), aligned block-major with the flat
819 /// [`Self::lambdas`] / [`Self::lambdas_per_block`] layout. Each entry is the
820 /// penalty-block trace EDF `rank(S_k) − λ_k·tr(H⁻¹ S_k)`, clamped to
821 /// `[0, rank(S_k)]`. This is the per-(class, term, penalty) resolution that
822 /// the per-class [`Self::edf_per_class`] SUM deliberately hides: only the
823 /// per-penalty vector reveals whether an individual smooth collapsed onto its
824 /// polynomial null space (its wiggliness λ driven to the λ-cap), which a
825 /// per-class total cannot show. Populated whenever the REML driver reports an
826 /// inference block; `None` on the legacy fixed-λ path or when the trace
827 /// channel is mis-shaped. Unlike `edf_per_class`, the entries do NOT sum to
828 /// the model EDF when several penalties share one coefficient range (a
829 /// double-penalty smooth has `Σ_k rank(S_k) > p_per_class`).
830 #[serde(default)]
831 pub edf_per_penalty: Option<Vec<f64>>,
832 /// Joint posterior coefficient covariance `H⁻¹` (#1101), block-ordered to
833 /// match the stacked active-class coefficient vector `β = [β_0; …; β_{K-2}]`
834 /// (class `a`'s `P` coefficients occupy rows/cols `a·P .. (a+1)·P`). This is
835 /// the Laplace covariance the REML driver already computes from the factored
836 /// penalized Hessian; storing it gives the predict path delta-method
837 /// per-class probability standard errors and the summary its Wald
838 /// smooth-term tests. Flattened row-major over the `(P·M)×(P·M)` matrix.
839 /// `None` for a model fitted before covariance was surfaced.
840 #[serde(default)]
841 pub coefficient_covariance_flat: Option<Vec<f64>>,
842 /// Joint coefficient-space influence matrix `F = H⁻¹ X'WX` (#1101),
843 /// block-ordered identically to [`Self::coefficient_covariance_flat`].
844 /// Its per-term diagonal block trace is the term's effective degrees of
845 /// freedom and its `tr(F_jj)²/tr(F_jj²)` the Wood reference d.f., feeding
846 /// the rank-truncated Wald smooth-term test in `summary()`. Flattened
847 /// row-major over the `(P·M)×(P·M)` matrix. `None` when unavailable.
848 #[serde(default)]
849 pub coefficient_influence_flat: Option<Vec<f64>>,
850 /// Per-(active class, smooth term) coefficient column range and unpenalized
851 /// nullspace dimension within the `P`-wide class block (#1101). Parallel to
852 /// the smooth terms the design produced; replicated across classes by the
853 /// shared-design architecture. Drives the Wald smooth-term table in
854 /// `summary()`. Empty for a wholly parametric (no-smooth) model.
855 #[serde(default)]
856 pub smooth_term_spans: Vec<MultinomialSmoothTermSpan>,
857 /// One descriptive label per *penalty component* within a single active-class
858 /// block, parallel to that block's λ slice (i.e. length
859 /// `lambdas_per_block[0]`). The Marra–Wood double penalty (and tensor /
860 /// operator smooths) emit **more than one** penalty component — hence more
861 /// than one λ — per smooth term, so this is NOT 1:1 with
862 /// [`Self::smooth_term_spans`]: a single `s(x)` term contributes a primary
863 /// wiggliness λ labelled `s(x)` and a null-space shrinkage λ labelled
864 /// `s(x) [null space]`. The summary renderer pairs `lambdas` with these
865 /// labels component-for-component so no λ is ever dropped (#1544). Built from
866 /// the per-component term name + penalty role at fit time; empty for a
867 /// wholly parametric model or a model serialized before this field existed.
868 #[serde(default)]
869 pub lambda_labels: Vec<String>,
870}
871
872/// One smooth term's coefficient span within a class block, plus its
873/// unpenalized nullspace dimension and a display label (#1101). The Wald
874/// smooth-significance test in `summary()` slices the joint covariance /
875/// influence at `a·P + col_start .. a·P + col_end` for active class `a`.
876#[derive(Debug, Clone, Serialize, Deserialize)]
877pub struct MultinomialSmoothTermSpan {
878 /// Human-readable term label (the smooth's formula token), for the table.
879 pub label: String,
880 /// Start column of the term within the per-class `P`-wide coefficient block.
881 pub col_start: usize,
882 /// End column (exclusive) of the term within the per-class block.
883 pub col_end: usize,
884 /// Leading unpenalized (polynomial nullspace) dimension within the term.
885 pub nullspace_dim: usize,
886}
887
888/// Descriptive label for one penalty *component* (one λ) within a class block,
889/// for the `summary()` per-class λ rollup (#1544). A smooth term can emit
890/// several penalty components — the Marra–Wood double penalty splits `s(x)`
891/// into a primary wiggliness penalty and a null-space shrinkage penalty, and
892/// tensor / operator smooths emit a component per margin / differential
893/// operator — each with its own independently-selected λ. The label is the
894/// term name (from `PenaltyBlockInfo::termname`) plus a role suffix derived
895/// from the penalty's [`PenaltySource`], so each λ in the summary names both
896/// the term it smooths and the role it plays. `pen_idx` is the global penalty
897/// index, used only as a last-resort fallback label.
898fn penalty_component_label(info: Option<&PenaltyBlockInfo>, pen_idx: usize) -> String {
899 use gam_terms::basis::PenaltySource;
900 let term = info
901 .and_then(|i| i.termname.clone())
902 .unwrap_or_else(|| format!("s{pen_idx}"));
903 let role = match info.map(|i| &i.penalty.source) {
904 // The primary wiggliness penalty is the term's "main" λ; show the bare
905 // term name so the common single-penalty case reads cleanly.
906 Some(PenaltySource::Primary) | None => None,
907 Some(PenaltySource::DoublePenaltyNullspace) => Some("null space".to_string()),
908 Some(PenaltySource::OperatorMass) => Some("mass".to_string()),
909 Some(PenaltySource::OperatorTension) => Some("tension".to_string()),
910 Some(PenaltySource::OperatorStiffness) => Some("stiffness".to_string()),
911 Some(PenaltySource::OperatorRelevance { axis }) => Some(format!("axis {axis}")),
912 Some(PenaltySource::TensorMarginal { dim }) => Some(format!("margin {dim}")),
913 Some(PenaltySource::TensorSeparable { penalized_margins }) => {
914 Some(format!("separable {penalized_margins:?}"))
915 }
916 Some(PenaltySource::TensorGlobalRidge) => Some("ridge".to_string()),
917 Some(PenaltySource::Other(s)) => Some(s.clone()),
918 };
919 match role {
920 Some(role) => format!("{term} [{role}]"),
921 None => term,
922 }
923}
924
925impl MultinomialSavedModel {
926 /// Active-class coefficient block as an `(P, K-1)` `ndarray` view.
927 pub fn coefficients_active(&self) -> Array2<f64> {
928 Array2::from_shape_vec(
929 (self.p_per_class, self.n_active_classes),
930 self.coefficients_flat.clone(),
931 )
932 .expect(
933 "MultinomialSavedModel.coefficients_flat length must equal p_per_class * n_active_classes",
934 )
935 }
936
937 /// Evaluate `softmax(X · β)` at fresh data rows. `X_new` must have
938 /// `self.p_per_class` columns (i.e. it was built from the same
939 /// `resolved_termspec` as fit time). Returns an `(N_new, K)` matrix
940 /// with rows summing to 1; column order matches `self.class_levels`.
941 pub fn predict_probabilities(&self, x_new: ArrayView2<'_, f64>) -> Array2<f64> {
942 let n_new = x_new.nrows();
943 let p = self.p_per_class;
944 let m = self.n_active_classes;
945 let k = m + 1;
946 assert_eq!(
947 x_new.ncols(),
948 p,
949 "MultinomialSavedModel.predict_probabilities: X has {} cols, expected {p}",
950 x_new.ncols()
951 );
952 let beta = self.coefficients_active();
953 let mut probs = Array2::<f64>::zeros((n_new, k));
954 let mut eta_active = vec![0.0_f64; m];
955 let mut row_probs = vec![0.0_f64; k];
956 for row in 0..n_new {
957 for a in 0..m {
958 let mut v = 0.0_f64;
959 for i in 0..p {
960 v += x_new[[row, i]] * beta[[i, a]];
961 }
962 eta_active[a] = v;
963 }
964 MultinomialLogitLikelihood::softmax_with_baseline(&eta_active, &mut row_probs);
965 for c in 0..k {
966 probs[[row, c]] = row_probs[c];
967 }
968 }
969 probs
970 }
971
972 /// Reconstruct the joint posterior covariance `H⁻¹` as a `(P·M)×(P·M)`
973 /// `ndarray`, block-ordered to match the stacked coefficient vector
974 /// `θ[a·P + i] = β[i, a]` (#1101). `None` when the model was fitted before
975 /// covariance was surfaced (legacy payload).
976 pub fn coefficient_covariance(&self) -> Option<Array2<f64>> {
977 let d = self.p_per_class.checked_mul(self.n_active_classes)?;
978 let flat = self.coefficient_covariance_flat.as_ref()?;
979 Array2::from_shape_vec((d, d), flat.clone()).ok()
980 }
981
982 /// Reconstruct the joint influence matrix `F = H⁻¹ X'WX` as a
983 /// `(P·M)×(P·M)` `ndarray`, block-ordered like
984 /// [`Self::coefficient_covariance`] (#1101). `None` when unavailable.
985 pub fn coefficient_influence(&self) -> Option<Array2<f64>> {
986 let d = self.p_per_class.checked_mul(self.n_active_classes)?;
987 let flat = self.coefficient_influence_flat.as_ref()?;
988 Array2::from_shape_vec((d, d), flat.clone()).ok()
989 }
990
991 /// Evaluate `softmax(X·β)` AND its delta-method per-class probability
992 /// standard error at fresh data rows (#1101).
993 ///
994 /// For active classes `b ∈ 0..M` the softmax Jacobian is
995 /// `∂p_c/∂η_b = p_c (δ_{cb} − p_b)`, and `∂η_b/∂β[i,a] = X[i]·δ_{ab}`, so the
996 /// gradient of class-`c` probability w.r.t. the block-ordered coefficient
997 /// vector is `g_c[a·P + i] = X[i]·p_c (δ_{ca} − p_a)` (active `a`; the
998 /// reference class `M` contributes `p_c(0 − p_a)` via every active block).
999 /// The delta-method variance is `Var(p_c) = g_cᵀ Σ g_c` with `Σ = H⁻¹` the
1000 /// joint posterior covariance, and `SE(p_c) = √Var(p_c)`. Returns
1001 /// `(probs (N,K), prob_se (N,K))`; `prob_se` is `None` when no covariance is
1002 /// stored. The simplex `[0,1]` clamp is applied by the interval consumer, not
1003 /// here (the SE itself is unclamped).
1004 pub fn predict_probabilities_with_se(
1005 &self,
1006 x_new: ArrayView2<'_, f64>,
1007 ) -> (Array2<f64>, Option<Array2<f64>>) {
1008 let probs = self.predict_probabilities(x_new);
1009 let Some(cov) = self.coefficient_covariance() else {
1010 return (probs, None);
1011 };
1012 let n_new = x_new.nrows();
1013 let p = self.p_per_class;
1014 let m = self.n_active_classes;
1015 let k = m + 1;
1016 let d = p * m;
1017 let mut prob_se = Array2::<f64>::zeros((n_new, k));
1018 let mut grad = vec![0.0_f64; d];
1019 for row in 0..n_new {
1020 let prow = probs.row(row);
1021 for c in 0..k {
1022 let pc = prow[c];
1023 // g_c[a·P + i] = X[i] · p_c · (δ_{ca} − p_a), a active.
1024 for a in 0..m {
1025 let pa = prow[a];
1026 let factor = pc * (if c == a { 1.0 - pa } else { -pa });
1027 let base = a * p;
1028 for i in 0..p {
1029 grad[base + i] = x_new[[row, i]] * factor;
1030 }
1031 }
1032 // Var = gᵀ Σ g.
1033 let mut var = 0.0_f64;
1034 for r in 0..d {
1035 let gr = grad[r];
1036 if gr == 0.0 {
1037 continue;
1038 }
1039 let mut acc = 0.0_f64;
1040 for s in 0..d {
1041 acc += cov[[r, s]] * grad[s];
1042 }
1043 var += gr * acc;
1044 }
1045 prob_se[[row, c]] = var.max(0.0).sqrt();
1046 }
1047 }
1048 (probs, Some(prob_se))
1049 }
1050
1051 /// Wood (2013) rank-truncated Wald smooth-significance test per
1052 /// `(active class, smooth term)` (#1101), reusing the exact scalar-summary
1053 /// kernel [`gam_terms::inference::smooth_test::wood_smooth_test`]. For active
1054 /// class `a` and term span `[c0, c1)` within the class block, the global
1055 /// coefficient range is `a·P + c0 .. a·P + c1`; the joint covariance and
1056 /// influence are sliced there. The term EDF is the influence-block trace
1057 /// `tr(F_jj)` (when present) and the reference d.f. uses `tr(F_jj)²/tr(F_jj²)`,
1058 /// exactly as the scalar path. The multinomial softmax is a known-dispersion
1059 /// family, so the χ²_{ref_df} branch applies. Returns one row per
1060 /// `(class label, term label, edf, ref_df, statistic, p_value)`; empty when
1061 /// no covariance/smooth terms are available.
1062 pub fn smooth_significance(&self) -> Vec<MultinomialSmoothSignificance> {
1063 let mut out = Vec::new();
1064 let p = self.p_per_class;
1065 let m = self.n_active_classes;
1066 let Some(cov) = self.coefficient_covariance() else {
1067 return out;
1068 };
1069 if self.smooth_term_spans.is_empty() {
1070 return out;
1071 }
1072 let beta = self.coefficients_active();
1073 // Block-ordered θ = [β_0; …; β_{M-1}], θ[a·P + i] = β[i, a].
1074 let d = p * m;
1075 let mut theta = Array1::<f64>::zeros(d);
1076 for a in 0..m {
1077 for i in 0..p {
1078 theta[a * p + i] = beta[[i, a]];
1079 }
1080 }
1081 let influence = self.coefficient_influence();
1082 for a in 0..m {
1083 let class_label = self
1084 .class_levels
1085 .get(a)
1086 .cloned()
1087 .unwrap_or_else(|| format!("class{a}"));
1088 let base = a * p;
1089 for span in &self.smooth_term_spans {
1090 if span.col_end > p {
1091 continue;
1092 }
1093 let start = base + span.col_start;
1094 let end = base + span.col_end;
1095 // Term EDF = tr(F_jj); without an influence matrix fall back to
1096 // the block coefficient count (full-rank Wald on the span).
1097 let block_len = (span.col_end - span.col_start) as f64;
1098 let edf = influence
1099 .as_ref()
1100 .map(|f| (start..end).map(|i| f[[i, i]]).sum::<f64>())
1101 .filter(|v| v.is_finite() && *v > 0.0)
1102 .unwrap_or(block_len);
1103 let result = gam_terms::inference::smooth_test::wood_smooth_test(
1104 gam_terms::inference::smooth_test::SmoothTestInput {
1105 beta: theta.view(),
1106 covariance: &cov,
1107 influence_matrix: influence.as_ref(),
1108 coeff_range: start..end,
1109 edf,
1110 nullspace_dim: span.nullspace_dim,
1111 residual_df: f64::INFINITY,
1112 scale: gam_terms::inference::smooth_test::SmoothTestScale::Known,
1113 },
1114 );
1115 if let Some(res) = result {
1116 out.push(MultinomialSmoothSignificance {
1117 class_label: class_label.clone(),
1118 term_label: span.label.clone(),
1119 edf,
1120 ref_df: res.ref_df,
1121 statistic: res.statistic,
1122 p_value: res.p_value,
1123 });
1124 }
1125 }
1126 }
1127 out
1128 }
1129
1130 /// Draw `n_draws` posterior-predictive replicate class assignments at fresh
1131 /// rows (#1101). Each draw independently samples every row's class from
1132 /// `Categorical(p_row)` with `p = softmax(X·β̂)` — the plug-in predictive
1133 /// distribution, i.e. the multinomial observation noise wrapped around the
1134 /// fitted mean (the categorical analogue of the scalar families'
1135 /// `sample_replicates`). The returned `(n_draws, N)` matrix holds class
1136 /// INDICES `0..K`, aligned to [`Self::class_levels`]. The draw stream is a
1137 /// `StdRng` seeded by `seed`, so `(x_new, n_draws, seed)` reproduce
1138 /// bit-identically — the engine for posterior-predictive checks and
1139 /// simulation-based calibration. `x_new` must have `self.p_per_class`
1140 /// columns (built from the same `resolved_termspec` as fit time).
1141 pub fn sample_replicate_classes(
1142 &self,
1143 x_new: ArrayView2<'_, f64>,
1144 n_draws: usize,
1145 seed: u64,
1146 ) -> Array2<u32> {
1147 use rand::{RngExt, SeedableRng};
1148 let probs = self.predict_probabilities(x_new);
1149 let n = probs.nrows();
1150 let k = probs.ncols();
1151 let mut out = Array2::<u32>::zeros((n_draws, n));
1152 let mut rng = rand::rngs::StdRng::seed_from_u64(seed);
1153 for d in 0..n_draws {
1154 for row in 0..n {
1155 let u: f64 = rng.random::<f64>();
1156 // Inverse-CDF categorical draw over the K simplex weights.
1157 let mut acc = 0.0_f64;
1158 let mut chosen = k - 1; // numerical fallback = reference class
1159 for c in 0..k {
1160 acc += probs[[row, c]];
1161 if u < acc {
1162 chosen = c;
1163 break;
1164 }
1165 }
1166 out[[d, row]] = chosen as u32;
1167 }
1168 }
1169 out
1170 }
1171}
1172
1173/// One row of the multinomial smooth-significance table (#1101): the Wood
1174/// rank-truncated Wald test for one `(active class, smooth term)` pair.
1175#[derive(Debug, Clone)]
1176pub struct MultinomialSmoothSignificance {
1177 pub class_label: String,
1178 pub term_label: String,
1179 pub edf: f64,
1180 pub ref_df: f64,
1181 pub statistic: f64,
1182 pub p_value: f64,
1183}
1184
1185/// One-hot-encode the categorical response column and return both the
1186/// encoding and the captured level names. The level order matches the order
1187/// recorded in the dataset schema, which is the canonical (lexicographically
1188/// sorted) factor order produced by inferred-schema construction (#1319) — so
1189/// it is a deterministic function of the label *set*, independent of training
1190/// row order (no silent class permutation under a row shuffle), and matches the
1191/// R `factor()` / pandas `Categorical` convention.
1192fn one_hot_categorical_response(
1193 data: &EncodedDataset,
1194 y_col: usize,
1195 response_name: &str,
1196) -> Result<(Array2<f64>, Vec<String>), EstimationError> {
1197 let levels: Vec<String> = data
1198 .schema
1199 .columns
1200 .get(y_col)
1201 .map(|sc| sc.levels.clone())
1202 .unwrap_or_default();
1203 if levels.len() < 2 {
1204 crate::bail_invalid_estim!(
1205 "multinomial response '{response_name}' must have at least 2 categorical levels (got {})",
1206 levels.len()
1207 );
1208 }
1209 let n = data.values.nrows();
1210 let k = levels.len();
1211 let mut y_one_hot = Array2::<f64>::zeros((n, k));
1212 for row in 0..n {
1213 let encoded = data.values[[row, y_col]];
1214 if !encoded.is_finite() {
1215 crate::bail_invalid_estim!(
1216 "multinomial response '{response_name}' row {row} is non-finite ({encoded})"
1217 );
1218 }
1219 let class_idx = encoded.round() as i64;
1220 if class_idx < 0 || (class_idx as usize) >= k {
1221 crate::bail_invalid_estim!(
1222 "multinomial response '{response_name}' row {row} encoded as {encoded} \
1223 is outside the level range 0..{k}"
1224 );
1225 }
1226 y_one_hot[[row, class_idx as usize]] = 1.0;
1227 }
1228 Ok((y_one_hot, levels))
1229}
1230
1231/// Build `(TermCollectionSpec, TermCollectionDesign)` from a formula against
1232/// a categorical-response dataset. Mirrors the early scaffolding inside
1233/// `materialize_standard` (response role resolution, geometry-aware spec
1234/// build) without touching the scalar-family resolution path — multinomial
1235/// owns its own response kind check.
1236fn build_formula_design_for_multinomial(
1237 formula: &str,
1238 data: &EncodedDataset,
1239 config: &FitConfig,
1240) -> Result<
1241 (
1242 TermCollectionSpec,
1243 TermCollectionDesign,
1244 usize,
1245 String,
1246 ResponseColumnKind,
1247 ),
1248 EstimationError,
1249> {
1250 let parsed = parse_formula(formula).map_err(|err| {
1251 EstimationError::InvalidInput(format!(
1252 "multinomial fit: failed to parse formula {formula:?}: {err}"
1253 ))
1254 })?;
1255 let col_map = data.column_map();
1256 let y_col = resolve_role_col(&col_map, &parsed.response, "response")
1257 .map_err(|err| EstimationError::InvalidInput(format!("multinomial fit: {err}")))?;
1258 let y_kind = crate::fit_orchestration::response_column_kind(data, y_col);
1259 let policy = resolved_resource_policy(config, data, ProblemHints::default());
1260 let mut inference_notes: Vec<String> = Vec::new();
1261 let spec = build_termspec_with_geometry_and_overrides(
1262 &parsed.terms,
1263 data,
1264 &col_map,
1265 &mut inference_notes,
1266 config.scale_dimensions,
1267 &policy,
1268 config.smooth_overrides.as_ref(),
1269 )
1270 .map_err(|err| {
1271 EstimationError::InvalidInput(format!("multinomial fit: build termspec: {err}"))
1272 })?;
1273 let design = build_term_collection_design(data.values.view(), &spec).map_err(|err| {
1274 EstimationError::InvalidInput(format!("multinomial fit: build design: {err}"))
1275 })?;
1276 Ok((spec, design, y_col, parsed.response, y_kind))
1277}
1278
1279fn scale_multinomial_formula_penalty(penalty: PenaltyMatrix, scale: f64) -> PenaltyMatrix {
1280 match penalty {
1281 PenaltyMatrix::Dense(matrix) => PenaltyMatrix::Dense(matrix.mapv(|v| v * scale)),
1282 PenaltyMatrix::KroneckerFactored { left, right } => PenaltyMatrix::KroneckerFactored {
1283 left: left.mapv(|v| v * scale),
1284 right,
1285 },
1286 PenaltyMatrix::Blockwise {
1287 local,
1288 col_range,
1289 total_dim,
1290 } => PenaltyMatrix::Blockwise {
1291 local: local.mapv(|v| v * scale),
1292 col_range,
1293 total_dim,
1294 },
1295 PenaltyMatrix::Labeled { label, inner } => PenaltyMatrix::Labeled {
1296 label,
1297 inner: Box::new(scale_multinomial_formula_penalty(*inner, scale)),
1298 },
1299 PenaltyMatrix::Fixed { log_lambda, inner } => PenaltyMatrix::Fixed {
1300 log_lambda,
1301 inner: Box::new(scale_multinomial_formula_penalty(*inner, scale)),
1302 },
1303 }
1304}
1305
1306/// Build a warm-started copy of `blocks` whose per-block `initial_log_lambdas`
1307/// are seeded from a previously-selected flat `log_lambdas` vector (#1082).
1308///
1309/// The flat `log_lambdas` returned by [`fit_custom_family_with_rho_prior`]
1310/// concatenates each block's penalty log-λ in block order — the same order
1311/// `build_block_specs()` emits the blocks and the same per-block penalty order
1312/// the spec carries — so it splits back across blocks by each block's penalty
1313/// count. Warm-starting the OUTER ρ-search from a prior iterate changes only the
1314/// optimizer's starting point, never the penalized objective or its optimum, so
1315/// the converged fit is identical; it just resumes near the prior iterate
1316/// instead of restarting from the cold `init_lambda` seed.
1317///
1318/// Returns `None` (caller falls back to the cold blocks) if the flat vector does
1319/// not have exactly one entry per penalty across all blocks, or carries a
1320/// non-finite value — i.e. anything that would make the seed unsafe.
1321fn warm_start_blocks_from_log_lambdas(
1322 blocks: &[crate::custom_family::ParameterBlockSpec],
1323 log_lambdas: &[f64],
1324) -> Option<Vec<crate::custom_family::ParameterBlockSpec>> {
1325 let total: usize = blocks.iter().map(|b| b.initial_log_lambdas.len()).sum();
1326 if total == 0 || log_lambdas.len() != total {
1327 return None;
1328 }
1329 if log_lambdas.iter().any(|v| !v.is_finite()) {
1330 return None;
1331 }
1332 let mut warm = blocks.to_vec();
1333 let mut offset = 0usize;
1334 for block in warm.iter_mut() {
1335 let k = block.initial_log_lambdas.len();
1336 for slot in 0..k {
1337 block.initial_log_lambdas[slot] = log_lambdas[offset + slot];
1338 }
1339 offset += k;
1340 }
1341 Some(warm)
1342}
1343
1344/// Top-level formula-driven multinomial fit.
1345///
1346/// Routes through [`fit_custom_family_with_rho_prior`] so the per-active-class
1347/// smoothing parameters `λ_a` (one per class block, shared-penalty
1348/// architecture) are selected by the outer REML/LAML loop rather than pinned
1349/// by the caller. `init_lambda` survives as a warm-start hint that seeds
1350/// every block's `initial_log_lambdas`. `max_iter` / `tol` drive the OUTER
1351/// REML/LAML smoothing-parameter search (`outer_max_iter` / `outer_tol`); the
1352/// inner joint-Newton solve runs on the framework's principled production cycle
1353/// budget at the default KKT tolerance so an ill-conditioned, LM-damped
1354/// near-simplex-boundary solve can certify a stationary point instead of being
1355/// declared non-converged after only `max_iter` cycles (#715).
1356///
1357/// The Jeffreys/Firth proper prior is engaged CONDITIONALLY: attempt 1 runs
1358/// the unbiased penalized-REML criterion; only on separation evidence (a failed
1359/// solve or a non-finite logit; see [`multinomial_formula_separation_evidence`])
1360/// is the fit re-solved once with the full-span Firth prior armed, which bounds
1361/// the penalty-null directions no smoothing parameter can (`S v = 0` ⇒
1362/// `(H + S_λ) v = H v → 0` when the softmax likelihood has no finite mode).
1363///
1364/// The categorical response column is recognised via the dataset schema
1365/// (`ColumnKindTag::Categorical`); reference class = last level. Returns a
1366/// [`MultinomialSavedModel`] that can be serialised to bytes for the Python
1367/// wrapper or used in-process for `predict_probabilities`.
1368pub fn fit_penalized_multinomial_formula(
1369 data: &EncodedDataset,
1370 formula: &str,
1371 config: &FitConfig,
1372 init_lambda: f64,
1373 max_iter: usize,
1374 tol: f64,
1375) -> Result<MultinomialSavedModel, EstimationError> {
1376 if !(init_lambda.is_finite() && init_lambda > 0.0) {
1377 crate::bail_invalid_estim!(
1378 "multinomial fit: init_lambda must be finite and > 0 (got {init_lambda})"
1379 );
1380 }
1381 let (raw_spec, design, y_col, response_name, y_kind) =
1382 build_formula_design_for_multinomial(formula, data, config)?;
1383 // Freeze the data-derived basis state (B-spline knot vectors, by-factor
1384 // level sets, spatial centers, joint-null rotations, residualization
1385 // charts) from the fit design back onto the spec. The raw geometry spec
1386 // records only *which* columns and *what kind* of basis each smooth uses;
1387 // the actual column count and basis evaluation depend on quantities the
1388 // builder derives from the training data (knot placement, the distinct
1389 // by-factor levels, etc.). Saving the raw spec made predict re-derive those
1390 // from the (smaller, differently-distributed) predict frame, so the rebuilt
1391 // design had a different column count than the fitted one — the panic
1392 // "predict design has 42 cols, saved model expects 191" for an `s(x,
1393 // by=group)` smooth-by-factor model. Every other family's persistence path
1394 // freezes the spec the same way (see `freeze_term_collection_from_design`
1395 // call sites in `main_parts`); multinomial was the lone exception.
1396 let spec = freeze_term_collection_from_design(&raw_spec, &design)?;
1397 let class_levels = match y_kind {
1398 ResponseColumnKind::Categorical { levels } => levels,
1399 ResponseColumnKind::Binary => vec!["0".to_string(), "1".to_string()],
1400 ResponseColumnKind::Numeric => {
1401 crate::bail_invalid_estim!(
1402 "multinomial fit: response '{response_name}' is numeric, not categorical; \
1403 use family='gaussian'/'binomial'/... or convert the column to a categorical type"
1404 );
1405 }
1406 };
1407 if data.column_kinds.get(y_col) == Some(&ColumnKindTag::Binary) {
1408 // Promote to a 2-level categorical for the multinomial driver; the
1409 // caller explicitly asked for multinomial, so we route through the
1410 // K-1 = 1 active-class softmax (equivalent math to logistic).
1411 } else if data.column_kinds.get(y_col) != Some(&ColumnKindTag::Categorical) {
1412 crate::bail_invalid_estim!(
1413 "multinomial fit: response '{response_name}' must be a categorical column \
1414 (got column kind {:?})",
1415 data.column_kinds.get(y_col)
1416 );
1417 }
1418 let (y_one_hot, _) = one_hot_categorical_response(data, y_col, &response_name)?;
1419 // Build the global X dense (the design is a DesignMatrix abstraction).
1420 let mut x_dense = design
1421 .design
1422 .try_to_dense_by_chunks("multinomial fit design")
1423 .map_err(EstimationError::InvalidInput)?;
1424
1425 // ── #715 real-data conditioning: standardize unpenalized parametric
1426 // columns. Raw-unit linear covariates (penguins `body_mass_g` ~ 4e3 grams)
1427 // inflate the joint Newton information by the squared column scale (a κ(H)
1428 // multiplier of ~s² ≈ 1e7 against the intercept), which is what turns the
1429 // near-separable LM-damped inner solve into a geometric grind that
1430 // exhausts its cycle budgets — the adapter-level face of "all REML startup
1431 // seeds rejected". Because these columns are UNPENALIZED (parametric terms
1432 // carry no default ridge, #749), the affine reparameterization
1433 // `x_j ↦ (x_j − m_j)/s_j` is EXACT for the whole criterion: the optimized
1434 // REML/LAML objective, the fitted η, the selected λ, and the separation
1435 // diagnostics are all invariant — only the conditioning of `H` changes.
1436 // Fitted coefficients are mapped back to raw units at repack below, so the
1437 // saved model and the (raw-design) predict path are untouched. Penalized
1438 // columns are left alone (a penalty makes the rescaling non-equivalent),
1439 // and nothing is touched when explicit coefficient bounds/constraints
1440 // exist (those are stated in raw units).
1441 let parametric_standardization: Vec<(usize, f64, f64)> =
1442 if design.coefficient_lower_bounds.is_some() || design.linear_constraints.is_some() {
1443 Vec::new()
1444 } else {
1445 let p_total = x_dense.ncols();
1446 let mut penalized = vec![false; p_total];
1447 for bp in &design.penalties {
1448 for col in bp.col_range.clone() {
1449 if col < p_total {
1450 penalized[col] = true;
1451 }
1452 }
1453 }
1454 let has_intercept = !design.intercept_range.is_empty();
1455 let n_rows = x_dense.nrows().max(1) as f64;
1456 let mut standardized = Vec::new();
1457 for (_, range) in &design.linear_ranges {
1458 for col in range.clone() {
1459 if col >= p_total || penalized[col] {
1460 continue;
1461 }
1462 let column = x_dense.column(col);
1463 let mean = column.sum() / n_rows;
1464 let var = column.iter().map(|v| (v - mean) * (v - mean)).sum::<f64>() / n_rows;
1465 let scale = var.sqrt();
1466 // Skip near-constant or degenerate columns: no conditioning to
1467 // be gained and the back-map would divide by ~0.
1468 if !(scale.is_finite() && scale > 1e-8 * (mean.abs() + 1.0)) {
1469 continue;
1470 }
1471 // Centering shifts mass onto the intercept; without one the
1472 // shift is not representable, so scale only.
1473 let center = if has_intercept { mean } else { 0.0 };
1474 for v in x_dense.column_mut(col).iter_mut() {
1475 *v = (*v - center) / scale;
1476 }
1477 standardized.push((col, center, scale));
1478 }
1479 }
1480 standardized
1481 };
1482 // Preserve the per-smooth-term penalty block structure (#561): each smooth
1483 // term `t` contributes its own `P × P` penalty component (`Blockwise` with
1484 // `total_dim = P`, the term's local `S_t` embedded at its `col_range`), and
1485 // every active class block receives the FULL list. The outer REML/LAML loop
1486 // then selects an independent smoothing parameter λ_{a,t} per (class, term),
1487 // matching mgcv/VGAM. Pre-summing the terms into one fused `S` (the prior
1488 // behaviour) forced a single λ per class that scales `Σ_t S_t`, so one
1489 // shared λ had to over-smooth a rough term while under-smoothing a smooth
1490 // one — biasing any multi-term class-probability surface.
1491 let k = y_one_hot.ncols();
1492 let m = k - 1;
1493 let n_obs = y_one_hot.nrows();
1494 let penalty_scale = multinomial_formula_penalty_scale(k);
1495 let per_term_penalties: Vec<PenaltyMatrix> = design
1496 .penalties_as_penalty_matrix()
1497 .into_iter()
1498 .map(|penalty| scale_multinomial_formula_penalty(penalty, penalty_scale))
1499 .collect();
1500 let per_term_nullspace_dims = design.nullspace_dims.clone();
1501
1502 // ── Custom-family driven REML/LAML path ───────────────────────────────
1503 // Each active class becomes one ParameterBlockSpec, all sharing X and the
1504 // per-term penalty list. `initial_log_lambdas` is seeded from the caller's
1505 // `init_lambda` (one entry per term).
1506 let design_arc = Arc::new(x_dense);
1507 let penalties_arc = Arc::new(per_term_penalties);
1508 let nullspace_dims_arc = Arc::new(per_term_nullspace_dims);
1509 let weights = Array1::<f64>::ones(n_obs);
1510 // First attempt runs the UNBIASED penalized-REML criterion (no Firth
1511 // shrinkage toward the uniform simplex); the Jeffreys/Firth proper prior is
1512 // armed conditionally below, only on separation evidence (#715/#753 — see
1513 // `multinomial_formula_separation_evidence`).
1514 let log_init = init_lambda.ln();
1515 let family = MultinomialFamily::new(
1516 y_one_hot.clone(),
1517 weights,
1518 k,
1519 design_arc.clone(),
1520 penalties_arc.clone(),
1521 nullspace_dims_arc.clone(),
1522 )
1523 .map_err(EstimationError::InvalidInput)?
1524 .with_joint_jeffreys_term(false)
1525 // gam#1587: the per-block smooth penalties are emptied (the centered `M⊗S_t`
1526 // joint penalty is the sole smoothing carrier), so the `init_lambda` warm
1527 // start must seed the JOINT penalty's `initial_log_lambda` — the per-block
1528 // `initial_log_lambdas` loop below is now a no-op (empty per-block list).
1529 .with_initial_log_lambda(log_init);
1530 let mut blocks = family.build_block_specs();
1531 for spec_block in blocks.iter_mut() {
1532 for v in spec_block.initial_log_lambdas.iter_mut() {
1533 *v = log_init;
1534 }
1535 }
1536
1537 // ── Outer-derivative policy: dimension-gated exact curvature ────────────
1538 // The total smoothing-parameter dimension is `D = (K−1) · n_terms`.
1539 // Medium-D formula fits need exact curvature to keep lambda selection away
1540 // from over-smoothed caps, while smooth-by-factor `D = 8` models still avoid
1541 // the O(D²) dense Hessian path.
1542 let total_rho_dim = m.saturating_mul(penalties_arc.len());
1543 let use_outer_hessian = multinomial_formula_use_outer_hessian(total_rho_dim);
1544
1545 // ── Inner-vs-outer control split (#715 non-convergence root cause) ────────
1546 // The legacy `max_iter` / `tol` parameters are the *outer* REML/LAML
1547 // smoothing-parameter optimization controls — "how hard to search λ". The
1548 // earlier wiring routed them straight into `inner_max_cycles` / `inner_tol`,
1549 // capping the joint-Newton inner solve at `max_iter` (=50 in the quality
1550 // suite) cycles with a `tol`-tight (=1e-8) KKT target. That is the #715
1551 // hang: near the simplex boundary the softmax Fisher weight
1552 // `W = diag(p) − p pᵀ` collapses, so `H = JᵀWJ + S_λ` is full-rank but
1553 // ILL-CONDITIONED. The self-vanishing Levenberg–Marquardt damping
1554 // (`levenberg_on_ill_conditioning()`) that keeps the inner solve from
1555 // oscillating on those near-singular modes makes it converge only
1556 // GEOMETRICALLY (linearly), not quadratically. Reaching a 1e-8 relative KKT
1557 // residual under geometric descent needs FAR more than 50 cycles, so the
1558 // inner returned `converged = false` on every outer ρ-evaluation; with the
1559 // exact-Hessian outer optimizer on `FallbackPolicy::Disabled` that rejects
1560 // every ρ-step — each rejected eval still paying a near-full 50-cycle inner
1561 // solve plus the O(D²) pairwise outer-Hessian directional work — so the
1562 // outer never certifies and the fit runs unbounded (the observed >8-minute
1563 // non-termination). The certificate cannot be reached, not merely slow.
1564 //
1565 // Fix: give the INNER joint-Newton the framework's principled production
1566 // budget (`DEFAULT_CUSTOM_FAMILY_INNER_MAX_CYCLES` cycles at the default
1567 // `inner_tol`), which exists precisely so an ill-conditioned LM-damped solve
1568 // can certify a stationary KKT point instead of being declared non-converged
1569 // prematurely — and the KKT/objective certificates still exit in a handful
1570 // of cycles on the well-conditioned interior fits, so this is free there.
1571 // The caller's `max_iter` / `tol` become the OUTER controls they were always
1572 // meant to be (smoothing-parameter search depth / accuracy). The inner KKT
1573 // target is kept no tighter than the outer accuracy can consume — and no
1574 // tighter than the softmax objective's f64 noise floor on near-separable
1575 // fits (see `MULTINOMIAL_FORMULA_INNER_TOL`).
1576 let outer_max_iter = max_iter.max(1);
1577 // The OUTER REML/LAML smoothing-parameter search must converge to a
1578 // well-calibrated ρ-gradient tolerance, NOT to the caller's (typically very
1579 // tight) INNER KKT tolerance. The #715 control-split repurposed the caller's
1580 // `tol` as the outer control, but feeding an inner-scale `tol = 1e-8`
1581 // straight into `outer_tol` makes REML grind dozens of extra exact-gradient
1582 // outer iterations (each an O(D·p³) Laplace-derivative assembly over the full
1583 // P·M joint design) to squeeze ρ digits that no longer move the fitted
1584 // surface — the smooth-by-factor 269s wall-clock overrun (#1082).
1585 //
1586 // The right target is the framework's CALIBRATED REML convergence tolerance,
1587 // `MULTINOMIAL_OUTER_REML_TOL = 1e-7` — the same value the primary GLM REML
1588 // outer uses (`solver::fit_orchestration::materialize` `tol: 1e-7`, mirrored by the
1589 // `LOG_LAMBDA_TOL`/`KKT_TOL_*` constants across the REML stack). At 1e-7 the
1590 // λ-search reaches the genuine REML optimum (so the recovered probability
1591 // surface matches the mature reference), but it does NOT chase the last
1592 // surface-irrelevant ρ digits down to 1e-8. The earlier 1e-5 floor (the
1593 // generic `BlockwiseFitOptions` default) was too LOOSE: the optimizer halted
1594 // in a low-curvature region with λ still well above its optimum, UNDER-fitting
1595 // the smooth-by-factor surface (truth-RMSE 0.164 vs VGAM's 0.061). So the
1596 // outer tolerance is floored at the calibrated REML tol — never tighter than
1597 // it (perf), never looser (accuracy) — while the caller's `tol` continues to
1598 // drive the INNER joint-Newton KKT target (`inner_tol` below), where its
1599 // precision actually matters.
1600 let outer_tol = if tol.is_finite() && tol > 0.0 {
1601 tol.max(MULTINOMIAL_OUTER_REML_TOL)
1602 } else {
1603 MULTINOMIAL_OUTER_REML_TOL
1604 };
1605 // #1082 root cause: the outer convergence test derives BOTH the absolute
1606 // projected-gradient floor (`max(outer_tol, n·1e-9)`) AND the relative-cost
1607 // stop (`rel_cost = outer_tol`) from the single `outer_tol`. The accuracy of
1608 // the smooth-by-factor surface is governed by the ABSOLUTE floor reaching the
1609 // n-scaled REML resolution `n·1e-9` (≈ 1.8e-6 at n = 1800) — that is why the
1610 // earlier 1e-5 floor UNDER-fit (its absolute floor was pinned at 1e-5, well
1611 // above the genuine optimum's gradient) and why 1e-7 recovered accuracy (it
1612 // unpins the floor down to the n-scaled 1.8e-6). But tightening `outer_tol`
1613 // to 1e-7 ALSO tightened the rel-cost stop to 1e-7, which on this family's
1614 // dead-flat REML ridge NEVER trips — so the optimizer no longer converges and
1615 // grinds all the way to `outer_max_iter`, each surplus step an O(D·p³) Laplace-
1616 // derivative assembly over the 382-dim joint design (the >600s wall-clock
1617 // overrun; tightening tol REINTRODUCED the crawl the 1e-5 floor had removed).
1618 //
1619 // The two requirements live on two different criteria, so they must be set
1620 // independently. Keep `outer_tol = 1e-7` (drives the accurate absolute floor)
1621 // but FLOOR the relative-cost stop at the framework default 1e-5 (the loose,
1622 // fast value that resolves the cost-decrease plateau without chasing the flat
1623 // tail). The absolute n·1e-9 floor still gates final λ accuracy; the rel-cost
1624 // stop just lets the optimizer DECLARE convergence on the flat ridge instead
1625 // of crawling to the iteration cap.
1626 let outer_rel_cost_tol = Some(BlockwiseFitOptions::default().outer_tol);
1627 let inner_tol = MULTINOMIAL_FORMULA_INNER_TOL.max(tol.max(0.0));
1628
1629 let options = BlockwiseFitOptions {
1630 inner_max_cycles: crate::custom_family::DEFAULT_CUSTOM_FAMILY_INNER_MAX_CYCLES,
1631 inner_tol,
1632 outer_max_iter,
1633 outer_tol,
1634 outer_rel_cost_tol,
1635 rho_lower_bound: multinomial_formula_min_lambda(y_one_hot.view()).ln(),
1636 ridge_floor: MULTINOMIAL_FORMULA_RIDGE_FLOOR,
1637 // #747: the stabilization floor is SOLVER-ONLY — it keeps the inner
1638 // joint-Newton linear solve finite during screening (bounding the step
1639 // `(H+δI)⁻¹∇` away from a near-separable, rank-deficient curvature) but
1640 // is excluded from the REML objective, the penalty log-determinant, and
1641 // the Laplace Hessian. The earlier default (`explicit_stabilization_pospart`)
1642 // folded `½·δ·‖β‖²` and a `δ`-shift of the log-determinant into the
1643 // criterion, shrinking every identified coefficient off the MLE and
1644 // perturbing smoothing-parameter selection — a fixed-λ prior masking
1645 // separation, not a numerical stabilizer. With the floor solver-only the
1646 // optimized objective is the true penalized REML criterion (value tracks
1647 // its analytic gradient), and the smooth directions remain governed
1648 // solely by their own REML-selected `λ`.
1649 ridge_policy: gam_problem::RidgePolicy::solver_only(),
1650 use_outer_hessian,
1651 // #715 real-data arm ("canonical-gauge null direction rejects all REML
1652 // seeds"): skip the multi-seed outer screening cascade and let the
1653 // pinned `init_lambda` ρ flow straight to the outer optimizer.
1654 //
1655 // The multinomial family declares `levenberg_on_ill_conditioning() ->
1656 // true`: near the simplex boundary (the near-separable penguins regime)
1657 // the softmax Fisher weight `W = diag(p) − p pᵀ → 0`, so the joint
1658 // information `H = JᵀWJ + S_λ` can become full-rank but
1659 // ILL-CONDITIONED. The self-vanishing LM damping that keeps the inner
1660 // joint-Newton from oscillating on those near-singular modes converges
1661 // only GEOMETRICALLY. The default screening policy ranks candidate seeds
1662 // with a 2-cycle inner cap (`outer_seed_config`); under geometric
1663 // LM-damped descent two cycles never reach a finite, meaningful proxy
1664 // objective, so EVERY capped seed can collapse to non-finite cost and
1665 // the cascade escalates to ×4, ×16, then an UNCAPPED full inner solve
1666 // PER SEED on the near-singular Hessian. That is the adapter-level face
1667 // of "all REML startup seeds rejected" and the multi-minute timeout.
1668 //
1669 // The pinned seed is already principled here: `init_lambda` gives every
1670 // (class, term) ρ a sensible moderate warm start, and the per-term
1671 // effective-df-floor upper bounds (`effective_df_floor_rho_upper_bounds`,
1672 // #715 arm (a)) keep any λ from collapsing the smooth onto its polynomial
1673 // null space. So the outer ARC/BFGS optimizer performs the real REML ρ
1674 // search from this seed; screening only adds the cascade cost and, on the
1675 // near-separable arm, the rejection stall.
1676 screen_initial_rho: false,
1677 // #1101: compute the joint Laplace posterior covariance `H⁻¹` (and the
1678 // influence matrix `F = H⁻¹ X'WX`) at the converged mode so the saved
1679 // model can surface delta-method per-class probability standard errors
1680 // and Wald smooth-term p-values. The driver factorizes the penalized
1681 // Hessian during the inner solve regardless; this only asks it to keep
1682 // and invert the factor instead of discarding it.
1683 compute_covariance: true,
1684 ..BlockwiseFitOptions::default()
1685 };
1686 // ── Conditional Firth/Jeffreys engagement (#715 arm (b) / #753) ──────────
1687 // Attempt 1: the unbiased criterion (Jeffreys disarmed above). If the
1688 // returned mode is converged, finite, and interior, it is the exact penalized-REML
1689 // optimum with zero Firth bias — accept it (this is the synthetic-arm /
1690 // interior-data path, #715 arm (a)). If the solve FAILS (e.g. the
1691 // (quasi-)separated penguins geometry where `(H + S_λ)v ≈ 0` along
1692 // penalty-null directions for EVERY ρ rejects every REML startup seed) or
1693 // returns a non-finite artifact, that is direct separation evidence:
1694 // re-solve once with the full-span Jeffreys/Firth proper prior armed, which
1695 // supplies the O(1) curvature on the quotient-null subspace that smoothing
1696 // parameters mathematically cannot (`Sv = 0` ⇒ λ never touches `v`). The
1697 // Firth refit is the accepted result only when the unbiased formula solve
1698 // failed, did not converge on its full budget, or blew up; finite
1699 // formula-path logits can be large on valid near-separated optima and
1700 // should not be shrunk toward the uniform simplex once the unbiased outer
1701 // solve has actually certified.
1702 let mut unbiased_probe_options = options.clone();
1703 unbiased_probe_options.outer_max_iter = unbiased_probe_options
1704 .outer_max_iter
1705 .min(MULTINOMIAL_UNBIASED_PROBE_OUTER_MAX_ITER);
1706 // The FINAL accepted Firth/Jeffreys refit runs to the caller's full outer
1707 // budget: it is the result we ship, so it must reach the genuine REML
1708 // optimum, not a truncated iterate. The near-separable penguin refit that
1709 // motivated #1082's wall-clock concern is now halted honestly at its true
1710 // bound optimum by the KKT-stationary-at-bound guard
1711 // (`CostStallGuard`, #1082 / 64711ed82) and the Newton-decrement residual
1712 // certificate (363af9b56 / 2c9580b1f): on separable data the outer ARC
1713 // certifies and stops early on its own, so no artificial iteration cap is
1714 // needed to land in budget. On non-separable data (e.g. the
1715 // `vgam_smooth_by_factor` double-penalty arm) the refit needs the caller's
1716 // full budget to converge, which a `.min(20)` cap would cut off — accepting
1717 // a non-converged fit, which is dishonest. So the refit keeps `options`
1718 // unchanged. Only the discarded unbiased separation probe above is capped.
1719 let firth_refit_options = &options;
1720
1721 let run_firth_refit = |evidence: String| {
1722 let firth_family = family.clone().with_joint_jeffreys_term(true);
1723 fit_custom_family_with_rho_prior(
1724 &firth_family,
1725 &blocks,
1726 firth_refit_options,
1727 gam_problem::RhoPrior::Flat,
1728 )
1729 .map_err(|err| {
1730 EstimationError::InvalidInput(format!(
1731 "multinomial REML: Firth/Jeffreys-armed refit (separation evidence: \
1732 {evidence}) failed: {err}"
1733 ))
1734 })
1735 };
1736
1737 // #1082: the capped unbiased probe and the (separable-path) Firth decision
1738 // are driven by separation scans over the full P×M logit block. The previous
1739 // match recomputed `multinomial_formula_separation_evidence` /
1740 // `..._unresolved_probe_separation_evidence` in BOTH the match guard AND the
1741 // arm body — three to four full logit walks per fit, paid on the hot
1742 // near-separable penguin path where this branch fires every iterate. Run the
1743 // probe once, evaluate each scan once into a binding, and branch on the
1744 // precomputed results. Behaviour is identical (same scans, same order of
1745 // precedence: converged-interior, unresolved-probe-separation,
1746 // no-separation-needs-full-solve, otherwise-Firth); only the duplicate
1747 // O(n·classes) scans are removed.
1748 let probe_attempt = fit_custom_family_with_rho_prior(
1749 &family,
1750 &blocks,
1751 &unbiased_probe_options,
1752 gam_problem::RhoPrior::Flat,
1753 );
1754 let fit = match probe_attempt {
1755 Ok(probe_fit) => {
1756 let separation = multinomial_formula_separation_evidence(&probe_fit.block_states);
1757 if probe_fit.outer_converged && separation.is_none() {
1758 // Interior, converged, no separation: accept the probe directly.
1759 probe_fit
1760 } else if let Some(evidence) =
1761 multinomial_formula_unresolved_probe_separation_evidence(&probe_fit.block_states)
1762 {
1763 // Non-converged probe already carrying separation-scale logits:
1764 // hand straight to the proper-prior Firth refit (do not spend the
1765 // full unbiased budget grinding the λ→0 separable ridge).
1766 run_firth_refit(format!(
1767 "unbiased-criterion REML probe did not converge after {} outer iterations; {evidence}",
1768 probe_fit.outer_iterations
1769 ))?
1770 } else if separation.is_none() {
1771 // Interior but the capped probe ran out of iterations without
1772 // certifying: re-solve at the caller's full outer budget.
1773 //
1774 // #1082 wall-clock: the capped probe is a strict prefix of this
1775 // solve from the same family/seed, so a COLD restart repeats the
1776 // probe's outer iterations. WARM-START the re-solve from the ρ the
1777 // probe already reached — seed each block's `initial_log_lambdas`
1778 // from the probe's selected `log_lambdas` (same block/penalty
1779 // order: the flat vector concatenates per-block penalties in block
1780 // order, exactly the order `build_block_specs()` emits them). This
1781 // changes only the optimizer's STARTING point, never the objective
1782 // or its optimum, but lets the full solve resume near the probe's
1783 // last iterate instead of crawling up from `init_lambda` again —
1784 // removing the probe-iterations double-pay on the non-separable
1785 // (e.g. `vgam_smooth_by_factor`) arm. If the probe's λ vector does
1786 // not line up with the block layout (it always should), fall back
1787 // to the cold `blocks` seed.
1788 let warm_blocks = warm_start_blocks_from_log_lambdas(
1789 &blocks,
1790 probe_fit.log_lambdas.as_slice().unwrap_or(&[]),
1791 );
1792 let resolve_blocks = warm_blocks.as_deref().unwrap_or(&blocks);
1793 match fit_custom_family_with_rho_prior(
1794 &family,
1795 resolve_blocks,
1796 &options,
1797 gam_problem::RhoPrior::Flat,
1798 ) {
1799 Ok(full_unbiased_fit) => {
1800 let full_separation = multinomial_formula_separation_evidence(
1801 &full_unbiased_fit.block_states,
1802 );
1803 if full_unbiased_fit.outer_converged && full_separation.is_none() {
1804 full_unbiased_fit
1805 } else {
1806 let evidence = full_separation.unwrap_or_else(|| {
1807 format!(
1808 "full unbiased-criterion REML solve did not converge after {} outer iterations",
1809 full_unbiased_fit.outer_iterations
1810 )
1811 });
1812 run_firth_refit(evidence)?
1813 }
1814 }
1815 Err(err) => run_firth_refit(format!(
1816 "full unbiased-criterion REML solve failed: {err}"
1817 ))?,
1818 }
1819 } else {
1820 // Probe converged (or capped) but shows interior separation
1821 // evidence: Firth refit using the already-computed scan.
1822 let evidence = separation.unwrap_or_else(|| {
1823 format!(
1824 "unbiased-criterion REML probe did not converge after {} outer iterations",
1825 probe_fit.outer_iterations
1826 )
1827 });
1828 run_firth_refit(evidence)?
1829 }
1830 }
1831 Err(err) => run_firth_refit(format!("unbiased-criterion REML solve failed: {err}"))?,
1832 };
1833 if let Some(err) = multinomial_formula_separation_diagnostic(
1834 fit.inner_cycles,
1835 fit.outer_iterations,
1836 &fit.block_states,
1837 ) {
1838 return Err(err);
1839 }
1840
1841 // ── Repack coefficients (P, K-1) from per-block β vectors ─────────────
1842 if fit.blocks.len() != m {
1843 crate::bail_invalid_estim!(
1844 "multinomial REML: expected {m} fitted blocks (K-1), got {}",
1845 fit.blocks.len()
1846 );
1847 }
1848 let p_per_class = fit.blocks[0].beta.len();
1849 let mut coefficients_active = Array2::<f64>::zeros((p_per_class, m));
1850 for (a, block) in fit.blocks.iter().enumerate() {
1851 if block.beta.len() != p_per_class {
1852 crate::bail_invalid_estim!(
1853 "multinomial REML: block {a} has {} coefs, expected {p_per_class}",
1854 block.beta.len()
1855 );
1856 }
1857 for i in 0..p_per_class {
1858 coefficients_active[[i, a]] = block.beta[i];
1859 }
1860 }
1861 // Map the standardized-column coefficients back to raw units (the exact
1862 // inverse of the conditioning reparameterization above): β_raw = b/s, with
1863 // the centering mass `Σ_j b_j·m_j/s_j` returned to the intercept.
1864 if !parametric_standardization.is_empty() {
1865 let intercept_col = design.intercept_range.clone().next();
1866 for a in 0..m {
1867 let mut intercept_adjust = 0.0;
1868 for &(col, center, scale) in ¶metric_standardization {
1869 if col < p_per_class {
1870 let raw = coefficients_active[[col, a]] / scale;
1871 coefficients_active[[col, a]] = raw;
1872 intercept_adjust += raw * center;
1873 }
1874 }
1875 if let Some(i0) = intercept_col
1876 && i0 < p_per_class
1877 {
1878 coefficients_active[[i0, a]] -= intercept_adjust;
1879 }
1880 }
1881 }
1882 // Flatten every (class, term) smoothing parameter in block-major order
1883 // (class 0's terms, then class 1's, …). With per-term penalties each block
1884 // now carries one λ per smooth term, so a single λ per class would discard
1885 // the independent per-term selection that fixes #561. `lambdas_per_block`
1886 // segments the flat vector by class so callers can recover per-term λ.
1887 // ── gam#1587/#561 joint-penalty reconstruction ───────────────────────────
1888 // Under the #1587 centered-metric architecture every active class block
1889 // leaves its per-block penalty list EMPTY — the entire fit's smoothing rides
1890 // on a single full-width JOINT penalty `S_λ = Σ_t λ_t (M ⊗ S_t)` whose one
1891 // shared `λ_t` per smooth component is selected by the outer REML loop and
1892 // surfaced on `fit.artifacts.joint_log_lambdas`. So `fit.blocks[a].lambdas`
1893 // is `[]`, the inference layer's per-block trace channel is empty, and the
1894 // older per-block reporting (`lambdas_per_block = [0, 0]`, `edf_per_class =
1895 // None`, …) collapsed (#561 reopen).
1896 //
1897 // Reconstruct the per-(class, component) λ and the influence-matrix EDF
1898 // directly from the selected joint `λ_t` and the COUPLED penalty
1899 // `S_λ = Σ_t λ_t (M ⊗ S_t)` (NOT a block-diagonal `Σ_t λ_{a,t} S_t`: the
1900 // centered metric `M` couples classes off the block diagonal, so a
1901 // block-diagonal `S_λ` would mis-state both the influence matrix and every
1902 // trace). With `H⁻¹ = fit.covariance_conditional` now assembled WITH the
1903 // joint penalty (the `compute_joint_covariance` fix), the influence matrix is
1904 // exactly `F = I − H⁻¹ S_λ`, its per-class diagonal-block trace is the honest
1905 // per-class EDF, and `Σ_a edf_a = tr(F) = edf_total`.
1906 let joint_recon = fit.artifacts.joint_log_lambdas.as_ref().and_then(|jll| {
1907 let n_components = penalties_arc.len();
1908 if jll.len() != n_components || n_components == 0 {
1909 return None;
1910 }
1911 let expected_joint = p_per_class.saturating_mul(m);
1912 let hinv = fit
1913 .covariance_conditional
1914 .as_ref()
1915 .filter(|c| c.nrows() == expected_joint && c.ncols() == expected_joint)?;
1916 // The coupled joint penalty components `M ⊗ S_t` at the selected `λ_t`,
1917 // in raw stacked (class-major) coordinates — exactly the operator the
1918 // inner solve and the now-fixed covariance path penalize with.
1919 let joint_specs = family.centered_joint_penalty_specs();
1920 if joint_specs.len() != n_components {
1921 return None;
1922 }
1923 let lam: Vec<f64> = jll.iter().map(|&l| l.exp()).collect();
1924 // Per-component `H⁻¹ (M ⊗ S_t)` (full mp×mp), reused for both the joint
1925 // influence matrix and the per-(class, component) trace decomposition.
1926 let mut hinv_st: Vec<Array2<f64>> = Vec::with_capacity(n_components);
1927 for spec in &joint_specs {
1928 if spec.matrix.nrows() != expected_joint || spec.matrix.ncols() != expected_joint {
1929 return None;
1930 }
1931 hinv_st.push(hinv.dot(&spec.matrix));
1932 }
1933 // F = I − H⁻¹ S_λ = I − Σ_t λ_t H⁻¹ (M ⊗ S_t).
1934 let mut f = Array2::<f64>::eye(expected_joint);
1935 for (t, hs) in hinv_st.iter().enumerate() {
1936 f.scaled_add(-lam[t], hs);
1937 }
1938 // Per-class diagonal-block trace of F (the honest per-class EDF), and the
1939 // per-(class, component) penalty trace `tr_{a,t} = λ_t · Σ_{i∈class a}
1940 // (H⁻¹ (M⊗S_t))[i,i]` for the per-penalty EDF rollup.
1941 let mut edf_per_class = Vec::with_capacity(m);
1942 // class-major per-penalty EDF (class 0's components, then class 1's, …),
1943 // aligned 1:1 with the flat per-component λ replicated per class.
1944 let mut edf_per_penalty = Vec::with_capacity(m * n_components);
1945 for a in 0..m {
1946 let base = a * p_per_class;
1947 let mut class_trace = 0.0_f64;
1948 for t in 0..n_components {
1949 let mut tr_at = 0.0_f64;
1950 for i in 0..p_per_class {
1951 tr_at += hinv_st[t][[base + i, base + i]];
1952 }
1953 tr_at *= lam[t];
1954 class_trace += tr_at;
1955 // A single component's per-class trace EDF `rank(S_t) − tr_{a,t}`,
1956 // bounded by its local rank (≤ p_per_class).
1957 let ns_t = nullspace_dims_arc.get(t).copied().unwrap_or(0);
1958 let rank_t = (p_per_class as f64 - ns_t as f64).max(0.0);
1959 edf_per_penalty.push((rank_t - tr_at).clamp(0.0, p_per_class as f64));
1960 }
1961 edf_per_class
1962 .push((p_per_class as f64 - class_trace).clamp(0.0, p_per_class as f64));
1963 }
1964 Some((f, edf_per_class, edf_per_penalty, n_components, lam))
1965 });
1966
1967 // Flatten every (class, component) smoothing parameter in class-major order.
1968 // Under the joint-penalty architecture each active class carries the SAME
1969 // per-component λ set (the centered metric ties `λ_t` across classes for
1970 // reference-class invariance), so the flat vector is the selected `λ_t`
1971 // replicated `K-1` times and `lambdas_per_block = [n_components; K-1]`. When
1972 // the joint reconstruction is unavailable (legacy fixed-λ path or absent
1973 // covariance) fall back to the raw — now empty — per-block λ lists.
1974 let (lambdas_per_block, lambdas_flat): (Vec<usize>, Vec<f64>) = match joint_recon.as_ref() {
1975 Some((_, _, _, n_components, lam)) => {
1976 let per_block = vec![*n_components; m];
1977 let mut flat = Vec::with_capacity(m * n_components);
1978 for _ in 0..m {
1979 flat.extend(lam.iter().copied());
1980 }
1981 (per_block, flat)
1982 }
1983 None => {
1984 let per_block: Vec<usize> = fit.blocks.iter().map(|b| b.lambdas.len()).collect();
1985 let flat: Vec<f64> = fit
1986 .blocks
1987 .iter()
1988 .flat_map(|b| b.lambdas.iter().copied())
1989 .collect();
1990 (per_block, flat)
1991 }
1992 };
1993 // Per-active-class effective degrees of freedom, length `K-1`, summing to
1994 // the model `edf_total`. The REML inference block reports `edf_by_block` as
1995 // ONE entry per *penalty block* (per (class, term, penalty)), each computed
1996 // as `rank(S_kk) − tr(H⁻¹ λ_kk S_kk)`. That per-block sum OVER-COUNTS the
1997 // model EDF whenever several penalties share one coefficient range — a
1998 // double-penalty / te / ti / adaptive smooth has ≥2 penalty blocks over the
1999 // same columns, so `Σ_kk rank(S_kk) > p` and `Σ_kk edf_by_block > edf_total`
2000 // (the observed ~79 for a ~24-coefficient model). Handing that raw per-block
2001 // vector out as the documented length-(K-1) per-class EDF is therefore both
2002 // the wrong LENGTH (it is `Σ_a n_blocks_a`, not `K-1`) and an over-count.
2003 //
2004 // The honest per-class EDF is the influence-matrix trace over each class's
2005 // coefficient block. Classes occupy DISJOINT `p_per_class`-wide coefficient
2006 // ranges, and the per-block traces `tr_kk = tr(H⁻¹ λ_kk S_kk)` are additive
2007 // (no rank double-counting), so class `a`'s EDF is
2008 // `p_per_class − Σ_{kk ∈ class a} tr_kk`, and `Σ_a edf_a = m·p_per_class −
2009 // Σ_kk tr_kk = p − Σ tr_kk = edf_total` exactly. Segment the block-major
2010 // `penalty_block_trace` by `lambdas_per_block` (the same per-class λ-count
2011 // segmentation `lambdas_flat` uses). Fall back to `None` when the trace
2012 // channel is unavailable or mis-shaped (legacy fixed-λ path), exactly as the
2013 // raw `edf_by_block` map did before.
2014 let edf_per_class = joint_recon
2015 .as_ref()
2016 .map(|(_, epc, _, _, _)| epc.clone())
2017 .or_else(|| {
2018 // Legacy per-block trace path (fixed-λ / pre-#1587 fits whose
2019 // smoothing is still carried per block). Segment the block-major
2020 // `penalty_block_trace` by `lambdas_per_block`, exactly as before.
2021 fit.inference.as_ref().and_then(|info| {
2022 let traces = &info.penalty_block_trace;
2023 if traces.len() != lambdas_per_block.iter().sum::<usize>() {
2024 return None;
2025 }
2026 let mut per_class = Vec::with_capacity(m);
2027 let mut cursor = 0usize;
2028 for &n_blocks in &lambdas_per_block {
2029 let class_trace: f64 = traces[cursor..cursor + n_blocks].iter().sum();
2030 per_class
2031 .push((p_per_class as f64 - class_trace).clamp(0.0, p_per_class as f64));
2032 cursor += n_blocks;
2033 }
2034 Some(per_class)
2035 })
2036 });
2037 // Per-PENALTY EDF: the inference layer's `edf_by_block` is already the
2038 // clamped per-penalty-block trace EDF `rank(S_k) − λ_k·tr(H⁻¹ S_k)`, one
2039 // entry per smoothing parameter and block-major aligned 1:1 with the flat
2040 // `lambdas`. Surface it verbatim (guarding only on the length contract) so
2041 // consumers can inspect per-(class, term, penalty) collapse onto the null
2042 // space — a signal the per-class EDF SUM hides. This is NOT a per-class
2043 // total: with double-penalty smooths `Σ_k rank(S_k) > p_per_class`, so the
2044 // entries deliberately need not sum to the model EDF (the per-class field
2045 // carries that contract instead).
2046 let edf_per_penalty = joint_recon
2047 .as_ref()
2048 .map(|(_, _, epp, _, _)| epp.clone())
2049 .or_else(|| {
2050 // Legacy per-block path: the inference layer's `edf_by_block` is
2051 // already the clamped per-penalty-block trace EDF, aligned 1:1 with
2052 // the flat `lambdas`.
2053 fit.inference.as_ref().and_then(|info| {
2054 if info.edf_by_block.len() != lambdas_flat.len() {
2055 return None;
2056 }
2057 Some(
2058 info.edf_by_block
2059 .iter()
2060 .map(|&e| e.max(0.0))
2061 .collect::<Vec<f64>>(),
2062 )
2063 })
2064 });
2065 let coefficients_flat: Vec<f64> = coefficients_active.iter().copied().collect();
2066
2067 // #1101: surface the joint Laplace posterior covariance `H⁻¹` (block-ordered
2068 // [β_0; …; β_{K-2}]) and the influence matrix `F = H⁻¹ X'WX` the REML driver
2069 // computed at the converged mode. These power the predict path's delta-method
2070 // per-class probability standard errors and the summary's Wald smooth-term
2071 // tests. The joint matrices are `(P·M)×(P·M)`. The covariance is mapped back
2072 // to RAW units (see below) so it pairs with the raw predict design; the
2073 // influence is kept in the fitted basis (the Wald table only slices penalized
2074 // columns, which the standardization affine leaves identity-mapped).
2075 let expected_joint = p_per_class.saturating_mul(m);
2076 // The joint Hessian (and thus `H⁻¹`) was assembled in the STANDARDIZED
2077 // parametric basis used during fitting, while the saved coefficients and the
2078 // raw predict design are in raw units. Map the covariance to raw units with
2079 // the same exact affine reparameterization `β_raw = A β_std`: for each
2080 // standardized parametric column `col`, `β_raw[col] = β_std[col]/scale` and
2081 // the intercept absorbs `−Σ_col (center/scale)·β_std[col]`. So `A = I` except
2082 // `A[col,col] = 1/scale` and `A[i0,col] = −center/scale`, replicated
2083 // block-diagonally per active class, and `Cov_raw = A Cov_std Aᵀ`. With no
2084 // standardization (`parametric_standardization` empty) `A = I` and this is a
2085 // no-op. The smooth-term (penalized) columns are untouched by `A`, so the
2086 // Wald table's per-term blocks are identical in both bases.
2087 let intercept_col0 = design.intercept_range.clone().next();
2088 let build_per_class_affine = |amat: &mut Array2<f64>| {
2089 for &(col, center, scale) in ¶metric_standardization {
2090 if col >= p_per_class {
2091 continue;
2092 }
2093 amat[[col, col]] = 1.0 / scale;
2094 if let Some(i0) = intercept_col0
2095 && i0 < p_per_class
2096 {
2097 amat[[i0, col]] = -center / scale;
2098 }
2099 }
2100 };
2101 let coefficient_covariance_flat = fit
2102 .covariance_conditional
2103 .as_ref()
2104 .filter(|c| c.nrows() == expected_joint && c.ncols() == expected_joint)
2105 .map(|cov_std| {
2106 if parametric_standardization.is_empty() {
2107 return cov_std.iter().copied().collect::<Vec<f64>>();
2108 }
2109 // Block-diagonal joint A (same per active class).
2110 let mut a_joint = Array2::<f64>::eye(expected_joint);
2111 let mut a_class = Array2::<f64>::eye(p_per_class);
2112 build_per_class_affine(&mut a_class);
2113 for a in 0..m {
2114 let base = a * p_per_class;
2115 for i in 0..p_per_class {
2116 for j in 0..p_per_class {
2117 a_joint[[base + i, base + j]] = a_class[[i, j]];
2118 }
2119 }
2120 }
2121 let cov_raw = a_joint.dot(cov_std).dot(&a_joint.t());
2122 cov_raw.iter().copied().collect::<Vec<f64>>()
2123 });
2124 // The influence matrix `F = H⁻¹ X'WX = H⁻¹(H − S_λ) = I − H⁻¹ S_λ`. The
2125 // exact-Newton multinomial blocks carry no IRLS pseudo-data, so the generic
2126 // inference path does not export `coefficient_influence`; reconstruct it
2127 // exactly here. Under the #1587 joint-penalty architecture the penalty is the
2128 // COUPLED centered metric `S_λ = Σ_t λ_t (M ⊗ S_t)` (off the class-block
2129 // diagonal), already assembled in `joint_recon` above, so reuse that exact
2130 // `F`. Only fall back to the legacy block-diagonal `Σ_t λ_{a,t} S_t`
2131 // reconstruction when the joint reconstruction is unavailable (pre-#1587
2132 // per-block fits whose class blocks still carry their own penalties).
2133 let coefficient_influence_flat = match joint_recon.as_ref() {
2134 Some((f, _, _, _, _)) => Some(f.iter().copied().collect::<Vec<f64>>()),
2135 None => fit
2136 .covariance_conditional
2137 .as_ref()
2138 .filter(|c| c.nrows() == expected_joint && c.ncols() == expected_joint)
2139 .and_then(|hinv| {
2140 if fit.blocks.len() != m {
2141 return None;
2142 }
2143 // Joint S_λ (block-diagonal across active classes).
2144 let mut s_lambda = Array2::<f64>::zeros((expected_joint, expected_joint));
2145 for (a, block) in fit.blocks.iter().enumerate() {
2146 if block.lambdas.len() != penalties_arc.len() {
2147 return None;
2148 }
2149 let base = a * p_per_class;
2150 for (t, pen) in penalties_arc.iter().enumerate() {
2151 let lam = block.lambdas[t];
2152 if lam == 0.0 {
2153 continue;
2154 }
2155 let dense = pen.to_dense();
2156 if dense.nrows() != p_per_class || dense.ncols() != p_per_class {
2157 return None;
2158 }
2159 for i in 0..p_per_class {
2160 for j in 0..p_per_class {
2161 s_lambda[[base + i, base + j]] += lam * dense[[i, j]];
2162 }
2163 }
2164 }
2165 }
2166 // F = I − H⁻¹ S_λ.
2167 let hinv_s = hinv.dot(&s_lambda);
2168 let mut f = Array2::<f64>::eye(expected_joint);
2169 f -= &hinv_s;
2170 Some(f.iter().copied().collect::<Vec<f64>>())
2171 }),
2172 };
2173
2174 // Per-(smooth term) coefficient span within a single class block, deduped by
2175 // col_range (the #561 double-penalty migration emits two penalty blocks per
2176 // term sharing one col_range; the Wald test covers the whole term block once).
2177 let mut smooth_term_spans: Vec<MultinomialSmoothTermSpan> = Vec::new();
2178 for (pen_idx, bp) in design.penalties.iter().enumerate() {
2179 let col_start = bp.col_range.start;
2180 let col_end = bp.col_range.end;
2181 if col_start >= col_end || col_end > p_per_class {
2182 continue;
2183 }
2184 if smooth_term_spans
2185 .iter()
2186 .any(|s| s.col_start == col_start && s.col_end == col_end)
2187 {
2188 continue;
2189 }
2190 let label = design
2191 .penaltyinfo
2192 .get(pen_idx)
2193 .and_then(|info| info.termname.clone())
2194 .unwrap_or_else(|| format!("s{pen_idx}"));
2195 let nullspace_dim = design
2196 .nullspace_dims
2197 .get(pen_idx)
2198 .copied()
2199 .unwrap_or(0)
2200 .min(col_end - col_start);
2201 smooth_term_spans.push(MultinomialSmoothTermSpan {
2202 label,
2203 col_start,
2204 col_end,
2205 nullspace_dim,
2206 });
2207 }
2208
2209 // One descriptive label per penalty *component* within a single class block,
2210 // parallel to that block's λ slice (#1544). `design.penalties` is index-
2211 // parallel to every active class's `block.lambdas` (each block carries the
2212 // full per-component penalty list, validated above by
2213 // `block.lambdas.len() == penalties_arc.len()`), so iterating it in order
2214 // yields exactly `lambdas_per_block[0]` labels aligned with the per-block λ.
2215 // This is deliberately NOT deduped by col_range (unlike `smooth_term_spans`):
2216 // the double penalty's primary and null-space components share one col_range
2217 // but select independent λ, and each must keep its own label so the summary
2218 // renderer never collapses or drops a λ.
2219 let lambda_labels: Vec<String> = design
2220 .penalties
2221 .iter()
2222 .enumerate()
2223 .map(|(pen_idx, _)| penalty_component_label(design.penaltyinfo.get(pen_idx), pen_idx))
2224 .collect();
2225
2226 // Unpenalized deviance read directly from the converged unpenalized
2227 // log-likelihood the rho-prior driver already computed (issue #348):
2228 // MultinomialFamily::evaluate sets FamilyEvaluation.log_likelihood =
2229 // log_lik(η, y) with no penalty term, and that value flows unchanged into
2230 // UnifiedFitResult.log_likelihood. This reproduces the legacy fixed-λ
2231 // path's `deviance = -2 · log_lik` contract bit-for-bit, so the previous
2232 // row-by-row η = Xβ rebuild and softmax recompute were pure dead work.
2233 let deviance = -2.0 * fit.log_likelihood;
2234
2235 Ok(MultinomialSavedModel {
2236 formula: formula.to_string(),
2237 class_levels: class_levels.clone(),
2238 reference_class_index: class_levels.len() - 1,
2239 resolved_termspec: spec,
2240 coefficients_flat,
2241 p_per_class,
2242 n_active_classes: m,
2243 training_headers: data.headers.clone(),
2244 lambdas: lambdas_flat,
2245 lambdas_per_block,
2246 iterations: fit.inner_cycles,
2247 converged: fit.outer_converged,
2248 penalized_neg_log_likelihood: -fit.log_likelihood + 0.5 * fit.stable_penalty_term,
2249 deviance,
2250 edf_per_class,
2251 edf_per_penalty,
2252 coefficient_covariance_flat,
2253 coefficient_influence_flat,
2254 smooth_term_spans,
2255 lambda_labels,
2256 })
2257}
2258
2259/// Replay the saved termspec to build the predict-time dense design `X` on a
2260/// fresh dataset, realigning feature columns **by name** so the predict frame
2261/// need not reproduce the training column order or carry the response column.
2262/// Shared by every multinomial predict path (probabilities, SE bands, and the
2263/// posterior-predictive replicate draws).
2264fn build_multinomial_predict_design(
2265 model: &MultinomialSavedModel,
2266 data: &EncodedDataset,
2267) -> Result<Array2<f64>, EstimationError> {
2268 // The saved termspec stores feature columns as absolute indices into the
2269 // *training* table `[response, features...]`. Realign them onto this
2270 // dataset's columns by name, so prediction works on label-free new data
2271 // (the response column is never referenced by any term; issue #803).
2272 let predict_columns = data.column_map();
2273 let realigned = model.resolved_termspec.remap_feature_columns(
2274 |index| -> Result<usize, EstimationError> {
2275 let name = model.training_headers.get(index).ok_or_else(|| {
2276 EstimationError::InvalidInput(format!(
2277 "multinomial predict: saved training column index {index} is out of bounds \
2278 for {} training headers",
2279 model.training_headers.len()
2280 ))
2281 })?;
2282 resolve_role_col(&predict_columns, name, "feature")
2283 .map_err(|err| EstimationError::InvalidInput(err.to_string()))
2284 },
2285 )?;
2286 let design = build_term_collection_design(data.values.view(), &realigned).map_err(|err| {
2287 EstimationError::InvalidInput(format!(
2288 "multinomial predict: rebuild design from saved termspec: {err}"
2289 ))
2290 })?;
2291 let x_dense = design
2292 .design
2293 .try_to_dense_by_chunks("multinomial predict design")
2294 .map_err(EstimationError::InvalidInput)?;
2295 if x_dense.ncols() != model.p_per_class {
2296 crate::bail_invalid_estim!(
2297 "multinomial predict: predict design has {} cols, saved model expects {}",
2298 x_dense.ncols(),
2299 model.p_per_class
2300 );
2301 }
2302 Ok(x_dense)
2303}
2304
2305/// Replay the saved termspec to build the predict-time design on a fresh
2306/// dataset, then evaluate softmax probabilities. The predict dataset must carry
2307/// the same feature columns the training data did, matched **by name** — it need
2308/// not reproduce the training column order, and in particular need not carry the
2309/// response column (prediction is for label-free new data).
2310pub fn predict_multinomial_formula(
2311 model: &MultinomialSavedModel,
2312 data: &EncodedDataset,
2313) -> Result<Array2<f64>, EstimationError> {
2314 let x_dense = build_multinomial_predict_design(model, data)?;
2315 Ok(model.predict_probabilities(x_dense.view()))
2316}
2317
2318/// Draw `n_draws` posterior-predictive replicate class-label assignments for a
2319/// saved multinomial model on fresh data (#1101). Rebuilds the predict design
2320/// exactly as [`predict_multinomial_formula`], then samples each row's class
2321/// from `Categorical(softmax(X·β̂))` (see
2322/// [`MultinomialSavedModel::sample_replicate_classes`]). Returns an
2323/// `(n_draws, N)` matrix of class INDICES `0..K` aligned to `model.class_levels`,
2324/// deterministic in `seed`.
2325pub fn posterior_predict_multinomial_formula(
2326 model: &MultinomialSavedModel,
2327 data: &EncodedDataset,
2328 n_draws: usize,
2329 seed: u64,
2330) -> Result<Array2<u32>, EstimationError> {
2331 if n_draws == 0 {
2332 crate::bail_invalid_estim!("multinomial posterior_predict: n_draws must be >= 1");
2333 }
2334 let x_dense = build_multinomial_predict_design(model, data)?;
2335 Ok(model.sample_replicate_classes(x_dense.view(), n_draws, seed))
2336}
2337
2338/// Predict class probabilities AND delta-method per-class probability standard
2339/// errors for a saved multinomial model on fresh data (#1101). Replays the
2340/// saved termspec to build the predict design exactly as
2341/// [`predict_multinomial_formula`], then applies the softmax-Jacobian delta
2342/// method against the stored joint posterior covariance. Returns
2343/// `(probs (N,K), prob_se (N,K) | None)`; `prob_se` is `None` for a legacy
2344/// model fitted before covariance was surfaced.
2345pub fn predict_multinomial_formula_with_se(
2346 model: &MultinomialSavedModel,
2347 data: &EncodedDataset,
2348) -> Result<(Array2<f64>, Option<Array2<f64>>), EstimationError> {
2349 let x_dense = build_multinomial_predict_design(model, data)?;
2350 Ok(model.predict_probabilities_with_se(x_dense.view()))
2351}
2352
2353#[cfg(test)]
2354mod fisher_override_tests {
2355 use super::*;
2356 use ndarray::Array3;
2357
2358 fn toy() -> (Array2<f64>, Array2<f64>, Array2<f64>, Array1<f64>) {
2359 let n = 15;
2360 let p = 2;
2361 let k = 3;
2362 let design =
2363 Array2::<f64>::from_shape_fn(
2364 (n, p),
2365 |(i, j)| {
2366 if j == 0 { 1.0 } else { ((i + 2) as f64).cos() }
2367 },
2368 );
2369 let mut y = Array2::<f64>::zeros((n, k));
2370 for i in 0..n {
2371 y[[i, i % k]] = 1.0;
2372 }
2373 let penalty = Array2::<f64>::eye(p);
2374 let lambdas = Array1::<f64>::from_elem(k - 1, 0.5);
2375 (design, y, penalty, lambdas)
2376 }
2377
2378 #[test]
2379 fn fisher_override_none_reproduces_analytic() {
2380 // Issue #349: None override is exactly the analytic fit.
2381 let (design, y, penalty, lambdas) = toy();
2382 let mk = |over: Option<ndarray::ArrayView3<'_, f64>>| {
2383 fit_penalized_multinomial(MultinomialFitInputs {
2384 design: design.view(),
2385 y_one_hot: y.view(),
2386 penalty: penalty.view(),
2387 lambdas: lambdas.view(),
2388 row_weights: None,
2389 fisher_w_override: over,
2390 max_iter: 50,
2391 tol: 1.0e-9,
2392 })
2393 .expect("fit must succeed")
2394 };
2395 let a = mk(None);
2396 let b = mk(None);
2397 for (x, z) in a
2398 .coefficients_active
2399 .iter()
2400 .zip(b.coefficients_active.iter())
2401 {
2402 assert_eq!(x, z);
2403 }
2404 }
2405
2406 #[test]
2407 fn fisher_override_wrong_shape_is_rejected() {
2408 let (design, y, penalty, lambdas) = toy();
2409 let n = design.nrows();
2410 let m = y.ncols(); // K, not K-1 — deliberately wrong
2411 let bad = Array3::<f64>::zeros((n, m, m));
2412 let err = fit_penalized_multinomial(MultinomialFitInputs {
2413 design: design.view(),
2414 y_one_hot: y.view(),
2415 penalty: penalty.view(),
2416 lambdas: lambdas.view(),
2417 row_weights: None,
2418 fisher_w_override: Some(bad.view()),
2419 max_iter: 50,
2420 tol: 1.0e-9,
2421 })
2422 .expect_err("wrong active-block shape must error");
2423 assert!(format!("{err}").contains("fisher_w_override shape"));
2424 }
2425
2426 /// #1101 regression: the fixed-λ inner solve now surfaces the joint Laplace
2427 /// coefficient covariance `H⁻¹`, and the multinomial predictor derives
2428 /// finite delta-method per-class probability standard errors from it. Before
2429 /// this change `MultinomialFitOutputs` carried NO covariance at all, so the
2430 /// covariance-dimension / predictor assertions below could not even compile
2431 /// (fail-before). Asserts, with un-weakened bounds:
2432 /// 1. covariance is `(P·(K−1))²`, all-finite, symmetric, and PSD (every
2433 /// diagonal ≥ 0 and `vᵀΣv ≥ 0` on probe vectors);
2434 /// 2. the delta-method per-class probability SEs are finite and within
2435 /// `[0, 1]` (a probability SE can never exceed the unit interval);
2436 /// 3. predicted probabilities are finite, in `[0, 1]`, and each row sums
2437 /// to 1 (simplex).
2438 #[test]
2439 fn covariance_and_delta_method_se_are_finite_and_wellformed_1101() {
2440 let (design, y, penalty, lambdas) = toy();
2441 let p = design.ncols();
2442 let k = y.ncols();
2443 let m = k - 1;
2444 let d = p * m;
2445
2446 let fit = fit_penalized_multinomial(MultinomialFitInputs {
2447 design: design.view(),
2448 y_one_hot: y.view(),
2449 penalty: penalty.view(),
2450 lambdas: lambdas.view(),
2451 row_weights: None,
2452 fisher_w_override: None,
2453 max_iter: 50,
2454 tol: 1.0e-9,
2455 })
2456 .expect("fit must succeed");
2457 assert!(fit.converged, "toy multinomial fit must converge");
2458
2459 // (1) Covariance shape, finiteness, symmetry.
2460 let cov = &fit.coefficient_covariance;
2461 assert_eq!(
2462 cov.dim(),
2463 (d, d),
2464 "covariance must be (P·(K−1))² = ({d},{d})"
2465 );
2466 for &v in cov.iter() {
2467 assert!(v.is_finite(), "covariance entry must be finite (got {v})");
2468 }
2469 for i in 0..d {
2470 for j in 0..d {
2471 let asym = (cov[[i, j]] - cov[[j, i]]).abs();
2472 assert!(
2473 asym <= 1e-9 * (1.0 + cov[[i, j]].abs()),
2474 "covariance must be symmetric at ({i},{j}): |Σ_ij − Σ_ji| = {asym:.3e}"
2475 );
2476 }
2477 }
2478 // PSD: diagonal ≥ 0 and quadratic forms on deterministic probe vectors
2479 // (unit axes and the all-ones vector) are non-negative. `H = XᵀWX + λS`
2480 // with W PSD (softmax Fisher) and S PSD (identity here) is positive
2481 // definite, so its inverse is PD; these probes must all be positive.
2482 for i in 0..d {
2483 assert!(
2484 cov[[i, i]] >= 0.0,
2485 "covariance diagonal[{i}] must be ≥ 0 (got {})",
2486 cov[[i, i]]
2487 );
2488 }
2489 let mut probes: Vec<Vec<f64>> = Vec::new();
2490 for i in 0..d {
2491 let mut e = vec![0.0_f64; d];
2492 e[i] = 1.0;
2493 probes.push(e);
2494 }
2495 probes.push(vec![1.0_f64; d]);
2496 for v in &probes {
2497 let mut q = 0.0_f64;
2498 for i in 0..d {
2499 for j in 0..d {
2500 q += v[i] * cov[[i, j]] * v[j];
2501 }
2502 }
2503 assert!(
2504 q >= -1e-9,
2505 "covariance must be PSD: vᵀΣv = {q:.3e} < 0"
2506 );
2507 }
2508
2509 // (2) & (3) Delta-method SEs and simplex probabilities on the training
2510 // design (any P-column matrix in the fitted basis works).
2511 let (probs, prob_se) = fit
2512 .predict_probabilities_with_se(design.view())
2513 .expect("delta-method SE must succeed");
2514 let n = design.nrows();
2515 assert_eq!(probs.dim(), (n, k));
2516 assert_eq!(prob_se.dim(), (n, k));
2517 for row in 0..n {
2518 let mut rowsum = 0.0_f64;
2519 for c in 0..k {
2520 let pc = probs[[row, c]];
2521 assert!(pc.is_finite() && (0.0..=1.0).contains(&pc), "prob[{row},{c}]={pc}");
2522 rowsum += pc;
2523 let se = prob_se[[row, c]];
2524 assert!(se.is_finite(), "prob_se[{row},{c}] must be finite (got {se})");
2525 assert!(
2526 (0.0..=1.0).contains(&se),
2527 "prob_se[{row},{c}] must be in [0,1] (got {se})"
2528 );
2529 }
2530 assert!(
2531 (rowsum - 1.0).abs() < 1e-9,
2532 "row {row} probabilities must sum to 1 (got {rowsum})"
2533 );
2534 }
2535 }
2536
2537 #[test]
2538 fn formula_outer_route_uses_exact_curvature_for_medium_d() {
2539 // The 2-smooth reference formula fit (K = 3, double-penalty terms) is
2540 // D = (K-1) * 2 terms * 2 penalties = 8 and needs exact curvature to
2541 // avoid over-smoothed lambda caps (#715 arm (a)).
2542 assert!(
2543 multinomial_formula_use_outer_hessian(8),
2544 "D=8 loaded multinomial fits need exact curvature to avoid over-smoothed lambda caps"
2545 );
2546 assert!(
2547 multinomial_formula_use_outer_hessian(12),
2548 "D=12 (3 double-penalty smooth terms, K=3) stays on exact curvature"
2549 );
2550 }
2551
2552 #[test]
2553 fn formula_outer_route_uses_exact_curvature_for_d16_penguin_fixture() {
2554 // Four k=10 penguin smooths (K = 3) are D = 16 under double-penalty
2555 // terms. They must reach the exact ARC route so the #1082 cost-stall
2556 // halt is available on the near-separable lambda-to-zero ridge.
2557 assert!(
2558 multinomial_formula_use_outer_hessian(16),
2559 "D=16 multinomial fits need exact ARC curvature for the #1082 stall halt"
2560 );
2561 }
2562
2563 #[test]
2564 fn formula_min_lambda_floor_is_continuous_and_information_scaled() {
2565 // Build a one-hot label matrix whose smallest class carries `count` rows.
2566 fn floor_for_min_count(count: usize) -> f64 {
2567 // Two classes: a large one (1000 rows) and a minority one (`count`).
2568 let n = 1000 + count;
2569 let mut y = Array2::<f64>::zeros((n, 2));
2570 for r in 0..1000 {
2571 y[[r, 0]] = 1.0;
2572 }
2573 for r in 1000..n {
2574 y[[r, 1]] = 1.0;
2575 }
2576 multinomial_formula_min_lambda(y.view())
2577 }
2578
2579 // The floor's endpoints are now DERIVED from a target prior strength in
2580 // pseudo-observations against the maximal per-observation softmax Fisher
2581 // information I₁ = ¼ (base = τ·I₁, sparse = τ_max·I₁). Pin them to the
2582 // previously fixture-calibrated values so the near-separable quality arms
2583 // (penguins, vgam softmax) — whose smallest class has n_c ≥ 50 — are
2584 // byte-for-byte unaffected: the derivation REDUCES TO the old constants
2585 // at the calibration point.
2586 let base = MULTINOMIAL_FORMULA_PRIOR_PSEUDO_OBS * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
2587 let sparse = MULTINOMIAL_FORMULA_SPARSE_PRIOR_PSEUDO_OBS_MAX
2588 * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
2589 assert!(
2590 (base - 2.0e-4).abs() < 1e-18,
2591 "derived base floor must equal the calibrated 2e-4"
2592 );
2593 assert!(
2594 (sparse - 1.0e-3).abs() < 1e-18,
2595 "derived sparse floor must equal the calibrated 1e-3"
2596 );
2597
2598 // Well-supported (n_c >= n_ref=50) sits exactly at the base floor.
2599 assert!((floor_for_min_count(50) - base).abs() < 1e-18);
2600 assert!((floor_for_min_count(200) - base).abs() < 1e-18);
2601 // Very sparse (n_c <= n_ref·base/sparse = 10) clamps to the strong floor.
2602 assert!((floor_for_min_count(10) - sparse).abs() < 1e-18);
2603 assert!((floor_for_min_count(5) - sparse).abs() < 1e-18);
2604 // No cliff at the old hard threshold: 49 vs 50 differ by < 5% (the old
2605 // step jumped 5x). Floor is monotone non-increasing in support.
2606 let f49 = floor_for_min_count(49);
2607 let f50 = floor_for_min_count(50);
2608 assert!(
2609 f49 >= f50 && f49 <= f50 * 1.05,
2610 "floor must be continuous across c0, got {f49} vs {f50}"
2611 );
2612 let f25 = floor_for_min_count(25);
2613 assert!(
2614 f25 > f50 && f25 < floor_for_min_count(10),
2615 "mid-support floor must interpolate strictly between the two endpoints"
2616 );
2617
2618 // FIRST-PRINCIPLES SCALING: in the interpolating regime the floor equals
2619 // exactly τ·I₁·(n_ref/n_c) — the effective-pseudo-observation prior held
2620 // to a fixed fraction of the per-class data information n_c·I₁. Halving
2621 // the effective sample size doubles the floor (until the cap), and the
2622 // absolute value matches the closed-form n_c-scaled prior.
2623 for &n_c in &[12usize, 16, 20, 30, 40] {
2624 let expected = base * (MULTINOMIAL_FORMULA_SPARSE_REFERENCE_SUPPORT / n_c as f64);
2625 assert!(
2626 (floor_for_min_count(n_c) - expected).abs() < 1e-15,
2627 "floor at n_c={n_c} must be τ·I₁·n_ref/n_c = {expected}, got {}",
2628 floor_for_min_count(n_c)
2629 );
2630 }
2631 // Inverse scaling with effective sample size: n_c -> n_c/2 doubles the
2632 // floor inside the unclamped band (20 and 40 are both interior; 40 < 50
2633 // so it is scaled, 20 > 10 so it is not capped).
2634 assert!(
2635 (floor_for_min_count(20) - 2.0 * floor_for_min_count(40)).abs() < 1e-15,
2636 "floor must scale like 1/n_c (effective Fisher information) in the interior band"
2637 );
2638 }
2639
2640 #[test]
2641 fn formula_penalty_scale_tracks_softmax_fisher_curvature() {
2642 assert!(
2643 (multinomial_formula_penalty_scale(2) - 0.5).abs() < 1.0e-12,
2644 "binary-logit neutral-simplex curvature scale should remain at 1/2"
2645 );
2646 assert!(
2647 (multinomial_formula_penalty_scale(3) - 4.0 / 9.0).abs() < 1.0e-12,
2648 "three-class softmax penalties should be calibrated to 2*(K-1)/K^2"
2649 );
2650 assert!(
2651 multinomial_formula_penalty_scale(5) < multinomial_formula_penalty_scale(3),
2652 "active-class Fisher curvature decreases as the simplex gains classes"
2653 );
2654 }
2655
2656 #[test]
2657 fn fixed_lambda_multinomial_reports_complete_separation() {
2658 let n = 90;
2659 let design = Array2::<f64>::from_shape_fn((n, 2), |(row, col)| match col {
2660 0 => 1.0,
2661 _ => -3.0 + 6.0 * (row as f64) / ((n - 1) as f64),
2662 });
2663 let mut y = Array2::<f64>::zeros((n, 3));
2664 for row in 0..n {
2665 let x = design[[row, 1]];
2666 let class = if x < -1.0 {
2667 0
2668 } else if x > 1.0 {
2669 1
2670 } else {
2671 2
2672 };
2673 y[[row, class]] = 1.0;
2674 }
2675 let penalty = Array2::<f64>::zeros((2, 2));
2676 let lambdas = Array1::<f64>::zeros(2);
2677 let err = fit_penalized_multinomial(MultinomialFitInputs {
2678 design: design.view(),
2679 y_one_hot: y.view(),
2680 penalty: penalty.view(),
2681 lambdas: lambdas.view(),
2682 row_weights: None,
2683 fisher_w_override: None,
2684 max_iter: 80,
2685 tol: 1.0e-12,
2686 })
2687 .expect_err("complete softmax separation must be a hard diagnostic");
2688 assert!(
2689 matches!(err, EstimationError::MultinomialSeparationDetected { .. }),
2690 "expected MultinomialSeparationDetected, got {err:?}"
2691 );
2692 assert!(
2693 err.to_string().contains("separation"),
2694 "diagnostic should mention separation, got {err}"
2695 );
2696 assert!(
2697 err.to_string().contains("active class-"),
2698 "diagnostic should name the separated active class logit, got {err}"
2699 );
2700 assert!(
2701 !err.to_string().contains("binary outcomes"),
2702 "multinomial diagnostic must not reuse the binary separation text, got {err}"
2703 );
2704 }
2705
2706 #[test]
2707 fn formula_multinomial_accepts_finite_saturated_logits() {
2708 // A saturated-but-FINITE logit surface can be a valid formula REML mode
2709 // (the #715 penguins regime: bill/flipper cleanly separate the species,
2710 // so fitted logits can legitimately exceed ±25). `outer_converged ==
2711 // false` then signals only that the driver auto-escalated to never-fail
2712 // posterior sampling about that finite mode (gam#860), NOT a separation
2713 // artifact — the adapter must accept it, never raise
2714 // `MultinomialSeparationDetected`.
2715 let saturated_states = vec![
2716 ParameterBlockState {
2717 beta: Array1::from_vec(vec![1.0, 2.0]),
2718 eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2719 },
2720 ParameterBlockState {
2721 beta: Array1::from_vec(vec![-1.0, 3.0]),
2722 eta: Array1::from_vec(vec![1.0, 25.5, -0.1]),
2723 },
2724 ];
2725 assert!(
2726 multinomial_formula_separation_diagnostic(17, 9, &saturated_states).is_none(),
2727 "a finite (even saturated, |eta|>25) formula optimum is a valid fit, \
2728 not a separation diagnostic"
2729 );
2730
2731 // Only a genuinely NON-FINITE logit — a NaN/Inf blow-up in the inner
2732 // linear algebra with no finite mode to sample about — is a real
2733 // formula-path failure.
2734 let blown_up = vec![
2735 ParameterBlockState {
2736 beta: Array1::from_vec(vec![1.0, 2.0]),
2737 eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2738 },
2739 ParameterBlockState {
2740 beta: Array1::from_vec(vec![-1.0, 3.0]),
2741 eta: Array1::from_vec(vec![1.0, f64::INFINITY, -0.1]),
2742 },
2743 ];
2744 let err = multinomial_formula_separation_diagnostic(17, 9, &blown_up)
2745 .expect("a non-finite formula logit must raise the separation diagnostic");
2746 assert!(
2747 matches!(
2748 err,
2749 EstimationError::MultinomialSeparationDetected {
2750 iteration: 17,
2751 max_abs_eta,
2752 active_class_index: 1,
2753 row_index: 1,
2754 } if !max_abs_eta.is_finite()
2755 ),
2756 "expected typed multinomial separation diagnostic at the non-finite channel, got {err:?}"
2757 );
2758 }
2759
2760 #[test]
2761 fn separation_evidence_gate_arms_firth_only_on_blowup() {
2762 // Interior fit: finite logits well inside the saturation threshold ⇒ NO
2763 // separation evidence ⇒ the unbiased criterion's mode is accepted as-is
2764 // and the Firth/Jeffreys prior stays disarmed (#715 arm (a): no 1/K
2765 // shrinkage on well-identified data).
2766 let interior = vec![
2767 ParameterBlockState {
2768 beta: Array1::from_vec(vec![1.0, 2.0]),
2769 eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2770 },
2771 ParameterBlockState {
2772 beta: Array1::from_vec(vec![-1.0, 3.0]),
2773 eta: Array1::from_vec(vec![1.0, -3.5, -0.1]),
2774 },
2775 ];
2776 assert!(
2777 multinomial_formula_separation_evidence(&interior).is_none(),
2778 "an interior finite mode must not arm the Firth refit"
2779 );
2780
2781 // Saturated but finite logits are valid formula-path modes on
2782 // near-separated real data. They must not arm the Firth refit because
2783 // the Jeffreys pull can over-regularize the held-out probabilities.
2784 let saturated = vec![
2785 ParameterBlockState {
2786 beta: Array1::from_vec(vec![1.0, 2.0]),
2787 eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2788 },
2789 ParameterBlockState {
2790 beta: Array1::from_vec(vec![-1.0, 3.0]),
2791 eta: Array1::from_vec(vec![1.0, 25.5, -0.1]),
2792 },
2793 ];
2794 assert!(
2795 multinomial_formula_separation_evidence(&saturated).is_none(),
2796 "a finite saturated formula-mode logit must not arm the Firth refit"
2797 );
2798
2799 // Non-finite logit ⇒ inner blow-up along an unbounded direction ⇒
2800 // separation evidence.
2801 let blown_up = vec![ParameterBlockState {
2802 beta: Array1::from_vec(vec![1.0, 2.0]),
2803 eta: Array1::from_vec(vec![0.2, f64::NAN, -7.0]),
2804 }];
2805 let evidence = multinomial_formula_separation_evidence(&blown_up)
2806 .expect("a non-finite logit is separation evidence");
2807 assert!(
2808 evidence.contains("non-finite logit") && evidence.contains("row 1"),
2809 "evidence must name the non-finite logit, got {evidence}"
2810 );
2811
2812 // Large finite logits below the fixed-lambda diagnostic threshold are
2813 // likewise accepted on the formula path.
2814 let near = vec![ParameterBlockState {
2815 beta: Array1::from_vec(vec![1.0, 2.0]),
2816 eta: Array1::from_vec(vec![0.2, 24.9, -24.9]),
2817 }];
2818 assert!(
2819 multinomial_formula_separation_evidence(&near).is_none(),
2820 "logits below the saturation threshold must not arm the Firth refit"
2821 );
2822 }
2823
2824 #[test]
2825 fn unresolved_probe_evidence_arms_firth_on_saturated_finite_logits() {
2826 let saturated = vec![
2827 ParameterBlockState {
2828 beta: Array1::from_vec(vec![1.0, 2.0]),
2829 eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2830 },
2831 ParameterBlockState {
2832 beta: Array1::from_vec(vec![-1.0, 3.0]),
2833 eta: Array1::from_vec(vec![1.0, 25.5, -0.1]),
2834 },
2835 ];
2836
2837 assert!(
2838 multinomial_formula_separation_evidence(&saturated).is_none(),
2839 "a converged finite saturated formula optimum remains unbiased"
2840 );
2841 let evidence = multinomial_formula_unresolved_probe_separation_evidence(&saturated)
2842 .expect("a non-converged saturated probe should arm the Firth refit");
2843 assert!(
2844 evidence.contains("separation-scale finite logit")
2845 && evidence.contains("row 1")
2846 && evidence.contains("active class 1"),
2847 "unresolved-probe evidence should name the saturated channel, got {evidence}"
2848 );
2849
2850 let near = vec![ParameterBlockState {
2851 beta: Array1::from_vec(vec![1.0, 2.0]),
2852 eta: Array1::from_vec(vec![0.2, 24.9, -24.9]),
2853 }];
2854 assert!(
2855 multinomial_formula_unresolved_probe_separation_evidence(&near).is_none(),
2856 "finite logits below the separation threshold still get the full unbiased retry"
2857 );
2858 }
2859
2860 #[test]
2861 fn scaled_fisher_override_changes_first_step() {
2862 // Curvature scaled by 4× shrinks the first Newton step relative to the
2863 // analytic fit, so a single-iteration fit must differ.
2864 let (design, y, penalty, lambdas) = toy();
2865 let n = design.nrows();
2866 let m = y.ncols() - 1;
2867 // Analytic block at β = 0: p_a = 1/K = 1/3, so diag = p_a(1−p_a),
2868 // off-diag = −p_a p_b. Scale that exact block by 4.
2869 let pk = 1.0 / (y.ncols() as f64);
2870 let mut over = Array3::<f64>::zeros((n, m, m));
2871 for row in 0..n {
2872 for a in 0..m {
2873 for b in 0..m {
2874 let analytic = if a == b { pk * (1.0 - pk) } else { -pk * pk };
2875 over[[row, a, b]] = 4.0 * analytic;
2876 }
2877 }
2878 }
2879 let scaled = fit_penalized_multinomial(MultinomialFitInputs {
2880 design: design.view(),
2881 y_one_hot: y.view(),
2882 penalty: penalty.view(),
2883 lambdas: lambdas.view(),
2884 row_weights: None,
2885 fisher_w_override: Some(over.view()),
2886 max_iter: 1,
2887 tol: 1.0e-9,
2888 })
2889 .expect("override fit must succeed");
2890 let analytic = fit_penalized_multinomial(MultinomialFitInputs {
2891 design: design.view(),
2892 y_one_hot: y.view(),
2893 penalty: penalty.view(),
2894 lambdas: lambdas.view(),
2895 row_weights: None,
2896 fisher_w_override: None,
2897 max_iter: 1,
2898 tol: 1.0e-9,
2899 })
2900 .expect("analytic fit must succeed");
2901 let differs = scaled
2902 .coefficients_active
2903 .iter()
2904 .zip(analytic.coefficients_active.iter())
2905 .any(|(a, b)| (a - b).abs() > 1.0e-6);
2906 assert!(differs, "scaled curvature must change the first step");
2907 }
2908}
2909
2910#[cfg(test)]
2911mod reference_class_invariance_tests {
2912 //! Regression for #1587: a penalized multinomial-logit GAM fit must be
2913 //! invariant to which class is the (arbitrary) softmax reference/baseline.
2914 //!
2915 //! The production REML path (`fit_penalized_multinomial_formula`) reference-
2916 //! codes the `K` classes (the last sorted label is the baseline) and, with
2917 //! the legacy `Diagonal` penalty metric, penalizes only the `K−1`
2918 //! reference-anchored ALR contrasts `½ Σ_a λ_a β_aᵀ S β_a`. Relabeling the
2919 //! response so a *different* class sorts last penalizes a different frame of
2920 //! log-odds contrasts, so the predicted probabilities drift (~1e-2 absolute)
2921 //! even though they are mathematically independent of the reference choice.
2922 //!
2923 //! This test fits the SAME 3-class softmax sample under three cyclic
2924 //! relabelings — each making a different original class the baseline —
2925 //! realigns the predicted probability columns back to the original class
2926 //! identities, and asserts the cross-labeling drift is below `1e-3`
2927 //! (the defect is ~1e-2; refitting the same labeling twice agrees to
2928 //! ~1e-12). It is the Rust-level sibling of
2929 //! `tests/bug_hunt_multinomial_fit_depends_on_reference_class_test.py`.
2930
2931 use super::*;
2932 use gam_data::load_dataset_projected;
2933 use std::fmt::Write as _;
2934 use std::fs;
2935 use tempfile::tempdir;
2936
2937 /// Deterministic `splitmix64` → `[0,1)` uniform stream (no external RNG dep;
2938 /// the only requirement is a well-distributed, reproducible draw).
2939 struct SplitMix64(u64);
2940 impl SplitMix64 {
2941 fn next_u64(&mut self) -> u64 {
2942 self.0 = self.0.wrapping_add(0x9E37_79B9_7F4A_7C15);
2943 let mut z = self.0;
2944 z = (z ^ (z >> 30)).wrapping_mul(0xBF58_476D_1CE4_E5B9);
2945 z = (z ^ (z >> 27)).wrapping_mul(0x94D0_49BB_1331_11EB);
2946 z ^ (z >> 31)
2947 }
2948 fn unit(&mut self) -> f64 {
2949 // 53-bit mantissa uniform in [0, 1).
2950 (self.next_u64() >> 11) as f64 / (1u64 << 53) as f64
2951 }
2952 }
2953
2954 /// Draw a clean 3-class softmax regression sample (the issue's generator).
2955 /// Returns `(x, class)` with integer classes `0/1/2`.
2956 fn sample_classes(seed: u64, n: usize) -> (Vec<f64>, Vec<usize>) {
2957 let mut rng = SplitMix64(seed.wrapping_add(0x1234_5678));
2958 let mut x = Vec::with_capacity(n);
2959 let mut cls = Vec::with_capacity(n);
2960 for _ in 0..n {
2961 let xi = -2.0 + 4.0 * rng.unit();
2962 let eta = [0.5 + 0.8 * xi, -0.3 - 0.5 * xi, 0.0];
2963 let mut p = [eta[0].exp(), eta[1].exp(), eta[2].exp()];
2964 let s: f64 = p.iter().sum();
2965 for v in &mut p {
2966 *v /= s;
2967 }
2968 // Inverse-CDF draw into one of the 3 classes.
2969 let u = rng.unit();
2970 let c = if u < p[0] {
2971 0
2972 } else if u < p[0] + p[1] {
2973 1
2974 } else {
2975 2
2976 };
2977 x.push(xi);
2978 cls.push(c);
2979 }
2980 (x, cls)
2981 }
2982
2983 /// Build an `EncodedDataset` with columns `x` (numeric) and `y`
2984 /// (categorical, from the given string labels) by round-tripping a CSV.
2985 fn dataset_xy(dir: &std::path::Path, tag: &str, x: &[f64], y: &[String]) -> gam_data::EncodedDataset {
2986 let path = dir.join(format!("data_{tag}.csv"));
2987 let mut csv = String::from("x,y\n");
2988 for (xi, yi) in x.iter().zip(y.iter()) {
2989 writeln!(csv, "{xi},{yi}").unwrap();
2990 }
2991 fs::write(&path, csv).expect("write training csv");
2992 load_dataset_projected(&path, &["x".to_string(), "y".to_string()])
2993 .expect("load training dataset")
2994 }
2995
2996 /// Fit `y ~ s(x)` under the relabeling `name_map` (original class `c` gets
2997 /// label `name_map[c]`), predict on `grid`, and return the predicted
2998 /// probabilities **realigned to the original class order** 0/1/2, shape
2999 /// `(grid.len(), 3)`.
3000 fn fit_predict_aligned(
3001 dir: &std::path::Path,
3002 tag: &str,
3003 x: &[f64],
3004 cls: &[usize],
3005 name_map: [&str; 3],
3006 grid: &[f64],
3007 ) -> Array2<f64> {
3008 let labels: Vec<String> = cls.iter().map(|&c| name_map[c].to_string()).collect();
3009 let train = dataset_xy(dir, tag, x, &labels);
3010 let config = FitConfig::default();
3011 let model = fit_penalized_multinomial_formula(&train, "y ~ s(x)", &config, 1.0, 60, 1e-6)
3012 .expect("multinomial formula fit must succeed");
3013
3014 // Predict on the grid. The categorical `y` column is not needed for
3015 // prediction, but the schema is simplest if we supply a dummy.
3016 let grid_y: Vec<String> = grid.iter().map(|_| name_map[0].to_string()).collect();
3017 let grid_ds = dataset_xy(dir, &format!("{tag}_grid"), grid, &grid_y);
3018 let probs = predict_multinomial_formula(&model, &grid_ds)
3019 .expect("multinomial predict must succeed");
3020
3021 // `model.class_levels` is the sorted label order; the column for original
3022 // class `c` is at the rank of `name_map[c]` among the sorted labels.
3023 let mut sorted: Vec<&str> = name_map.to_vec();
3024 sorted.sort_unstable();
3025 let col_of_orig: Vec<usize> = (0..3)
3026 .map(|c| sorted.iter().position(|l| *l == name_map[c]).unwrap())
3027 .collect();
3028 // Sanity: the model's class_levels must match the sorted labels.
3029 assert_eq!(
3030 model.class_levels,
3031 sorted.iter().map(|s| s.to_string()).collect::<Vec<_>>(),
3032 "class_levels must be the sorted label order"
3033 );
3034 let n = grid.len();
3035 let mut aligned = Array2::<f64>::zeros((n, 3));
3036 for r in 0..n {
3037 for c in 0..3 {
3038 aligned[[r, c]] = probs[[r, col_of_orig[c]]];
3039 }
3040 }
3041 aligned
3042 }
3043
3044 fn max_abs_diff(a: &Array2<f64>, b: &Array2<f64>) -> f64 {
3045 a.iter()
3046 .zip(b.iter())
3047 .map(|(p, q)| (p - q).abs())
3048 .fold(0.0_f64, f64::max)
3049 }
3050
3051 // gam#1587: now that the reference-symmetric centered `M⊗S_t` joint penalty
3052 // is wired through the custom-family outer REML loop (per-eval
3053 // `JointPenaltyBundle` + outer penalty_coords/logdet/operator), the
3054 // production multinomial fit is invariant to the arbitrary reference class,
3055 // so this guard runs by default (the opt-in skip attribute it carried while
3056 // the fix was pending is also forbidden by the build.rs ban-scanner). It is
3057 // an end-to-end fit guard (a handful of full softmax `y ~ s(x)` fits) —
3058 // slower than a unit test but a true production-path regression.
3059 #[test]
3060 fn multinomial_fit_is_invariant_to_reference_class_1587() {
3061 let td = tempdir().expect("tempdir");
3062 let dir = td.path();
3063 // The reference-class drift is STRUCTURAL (it does not shrink with n, see
3064 // the issue table), so a modest n exposes it just as cleanly as n=900
3065 // while keeping this an affordable CI guard.
3066 let (x, cls) = sample_classes(0, 300);
3067 let grid: Vec<f64> = (0..7).map(|i| -1.5 + 3.0 * (i as f64) / 6.0).collect();
3068
3069 // Three labelings that each make a DIFFERENT original class the baseline
3070 // (the class whose label sorts LAST is the reference K−1):
3071 // ["A","B","C"] → ref = class 2
3072 // ["B","C","A"] → ref = class 1
3073 // ["C","A","B"] → ref = class 0
3074 let a = fit_predict_aligned(dir, "abc", &x, &cls, ["A", "B", "C"], &grid);
3075 let b = fit_predict_aligned(dir, "bca", &x, &cls, ["B", "C", "A"], &grid);
3076 let c = fit_predict_aligned(dir, "cab", &x, &cls, ["C", "A", "B"], &grid);
3077
3078 // Refitting the SAME labeling twice must agree to ~machine precision —
3079 // this isolates optimizer noise from the structural reference drift.
3080 let a2 = fit_predict_aligned(dir, "abc2", &x, &cls, ["A", "B", "C"], &grid);
3081 let refit_noise = max_abs_diff(&a, &a2);
3082 assert!(
3083 refit_noise < 1e-6,
3084 "refitting the same labeling must be deterministic (got {refit_noise:.3e})"
3085 );
3086
3087 let drift = max_abs_diff(&a, &b)
3088 .max(max_abs_diff(&a, &c))
3089 .max(max_abs_diff(&b, &c));
3090 assert!(
3091 drift < 1e-3,
3092 "predicted probabilities must be invariant to the reference class; \
3093 cross-labeling drift = {drift:.3e} (refit noise = {refit_noise:.3e})"
3094 );
3095 }
3096}