gam 0.3.64

Generalized penalized likelihood engine
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Dispatch table for the torch fit entry — single source of truth for which
//! Python `Smooth` subclasses the torch.fit autograd glue recognises.
//!
//! The Python side calls `torch_smooth_dispatch_key(type(smooth).__name__)`
//! to translate the spec class name into a small enumeration. The tensor
//! construction itself stays in Python because the torch autograd VJP must
//! flow back through `points`, `centers`, and `by`.
//!
//! Every Python `Smooth` subclass that is re-exported from `gamfit.torch`
//! must have a matching variant here, so that dispatch never fails for a
//! class the user can legitimately import. Entries whose tensor backend is
//! not yet wired (`TensorBSpline`, `Matern`, `Categorical`) still resolve
//! to a registered variant; the `fit.py` cascade then raises
//! `NotImplementedError` at the point where it would actually need the
//! tensor backend.

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum TorchSmoothEntry {
    Duchon,
    BSpline,
    TensorBSpline,
    Matern,
    Sphere,
    PeriodicSplineCurve,
    Pca,
    Categorical,
}

impl TorchSmoothEntry {
    pub const fn as_str(self) -> &'static str {
        match self {
            TorchSmoothEntry::Duchon => "duchon",
            TorchSmoothEntry::BSpline => "bspline",
            TorchSmoothEntry::TensorBSpline => "tensor_bspline",
            TorchSmoothEntry::Matern => "matern",
            TorchSmoothEntry::Sphere => "sphere",
            TorchSmoothEntry::PeriodicSplineCurve => "periodic_spline_curve",
            TorchSmoothEntry::Pca => "pca",
            TorchSmoothEntry::Categorical => "categorical",
        }
    }
}

/// Map a Python `Smooth` subclass name to the matching torch entry kind.
///
/// Returns `Ok(entry)` for every `Smooth` subclass that `gamfit.torch`
/// re-exports — including those whose tensor backend is not yet wired.
/// The `fit.py` cascade is responsible for raising `NotImplementedError`
/// when it cannot build a design/penalty pair for a recognised-but-unwired
/// entry. Truly unknown class names produce a `TypeError`-shaped message
/// preserving the previous Python cascade's surface error.
pub fn dispatch_key(spec_kind: &str) -> Result<TorchSmoothEntry, String> {
    match spec_kind {
        "Duchon" => Ok(TorchSmoothEntry::Duchon),
        "BSpline" => Ok(TorchSmoothEntry::BSpline),
        "TensorBSpline" => Ok(TorchSmoothEntry::TensorBSpline),
        "Matern" => Ok(TorchSmoothEntry::Matern),
        "Sphere" => Ok(TorchSmoothEntry::Sphere),
        "PeriodicSplineCurve" => Ok(TorchSmoothEntry::PeriodicSplineCurve),
        "Pca" => Ok(TorchSmoothEntry::Pca),
        "Categorical" => Ok(TorchSmoothEntry::Categorical),
        other => Err(format!("unknown Smooth subclass: {other}")),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn known_specs_dispatch() {
        assert_eq!(dispatch_key("Duchon").unwrap(), TorchSmoothEntry::Duchon);
        assert_eq!(dispatch_key("BSpline").unwrap(), TorchSmoothEntry::BSpline);
        assert_eq!(
            dispatch_key("TensorBSpline").unwrap(),
            TorchSmoothEntry::TensorBSpline
        );
        assert_eq!(dispatch_key("Matern").unwrap(), TorchSmoothEntry::Matern);
        assert_eq!(dispatch_key("Sphere").unwrap(), TorchSmoothEntry::Sphere);
        assert_eq!(
            dispatch_key("PeriodicSplineCurve").unwrap(),
            TorchSmoothEntry::PeriodicSplineCurve
        );
        assert_eq!(dispatch_key("Pca").unwrap(), TorchSmoothEntry::Pca);
        assert_eq!(
            dispatch_key("Categorical").unwrap(),
            TorchSmoothEntry::Categorical
        );
    }

    #[test]
    fn unknown_spec_kind_is_distinguishable() {
        let err = dispatch_key("Banana").unwrap_err();
        assert!(err.contains("unknown Smooth subclass"));
        assert!(err.contains("Banana"));
    }

    #[test]
    fn as_str_round_trips() {
        for kind in [
            TorchSmoothEntry::Duchon,
            TorchSmoothEntry::BSpline,
            TorchSmoothEntry::TensorBSpline,
            TorchSmoothEntry::Matern,
            TorchSmoothEntry::Sphere,
            TorchSmoothEntry::PeriodicSplineCurve,
            TorchSmoothEntry::Pca,
            TorchSmoothEntry::Categorical,
        ] {
            assert!(!kind.as_str().is_empty());
        }
    }
}