Skip to main content

Lplr

Struct Lplr 

Source
pub struct Lplr { /* private fields */ }
Expand description

Logistic partially linear regression for a binary outcome, P(Y = 1 | D, X) = expit(θ·D + r(X)), as DoubleML’s DoubleMLLPLR; θ is a log odds ratio.

Nuisances: ml_outcome (DoubleML’s ml_M) for P(Y = 1 | D, X), ml_t for E[logit M(D, X) | X], ml_m (and optionally ml_a) for E[D | X]. ml_M and ml_a are double cross-fitted (Lplr::n_folds_inner) and the score is solved with Newton’s method; see LplrScore for the scores.

Implementations§

Source§

impl Lplr

Source

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

ml_outcome learns M(D, X) = P(Y = 1 | D, X) (DoubleML’s ml_M), ml_t the log odds E[logit M(D, X) | X], ml_m the treatment regression E[D | X].

Source

pub fn with_propensity( ml_outcome: impl Classifier + 'static, ml_t: impl Regressor + 'static, ml_m: impl Classifier + 'static, ) -> Self

As Lplr::new, with a classifier for a binary treatment’s propensity P(D = 1 | X).

Source

pub fn from_boxed( ml_outcome: Box<dyn Classifier>, ml_t: Box<dyn Regressor>, ml_m: TreatmentLearner, ml_a: Option<TreatmentLearner>, ) -> Self

Boxed learners; ml_a defaults to a copy of ml_m.

Source

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

Source

pub fn ml_a(self, ml_a: TreatmentLearner) -> Self

A separate learner for a(X) = E[D | X], the regression used to build the preliminary estimate and r(X) (default: a copy of ml_m).

Source

pub fn n_folds_inner(self, k: usize) -> Self

Inner folds of the double cross-fitting (default 5).

Source

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

Number of outer cross-fitting folds (default 5).

Source

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

Number of independent sample splits (default 1), aggregated by the median.

Source

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

Seed for the outer and inner sample splits (default 0).

Source

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

Draw seeded outer and inner sample splits and fit.

Source

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

Fit on given outer splits (one Vec<Fold> per repetition); the inner splits are drawn from the seed.

Source

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

Fit on given outer and inner splits: inner[r][k] are the inner folds (data indices, partitioning the training set of outer fold k) of repetition r.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Lplr

§

impl !UnwindSafe for Lplr

§

impl Freeze for Lplr

§

impl Send for Lplr

§

impl Sync for Lplr

§

impl Unpin for Lplr

§

impl UnsafeUnpin for Lplr

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V