Struct Pliv 

pub struct Pliv { /* private fields */ }

Partially linear IV regression. See PlivVariant and PlivScore.

Implementations

impl Pliv

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

Partial X out (PlivVariant::PartialX): ml_l learns E[Y | X], ml_m E[Z | X], ml_r E[D | X].

pub fn from_boxed( ml_l: Box<dyn Regressor>, ml_m: Box<dyn Regressor>, ml_r: Box<dyn Regressor>, ) -> Self

pub fn partial_z(ml_r: impl Regressor + 'static) -> Self

Partial Z out (PlivVariant::PartialZ): ml_r learns E[D | X, Z].

pub fn partial_z_boxed(ml_r: Box<dyn Regressor>) -> Self

pub fn partial_xz( ml_l: impl Regressor + 'static, ml_m: impl Regressor + 'static, ml_r: impl Regressor + 'static, ) -> Self

Partial out X and Z (PlivVariant::PartialXZ): ml_l learns E[Y | X], ml_m E[D | X, Z], ml_r the projection of ml_m’s in-sample predictions on X.

pub fn variant(self, variant: PlivVariant) -> Self

Choose the variant (learners as for Pliv::new; PlivVariant::PartialZ uses only ml_r, learning E[D | X, Z]).

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

pub fn ml_g(self, ml_g: impl Regressor + 'static) -> Self

Learner for E[Y − θD | X] with the IV-type score (default: a copy of ml_l).

pub fn ml_g_boxed(self, ml_g: Box<dyn Regressor>) -> Self

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).

Trait Implementations

impl LinearScoreModel for Pliv

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.