Struct Irm 

pub struct Irm { /* private fields */ }

IRM estimator: ml_g learns E[Y | D = d, X] (fitted separately on the treated and control rows of each training fold), ml_m learns the propensity score P(D = 1 | X).

Implementations

impl Irm

pub fn new( ml_g: impl Regressor + 'static, ml_m: impl Classifier + 'static, ) -> Self

pub fn from_boxed(ml_g: Box<dyn Regressor>, ml_m: Box<dyn Classifier>) -> Self

pub fn weights(self, weights: Array1<f64>) -> Self

Weighted average effect, as DoubleML’s weights: with the ATE score E[w·(g(1, X) − g(0, X))] / E[w] (e.g. w = 1{X ∈ G} for the effect in a subgroup); with the ATTE score w must be 0/1 and selects the subgroup of the treated.

pub fn weights_with_bar( self, weights: Array1<f64>, weights_bar: Array2<f64>, ) -> Self

ATE weights with separate weights_bar for the inverse-probability correction, one column per repetition (DoubleML’s dict form).

pub fn score(self, score: IrmScore) -> Self

pub fn clipping_threshold(self, t: f64) -> Self

Propensity scores are clipped to [t, 1 − t] (default t = 0.01).

pub fn calibration(self, calibration: Calibration) -> Self

Calibrate the propensity scores before clipping (default: none), as DoubleML’s ps_processor_config.

pub fn normalize_ipw(self, normalize: bool) -> Self

Normalise the inverse-probability weights to mean one within each treatment arm (Hájek-style), as DoubleML’s normalize_ipw=True.

pub fn n_folds(self, n_folds: usize) -> Self

Number of cross-fitting folds (default 5).

pub fn n_rep(self, n_rep: usize) -> Self

Number of independent sample splits (default 1). Estimates are aggregated across repetitions by the median, as in DoubleML.

pub fn seed(self, seed: u64) -> Self

Seed for the sample splits (default 0).

pub fn fit(&self, data: &DmlData) -> Result<DmlFit>

Draw seeded sample splits and fit. With clustered data (DmlData::with_clusters) whole clusters are assigned to folds and standard errors are cluster-robust.

pub fn fit_with_cluster_folds( &self, data: &DmlData, splits: &[Vec<ClusterFold>], ) -> Result<DmlFit>

Fit clustered data with explicit cluster folds, one Vec<ClusterFold> per repetition.

pub fn sensitivity_benchmark( &self, data: &DmlData, long: &DmlFit, benchmarking_set: &[usize], ) -> Result<SensitivityBenchmark>

Sensitivity benchmark for the covariate columns benchmarking_set: refits this model without them (with the same sample splitting, so long must come from fit with the current settings) and compares it with long.

pub fn fit_with_folds( &self, data: &DmlData, splits: &[Vec<Fold>], ) -> Result<DmlFit>

Fit with caller-supplied splits, one Vec<Fold> per repetition (e.g. to reproduce another implementation exactly).

pub fn nuisance_regressor( self, name: &str, learner: impl Regressor + 'static, ) -> Self

Use learner for the regression nuisance name (DoubleML’s name, e.g. "ml_g1") instead of the model’s default learner for it.

pub fn nuisance_regressor_boxed( self, name: &str, learner: Box<dyn Regressor>, ) -> Self

As nuisance_regressor, boxed.

pub fn nuisance_classifier( self, name: &str, learner: impl Classifier + 'static, ) -> Self

Use learner for the classification nuisance name instead of the model’s default learner for it.

pub fn nuisance_classifier_boxed( self, name: &str, learner: Box<dyn Classifier>, ) -> Self

As nuisance_classifier, boxed.

Trait Implementations

impl LinearScoreModel for Irm

fn name(&self) -> String

Label for summaries, e.g. "PLR (partialling out)".

fn validate(&self, data: &DmlData) -> Result<()>

Reject data the model cannot handle (called once before fitting).

fn estimate_score( &self, input: &ScoreInput<'_>, folds: &[Fold], ) -> Result<ScoreEstimate>

Cross-fit the nuisances on folds and return the score elements.

fn strata(&self, _data: &DmlData) -> Option<Vec<usize>>

Strata for the default sample splits (e.g. treatment levels), so each fold holds about the same share of every stratum. None (the default) draws plain K-fold splits.