use crate::families::custom_family::{
BlockwiseFitOptions, ParameterBlockState, fit_custom_family_with_rho_prior,
};
use crate::families::multinomial_reml::MultinomialFamily;
use crate::families::penalized_vector_glm::{PenalizedVectorGlmInputs, fit_penalized_vector_glm};
use crate::families::vector_response::{MultinomialLogitLikelihood, validate_multinomial_simplex};
use crate::inference::data::EncodedDataset;
use crate::inference::formula_dsl::parse_formula;
use crate::inference::model::ColumnKindTag;
use crate::resource::ProblemHints;
use crate::solver::estimate::EstimationError;
use crate::solver::workflow::{
FitConfig, build_termspec_with_geometry_and_overrides, resolved_resource_policy,
};
use crate::terms::smooth::{
TermCollectionDesign, TermCollectionSpec, build_term_collection_design,
};
use crate::terms::term_builder::resolve_role_col;
use crate::types::ResponseColumnKind;
use ndarray::{Array1, Array2, ArrayView1, ArrayView2, ArrayView3};
use serde::{Deserialize, Serialize};
use std::sync::Arc;
const MULTINOMIAL_FORMULA_RIDGE_FLOOR: f64 = 1.0e-4;
const MULTINOMIAL_EXACT_OUTER_HESSIAN_MAX_DIM: usize = 6;
fn multinomial_formula_use_outer_hessian(total_rho_dim: usize) -> bool {
total_rho_dim <= MULTINOMIAL_EXACT_OUTER_HESSIAN_MAX_DIM
}
const MULTINOMIAL_SEPARATION_ETA_THRESHOLD: f64 = 25.0;
fn max_abs_eta_location(eta: ArrayView2<'_, f64>) -> (f64, usize, usize) {
let mut best = (0.0_f64, 0usize, 0usize);
for ((row, active_class), &value) in eta.indexed_iter() {
let abs = value.abs();
if abs > best.0 {
best = (abs, row, active_class);
}
}
best
}
fn multinomial_formula_separation_diagnostic(
inner_cycles: usize,
outer_iterations: usize,
block_states: &[ParameterBlockState],
) -> Option<EstimationError> {
let mut nonfinite: Option<(f64, usize, usize)> = None;
for (active_class, state) in block_states.iter().enumerate() {
for (row, &value) in state.eta.iter().enumerate() {
if !value.is_finite() {
nonfinite = Some((value, row, active_class));
break;
}
}
if nonfinite.is_some() {
break;
}
}
nonfinite.map(|(value, row_index, active_class_index)| {
EstimationError::MultinomialSeparationDetected {
iteration: inner_cycles.max(outer_iterations),
max_abs_eta: value.abs(),
active_class_index,
row_index,
}
})
}
#[derive(Debug, Clone)]
pub struct MultinomialFitInputs<'a> {
pub design: ArrayView2<'a, f64>,
pub y_one_hot: ArrayView2<'a, f64>,
pub penalty: ArrayView2<'a, f64>,
pub lambdas: ArrayView1<'a, f64>,
pub row_weights: Option<ArrayView1<'a, f64>>,
pub fisher_w_override: Option<ArrayView3<'a, f64>>,
pub max_iter: usize,
pub tol: f64,
}
#[derive(Debug, Clone)]
pub struct MultinomialFitOutputs {
pub coefficients_active: Array2<f64>,
pub fitted_probabilities: Array2<f64>,
pub iterations: usize,
pub converged: bool,
pub penalized_neg_log_likelihood: f64,
pub deviance: f64,
}
pub fn fit_penalized_multinomial(
inputs: MultinomialFitInputs<'_>,
) -> Result<MultinomialFitOutputs, EstimationError> {
let MultinomialFitInputs {
design,
y_one_hot,
penalty,
lambdas,
row_weights,
fisher_w_override,
max_iter,
tol,
} = inputs;
let n_obs = design.nrows();
let (y_rows, k) = y_one_hot.dim();
if y_rows != n_obs {
crate::bail_invalid_estim!(
"fit_penalized_multinomial: y rows {y_rows} ≠ design rows {n_obs}"
);
}
if k < 2 {
crate::bail_invalid_estim!(
"fit_penalized_multinomial: need at least 2 classes (got K={k})"
);
}
let m = k - 1;
if lambdas.len() != m {
crate::bail_invalid_estim!(
"fit_penalized_multinomial: lambdas length {} ≠ K-1 = {m}",
lambdas.len()
);
}
if let Some(fw) = fisher_w_override.as_ref() {
if fw.dim() != (n_obs, m, m) {
crate::bail_invalid_estim!(
"fit_penalized_multinomial: fisher_w_override shape {:?} ≠ (N, K-1, K-1) = ({n_obs}, {m}, {m})",
fw.dim()
);
}
}
if let Some(w) = row_weights.as_ref() {
if w.len() != n_obs {
crate::bail_invalid_estim!(
"fit_penalized_multinomial: row_weights length {} ≠ N = {n_obs}",
w.len()
);
}
for (i, &v) in w.iter().enumerate() {
if !(v.is_finite() && v >= 0.0) {
crate::bail_invalid_estim!(
"fit_penalized_multinomial: row_weights[{i}] must be finite and ≥ 0 (got {v})"
);
}
}
}
validate_multinomial_simplex(y_one_hot, "fit_penalized_multinomial")?;
let mut likelihood = MultinomialLogitLikelihood::with_classes(k)?;
if let Some(w) = row_weights.as_ref() {
likelihood = likelihood.with_row_weights(w.to_owned())?;
}
let fit = fit_penalized_vector_glm(
PenalizedVectorGlmInputs {
design,
y: y_one_hot,
penalty,
lambdas,
fisher_w_override,
max_iter,
tol,
},
&likelihood,
"fit_penalized_multinomial",
)?;
let (max_abs_eta, row_index, active_class_index) = max_abs_eta_location(fit.eta.view());
if !fit.converged && max_abs_eta >= MULTINOMIAL_SEPARATION_ETA_THRESHOLD {
return Err(EstimationError::MultinomialSeparationDetected {
iteration: fit.iterations,
max_abs_eta,
active_class_index,
row_index,
});
}
let fitted_probabilities = likelihood.probabilities(fit.eta.view());
Ok(MultinomialFitOutputs {
coefficients_active: fit.coefficients,
fitted_probabilities,
iterations: fit.iterations,
converged: fit.converged,
penalized_neg_log_likelihood: -fit.log_likelihood + fit.penalty_term,
deviance: -2.0 * fit.log_likelihood,
})
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MultinomialSavedModel {
pub formula: String,
pub class_levels: Vec<String>,
pub reference_class_index: usize,
pub resolved_termspec: TermCollectionSpec,
pub coefficients_flat: Vec<f64>,
pub p_per_class: usize,
pub n_active_classes: usize,
pub training_headers: Vec<String>,
pub lambdas: Vec<f64>,
pub lambdas_per_block: Vec<usize>,
pub iterations: usize,
pub converged: bool,
pub penalized_neg_log_likelihood: f64,
pub deviance: f64,
#[serde(default)]
pub edf_per_class: Option<Vec<f64>>,
}
impl MultinomialSavedModel {
pub fn coefficients_active(&self) -> Array2<f64> {
Array2::from_shape_vec(
(self.p_per_class, self.n_active_classes),
self.coefficients_flat.clone(),
)
.expect(
"MultinomialSavedModel.coefficients_flat length must equal p_per_class * n_active_classes",
)
}
pub fn predict_probabilities(&self, x_new: ArrayView2<'_, f64>) -> Array2<f64> {
let n_new = x_new.nrows();
let p = self.p_per_class;
let m = self.n_active_classes;
let k = m + 1;
assert_eq!(
x_new.ncols(),
p,
"MultinomialSavedModel.predict_probabilities: X has {} cols, expected {p}",
x_new.ncols()
);
let beta = self.coefficients_active();
let mut probs = Array2::<f64>::zeros((n_new, k));
let mut eta_active = vec![0.0_f64; m];
let mut row_probs = vec![0.0_f64; k];
for row in 0..n_new {
for a in 0..m {
let mut v = 0.0_f64;
for i in 0..p {
v += x_new[[row, i]] * beta[[i, a]];
}
eta_active[a] = v;
}
MultinomialLogitLikelihood::softmax_with_baseline(&eta_active, &mut row_probs);
for c in 0..k {
probs[[row, c]] = row_probs[c];
}
}
probs
}
}
fn one_hot_categorical_response(
data: &EncodedDataset,
y_col: usize,
response_name: &str,
) -> Result<(Array2<f64>, Vec<String>), EstimationError> {
let levels: Vec<String> = data
.schema
.columns
.get(y_col)
.map(|sc| sc.levels.clone())
.unwrap_or_default();
if levels.len() < 2 {
crate::bail_invalid_estim!(
"multinomial response '{response_name}' must have at least 2 categorical levels (got {})",
levels.len()
);
}
let n = data.values.nrows();
let k = levels.len();
let mut y_one_hot = Array2::<f64>::zeros((n, k));
for row in 0..n {
let encoded = data.values[[row, y_col]];
if !encoded.is_finite() {
crate::bail_invalid_estim!(
"multinomial response '{response_name}' row {row} is non-finite ({encoded})"
);
}
let class_idx = encoded.round() as i64;
if class_idx < 0 || (class_idx as usize) >= k {
crate::bail_invalid_estim!(
"multinomial response '{response_name}' row {row} encoded as {encoded} \
is outside the level range 0..{k}"
);
}
y_one_hot[[row, class_idx as usize]] = 1.0;
}
Ok((y_one_hot, levels))
}
fn build_formula_design_for_multinomial(
formula: &str,
data: &EncodedDataset,
config: &FitConfig,
) -> Result<
(
TermCollectionSpec,
TermCollectionDesign,
usize,
String,
ResponseColumnKind,
),
EstimationError,
> {
let parsed = parse_formula(formula).map_err(|err| {
EstimationError::InvalidInput(format!(
"multinomial fit: failed to parse formula {formula:?}: {err}"
))
})?;
let col_map = data.column_map();
let y_col = resolve_role_col(&col_map, &parsed.response, "response")
.map_err(|err| EstimationError::InvalidInput(format!("multinomial fit: {err}")))?;
let y_kind = crate::solver::workflow::response_column_kind(data, y_col);
let policy = resolved_resource_policy(config, data, ProblemHints::default());
let mut inference_notes: Vec<String> = Vec::new();
let spec = build_termspec_with_geometry_and_overrides(
&parsed.terms,
data,
&col_map,
&mut inference_notes,
config.scale_dimensions,
&policy,
config.smooth_overrides.as_ref(),
)
.map_err(|err| {
EstimationError::InvalidInput(format!("multinomial fit: build termspec: {err}"))
})?;
let design = build_term_collection_design(data.values.view(), &spec).map_err(|err| {
EstimationError::InvalidInput(format!("multinomial fit: build design: {err}"))
})?;
Ok((spec, design, y_col, parsed.response, y_kind))
}
pub fn fit_penalized_multinomial_formula(
data: &EncodedDataset,
formula: &str,
config: &FitConfig,
init_lambda: f64,
max_iter: usize,
tol: f64,
) -> Result<MultinomialSavedModel, EstimationError> {
if !(init_lambda.is_finite() && init_lambda > 0.0) {
crate::bail_invalid_estim!(
"multinomial fit: init_lambda must be finite and > 0 (got {init_lambda})"
);
}
let (spec, design, y_col, response_name, y_kind) =
build_formula_design_for_multinomial(formula, data, config)?;
let class_levels = match y_kind {
ResponseColumnKind::Categorical { levels } => levels,
ResponseColumnKind::Binary => vec!["0".to_string(), "1".to_string()],
ResponseColumnKind::Numeric => {
crate::bail_invalid_estim!(
"multinomial fit: response '{response_name}' is numeric, not categorical; \
use family='gaussian'/'binomial'/... or convert the column to a categorical type"
);
}
};
if data.column_kinds.get(y_col) == Some(&ColumnKindTag::Binary) {
} else if data.column_kinds.get(y_col) != Some(&ColumnKindTag::Categorical) {
crate::bail_invalid_estim!(
"multinomial fit: response '{response_name}' must be a categorical column \
(got column kind {:?})",
data.column_kinds.get(y_col)
);
}
let (y_one_hot, _) = one_hot_categorical_response(data, y_col, &response_name)?;
let x_dense = design
.design
.try_to_dense_by_chunks("multinomial fit design")
.map_err(EstimationError::InvalidInput)?;
let per_term_penalties = design.penalties_as_penalty_matrix();
let per_term_nullspace_dims = design.nullspace_dims.clone();
let k = y_one_hot.ncols();
let m = k - 1;
let n_obs = y_one_hot.nrows();
let design_arc = Arc::new(x_dense);
let penalties_arc = Arc::new(per_term_penalties);
let nullspace_dims_arc = Arc::new(per_term_nullspace_dims);
let weights = Array1::<f64>::ones(n_obs);
let family = MultinomialFamily::new(
y_one_hot.clone(),
weights,
k,
design_arc.clone(),
penalties_arc.clone(),
nullspace_dims_arc.clone(),
)
.map_err(EstimationError::InvalidInput)?;
let mut blocks = family.build_block_specs();
let log_init = init_lambda.ln();
for spec_block in blocks.iter_mut() {
for v in spec_block.initial_log_lambdas.iter_mut() {
*v = log_init;
}
}
let total_rho_dim = m.saturating_mul(penalties_arc.len());
let use_outer_hessian = multinomial_formula_use_outer_hessian(total_rho_dim);
let outer_max_iter = max_iter.max(1);
let outer_tol = if tol.is_finite() && tol > 0.0 {
tol
} else {
BlockwiseFitOptions::default().outer_tol
};
let inner_tol = BlockwiseFitOptions::default().inner_tol.max(tol.max(0.0));
let options = BlockwiseFitOptions {
inner_max_cycles: crate::custom_family::DEFAULT_CUSTOM_FAMILY_INNER_MAX_CYCLES,
inner_tol,
outer_max_iter,
outer_tol,
ridge_floor: MULTINOMIAL_FORMULA_RIDGE_FLOOR,
ridge_policy: crate::types::RidgePolicy::solver_only(),
use_outer_hessian,
..BlockwiseFitOptions::default()
};
let fit =
fit_custom_family_with_rho_prior(&family, &blocks, &options, crate::types::RhoPrior::Flat)
.map_err(|err| EstimationError::InvalidInput(format!("multinomial REML: {err}")))?;
if let Some(err) = multinomial_formula_separation_diagnostic(
fit.inner_cycles,
fit.outer_iterations,
&fit.block_states,
) {
return Err(err);
}
if fit.blocks.len() != m {
crate::bail_invalid_estim!(
"multinomial REML: expected {m} fitted blocks (K-1), got {}",
fit.blocks.len()
);
}
let p_per_class = fit.blocks[0].beta.len();
let mut coefficients_active = Array2::<f64>::zeros((p_per_class, m));
for (a, block) in fit.blocks.iter().enumerate() {
if block.beta.len() != p_per_class {
crate::bail_invalid_estim!(
"multinomial REML: block {a} has {} coefs, expected {p_per_class}",
block.beta.len()
);
}
for i in 0..p_per_class {
coefficients_active[[i, a]] = block.beta[i];
}
}
let lambdas_per_block: Vec<usize> = fit.blocks.iter().map(|b| b.lambdas.len()).collect();
let lambdas_flat: Vec<f64> = fit
.blocks
.iter()
.flat_map(|b| b.lambdas.iter().copied())
.collect();
let edf_per_class = fit.inference.as_ref().map(|info| info.edf_by_block.clone());
let coefficients_flat: Vec<f64> = coefficients_active.iter().copied().collect();
let deviance = -2.0 * fit.log_likelihood;
Ok(MultinomialSavedModel {
formula: formula.to_string(),
class_levels: class_levels.clone(),
reference_class_index: class_levels.len() - 1,
resolved_termspec: spec,
coefficients_flat,
p_per_class,
n_active_classes: m,
training_headers: data.headers.clone(),
lambdas: lambdas_flat,
lambdas_per_block,
iterations: fit.inner_cycles,
converged: fit.outer_converged,
penalized_neg_log_likelihood: -fit.log_likelihood + 0.5 * fit.stable_penalty_term,
deviance,
edf_per_class,
})
}
pub fn predict_multinomial_formula(
model: &MultinomialSavedModel,
data: &EncodedDataset,
) -> Result<Array2<f64>, EstimationError> {
let predict_columns = data.column_map();
let realigned = model.resolved_termspec.remap_feature_columns(
|index| -> Result<usize, EstimationError> {
let name = model.training_headers.get(index).ok_or_else(|| {
EstimationError::InvalidInput(format!(
"multinomial predict: saved training column index {index} is out of bounds \
for {} training headers",
model.training_headers.len()
))
})?;
resolve_role_col(&predict_columns, name, "feature")
.map_err(|err| EstimationError::InvalidInput(err.to_string()))
},
)?;
let design = build_term_collection_design(data.values.view(), &realigned).map_err(|err| {
EstimationError::InvalidInput(format!(
"multinomial predict: rebuild design from saved termspec: {err}"
))
})?;
let x_dense = design
.design
.try_to_dense_by_chunks("multinomial predict design")
.map_err(EstimationError::InvalidInput)?;
if x_dense.ncols() != model.p_per_class {
crate::bail_invalid_estim!(
"multinomial predict: predict design has {} cols, saved model expects {}",
x_dense.ncols(),
model.p_per_class
);
}
Ok(model.predict_probabilities(x_dense.view()))
}
#[cfg(test)]
mod fisher_override_tests {
use super::*;
use ndarray::Array3;
fn toy() -> (Array2<f64>, Array2<f64>, Array2<f64>, Array1<f64>) {
let n = 15;
let p = 2;
let k = 3;
let design =
Array2::<f64>::from_shape_fn(
(n, p),
|(i, j)| {
if j == 0 { 1.0 } else { ((i + 2) as f64).cos() }
},
);
let mut y = Array2::<f64>::zeros((n, k));
for i in 0..n {
y[[i, i % k]] = 1.0;
}
let penalty = Array2::<f64>::eye(p);
let lambdas = Array1::<f64>::from_elem(k - 1, 0.5);
(design, y, penalty, lambdas)
}
#[test]
fn fisher_override_none_reproduces_analytic() {
let (design, y, penalty, lambdas) = toy();
let mk = |over: Option<ndarray::ArrayView3<'_, f64>>| {
fit_penalized_multinomial(MultinomialFitInputs {
design: design.view(),
y_one_hot: y.view(),
penalty: penalty.view(),
lambdas: lambdas.view(),
row_weights: None,
fisher_w_override: over,
max_iter: 50,
tol: 1.0e-9,
})
.expect("fit must succeed")
};
let a = mk(None);
let b = mk(None);
for (x, z) in a
.coefficients_active
.iter()
.zip(b.coefficients_active.iter())
{
assert_eq!(x, z);
}
}
#[test]
fn fisher_override_wrong_shape_is_rejected() {
let (design, y, penalty, lambdas) = toy();
let n = design.nrows();
let m = y.ncols(); let bad = Array3::<f64>::zeros((n, m, m));
let err = fit_penalized_multinomial(MultinomialFitInputs {
design: design.view(),
y_one_hot: y.view(),
penalty: penalty.view(),
lambdas: lambdas.view(),
row_weights: None,
fisher_w_override: Some(bad.view()),
max_iter: 50,
tol: 1.0e-9,
})
.expect_err("wrong active-block shape must error");
assert!(format!("{err}").contains("fisher_w_override shape"));
}
#[test]
fn formula_outer_route_uses_exact_curvature_for_medium_d() {
assert!(
multinomial_formula_use_outer_hessian(6),
"D=6 loaded multinomial fits need exact curvature to avoid near-separation BFGS wandering"
);
}
#[test]
fn formula_outer_route_uses_first_order_for_smooth_by_factor_d8() {
assert!(
!multinomial_formula_use_outer_hessian(8),
"D=8 smooth-by-factor multinomial fits must avoid the O(D^2) dense outer Hessian"
);
}
#[test]
fn fixed_lambda_multinomial_reports_complete_separation() {
let n = 90;
let design = Array2::<f64>::from_shape_fn((n, 2), |(row, col)| match col {
0 => 1.0,
_ => -3.0 + 6.0 * (row as f64) / ((n - 1) as f64),
});
let mut y = Array2::<f64>::zeros((n, 3));
for row in 0..n {
let x = design[[row, 1]];
let class = if x < -1.0 {
0
} else if x > 1.0 {
1
} else {
2
};
y[[row, class]] = 1.0;
}
let penalty = Array2::<f64>::zeros((2, 2));
let lambdas = Array1::<f64>::zeros(2);
let err = fit_penalized_multinomial(MultinomialFitInputs {
design: design.view(),
y_one_hot: y.view(),
penalty: penalty.view(),
lambdas: lambdas.view(),
row_weights: None,
fisher_w_override: None,
max_iter: 80,
tol: 1.0e-12,
})
.expect_err("complete softmax separation must be a hard diagnostic");
assert!(
matches!(err, EstimationError::MultinomialSeparationDetected { .. }),
"expected MultinomialSeparationDetected, got {err:?}"
);
assert!(
err.to_string().contains("separation"),
"diagnostic should mention separation, got {err}"
);
assert!(
err.to_string().contains("active class-"),
"diagnostic should name the separated active class logit, got {err}"
);
assert!(
!err.to_string().contains("binary outcomes"),
"multinomial diagnostic must not reuse the binary separation text, got {err}"
);
}
#[test]
fn formula_multinomial_accepts_finite_saturated_logits_as_firth_bounded() {
let saturated_states = vec![
ParameterBlockState {
beta: Array1::from_vec(vec![1.0, 2.0]),
eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
},
ParameterBlockState {
beta: Array1::from_vec(vec![-1.0, 3.0]),
eta: Array1::from_vec(vec![1.0, 25.5, -0.1]),
},
];
assert!(
multinomial_formula_separation_diagnostic(17, 9, &saturated_states).is_none(),
"a finite (even saturated, |eta|>25) Firth-bounded formula optimum is a valid fit, \
not a separation diagnostic"
);
let blown_up = vec![
ParameterBlockState {
beta: Array1::from_vec(vec![1.0, 2.0]),
eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
},
ParameterBlockState {
beta: Array1::from_vec(vec![-1.0, 3.0]),
eta: Array1::from_vec(vec![1.0, f64::INFINITY, -0.1]),
},
];
let err = multinomial_formula_separation_diagnostic(17, 9, &blown_up)
.expect("a non-finite formula logit must raise the separation diagnostic");
assert!(
matches!(
err,
EstimationError::MultinomialSeparationDetected {
iteration: 17,
max_abs_eta,
active_class_index: 1,
row_index: 1,
} if !max_abs_eta.is_finite()
),
"expected typed multinomial separation diagnostic at the non-finite channel, got {err:?}"
);
}
#[test]
fn scaled_fisher_override_changes_first_step() {
let (design, y, penalty, lambdas) = toy();
let n = design.nrows();
let m = y.ncols() - 1;
let pk = 1.0 / (y.ncols() as f64);
let mut over = Array3::<f64>::zeros((n, m, m));
for row in 0..n {
for a in 0..m {
for b in 0..m {
let analytic = if a == b { pk * (1.0 - pk) } else { -pk * pk };
over[[row, a, b]] = 4.0 * analytic;
}
}
}
let scaled = fit_penalized_multinomial(MultinomialFitInputs {
design: design.view(),
y_one_hot: y.view(),
penalty: penalty.view(),
lambdas: lambdas.view(),
row_weights: None,
fisher_w_override: Some(over.view()),
max_iter: 1,
tol: 1.0e-9,
})
.expect("override fit must succeed");
let analytic = fit_penalized_multinomial(MultinomialFitInputs {
design: design.view(),
y_one_hot: y.view(),
penalty: penalty.view(),
lambdas: lambdas.view(),
row_weights: None,
fisher_w_override: None,
max_iter: 1,
tol: 1.0e-9,
})
.expect("analytic fit must succeed");
let differs = scaled
.coefficients_active
.iter()
.zip(analytic.coefficients_active.iter())
.any(|(a, b)| (a - b).abs() > 1.0e-6);
assert!(differs, "scaled curvature must change the first step");
}
}