pub struct DidCs { /* private fields */ }Expand description
Difference-in-differences with repeated cross-sections: the data need
a 0/1 time indicator (DmlData::with_time_indicator). ml_g learns
E[Y | D = d, T = t, X] separately in each of the four group × period
cells, ml_m the propensity P(D = 1 | X) (observational score only).
Implementations§
Source§impl DidCs
impl DidCs
Sourcepub fn new(
ml_g: impl Regressor + 'static,
ml_m: impl Classifier + 'static,
) -> Self
pub fn new( ml_g: impl Regressor + 'static, ml_m: impl Classifier + 'static, ) -> Self
Observational design (doubly robust score).
Sourcepub fn experimental(ml_g: impl Regressor + 'static) -> Self
pub fn experimental(ml_g: impl Regressor + 'static) -> Self
Randomised design: only the outcome model is needed.
pub fn from_boxed( ml_g: Box<dyn Regressor>, ml_m: Option<Box<dyn Classifier>>, ) -> Self
Sourcepub fn in_sample_normalization(self, normalize: bool) -> Self
pub fn in_sample_normalization(self, normalize: bool) -> Self
Normalise the weights by their sample means (default true, as
DoubleML); false uses the plug-in probabilities.
Sourcepub fn clipping_threshold(self, t: f64) -> Self
pub fn clipping_threshold(self, t: f64) -> Self
Propensities are clipped to [t, 1 − t] (default 0.01).
Sourcepub fn calibration(self, calibration: Calibration) -> Self
pub fn calibration(self, calibration: Calibration) -> Self
Calibrate the propensity scores before clipping (default: none), as
DoubleML’s ps_processor_config.
Sourcepub fn n_rep(self, n_rep: usize) -> Self
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.
Sourcepub fn fit(&self, data: &DmlData) -> Result<DmlFit>
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.
Sourcepub fn fit_with_cluster_folds(
&self,
data: &DmlData,
splits: &[Vec<ClusterFold>],
) -> Result<DmlFit>
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.
Sourcepub fn sensitivity_benchmark(
&self,
data: &DmlData,
long: &DmlFit,
benchmarking_set: &[usize],
) -> Result<SensitivityBenchmark>
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.
Sourcepub fn fit_with_folds(
&self,
data: &DmlData,
splits: &[Vec<Fold>],
) -> Result<DmlFit>
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).
Sourcepub fn nuisance_regressor(
self,
name: &str,
learner: impl Regressor + 'static,
) -> Self
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.
Sourcepub fn nuisance_regressor_boxed(
self,
name: &str,
learner: Box<dyn Regressor>,
) -> Self
pub fn nuisance_regressor_boxed( self, name: &str, learner: Box<dyn Regressor>, ) -> Self
As nuisance_regressor, boxed.
Sourcepub fn nuisance_classifier(
self,
name: &str,
learner: impl Classifier + 'static,
) -> Self
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.
Sourcepub fn nuisance_classifier_boxed(
self,
name: &str,
learner: Box<dyn Classifier>,
) -> Self
pub fn nuisance_classifier_boxed( self, name: &str, learner: Box<dyn Classifier>, ) -> Self
As nuisance_classifier, boxed.
Trait Implementations§
Source§impl LinearScoreModel for DidCs
impl LinearScoreModel for DidCs
Source§fn validate(&self, data: &DmlData) -> Result<()>
fn validate(&self, data: &DmlData) -> Result<()>
Source§fn estimate_score(
&self,
input: &ScoreInput<'_>,
folds: &[Fold],
) -> Result<ScoreEstimate>
fn estimate_score( &self, input: &ScoreInput<'_>, folds: &[Fold], ) -> Result<ScoreEstimate>
folds and return the score elements.Auto Trait Implementations§
impl !RefUnwindSafe for DidCs
impl !UnwindSafe for DidCs
impl Freeze for DidCs
impl Send for DidCs
impl Sync for DidCs
impl Unpin for DidCs
impl UnsafeUnpin for DidCs
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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