Skip to main content

Apos

Struct Apos 

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

Average potential outcomes of several treatment levels, fitted on shared sample splits so that they (and their contrasts) have joint inference.

Implementations§

Source§

impl Apos

Source

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

Source

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

Source

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

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

Source

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

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

Source

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

Normalise the inverse-probability weights, as DoubleML’s normalize_ipw=True.

Source

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

Weighted average potential outcome, as DoubleML’s weights: E[w·g(d, X)] / E[w] (e.g. w = 1{X ∈ G} for a subgroup).

Source

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

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

Source

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

Number of cross-fitting folds (default 5).

Source

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

Number of independent sample splits (default 1).

Source

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

Seed for the sample splits (default 0).

Source

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

Draw sample splits (stratified by the treatment, or by cluster for clustered data) and fit every level on them.

Source

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

Fit every level on the given splits (one Vec<Fold> per repetition).

Source

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

Fit every level of clustered data on the given cluster splits.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Apos

§

impl !UnwindSafe for Apos

§

impl Freeze for Apos

§

impl Send for Apos

§

impl Sync for Apos

§

impl Unpin for Apos

§

impl UnsafeUnpin for Apos

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