Struct ScoreInput 

#[non_exhaustive]
pub struct ScoreInput<'a> {
    pub y: ArrayView1<'a, f64>,
    pub d: ArrayView1<'a, f64>,
    pub x: ArrayView2<'a, f64>,
    pub z: Option<ArrayView1<'a, f64>>,
    pub instruments: Option<ArrayView2<'a, f64>>,
    pub t: Option<ArrayView1<'a, f64>>,
    pub s: Option<ArrayView1<'a, f64>>,
    pub rep: usize,
    pub treatment: usize,
    pub external: Option<&'a ExternalPredictions>,
}

The data a model sees when estimating the effect of one treatment.

#[non_exhaustive]: fields may be added in future versions, so code outside this crate reads the fields but cannot construct the struct.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

y: ArrayView1<'a, f64>

d: ArrayView1<'a, f64>

The treatment being estimated.

x: ArrayView2<'a, f64>

Covariates, including any other treatments.

z: Option<ArrayView1<'a, f64>>

instruments: Option<ArrayView2<'a, f64>>

All instruments (several for Pliv).

t: Option<ArrayView1<'a, f64>>

0/1 time-period indicator (repeated cross-sections).

s: Option<ArrayView1<'a, f64>>

0/1 selection indicator (sample selection models).

rep: usize

Index of the sample-splitting repetition being estimated.

treatment: usize

Index of the treatment being estimated.

external: Option<&'a ExternalPredictions>

User-supplied nuisance predictions (DmlData::with_external_predictions).

Implementations

impl ScoreInput<'_>

pub fn predictions_or( &self, name: &str, fit: impl FnOnce() -> Result<Array1<f64>>, ) -> Result<Array1<f64>>

The user-supplied out-of-fold predictions of learner name for this treatment and repetition if there are any, else fit().

Trait Implementations

impl<'a> Clone for ScoreInput<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for ScoreInput<'a>

impl<'a> Debug for ScoreInput<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.