gam 0.1.17

Generalized penalized likelihood engine
Documentation 
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

use crate::families::bernoulli_marginal_slope::{
    DEFAULT_EMPIRICAL_LATENT_GRID_SIZE, DeviationBlockConfig, LatentMeasureSpec,
    LatentZNormalizationMode, LatentZPolicy,
};
use crate::families::survival_construction::SurvivalBaselineTarget;
use crate::types::{InverseLink, LinkFunction};

#[derive(Clone, Debug)]
pub enum LatentScoreSemantics {
    /// z is already on latent N(0,1) scale from a frozen, phenotype-free transform.
    FrozenConditionalNormal {
        transform_id: Option<String>,
        clip_eps: f64,
        require_approximately_standard: bool,
    },
    /// z will be centered/scaled inside the fit.
    FitWeightedNormalization,
    /// z is carried by its observed empirical latent measure instead of
    /// pretending the downstream calibration law is standard normal.
    EmpiricalLatentMeasure { normalize_location_scale: bool },
}

impl LatentScoreSemantics {
    pub fn into_policy(self) -> LatentZPolicy {
        match self {
            Self::FrozenConditionalNormal { .. } => LatentZPolicy::frozen_transformation_normal(),
            Self::FitWeightedNormalization => LatentZPolicy::exploratory_fit_weighted(),
            Self::EmpiricalLatentMeasure {
                normalize_location_scale,
            } => LatentZPolicy {
                normalization: if normalize_location_scale {
                    LatentZNormalizationMode::FitWeighted
                } else {
                    LatentZNormalizationMode::None
                },
                latent_measure: LatentMeasureSpec::GlobalEmpirical {
                    grid_size: DEFAULT_EMPIRICAL_LATENT_GRID_SIZE,
                },
                ..LatentZPolicy::exploratory_fit_weighted()
            },
        }
    }
}

#[derive(Clone, Debug)]
pub struct MarginalSlopeCalibrationProtocol {
    pub base_link: InverseLink,
    pub score_warp: DeviationBlockConfig,
    pub link_deviation: DeviationBlockConfig,
    pub latent_score: LatentScoreSemantics,
}

impl MarginalSlopeCalibrationProtocol {
    pub fn probit_with_score_and_link_wiggle() -> Self {
        let wiggle = DeviationBlockConfig::triple_penalty_default();
        Self {
            base_link: InverseLink::Standard(LinkFunction::Probit),
            score_warp: wiggle.clone(),
            link_deviation: wiggle,
            latent_score: LatentScoreSemantics::FrozenConditionalNormal {
                transform_id: None,
                clip_eps: 1e-6,
                require_approximately_standard: true,
            },
        }
    }
}

#[derive(Clone, Debug)]
pub struct SurvivalMarginalSlopeProtocol {
    pub marginal: MarginalSlopeCalibrationProtocol,
    pub baseline_target: SurvivalBaselineTarget,
    pub require_timewiggle: bool,
}

impl SurvivalMarginalSlopeProtocol {
    pub fn gompertz_makeham_probit_timewiggle() -> Self {
        Self {
            marginal: MarginalSlopeCalibrationProtocol::probit_with_score_and_link_wiggle(),
            baseline_target: SurvivalBaselineTarget::GompertzMakeham,
            require_timewiggle: true,
        }
    }
}