pub struct CounterfactualKernel<State = Untrained> { /* private fields */ }Expand description
Counterfactual Kernel Approximation
Implements kernel methods for counterfactual reasoning: “What would have happened if the treatment had been different?”
§Mathematical Background
Counterfactual: Y(t) | X=x, T=t’, Y=y Uses nearest-neighbor matching in kernel feature space with propensity score adjustment.
§Examples
ⓘ
use sklears_kernel_approximation::causal_kernels::{CounterfactualKernel, CausalKernelConfig};
use scirs2_core::ndarray::array;
use sklears_core::traits::{Fit, Transform};
let config = CausalKernelConfig::default();
let cf = CounterfactualKernel::new(config);
let data = array![[1.0, 0.0, 2.0], [2.0, 1.0, 5.0]];
let fitted = cf.fit(&data, &()).unwrap();Implementations§
Source§impl CounterfactualKernel<Untrained>
impl CounterfactualKernel<Untrained>
Sourcepub fn new(config: CausalKernelConfig) -> Self
pub fn new(config: CausalKernelConfig) -> Self
Create a new counterfactual kernel
Sourcepub fn with_components(n_components: usize) -> Self
pub fn with_components(n_components: usize) -> Self
Create with default configuration
Source§impl CounterfactualKernel<Trained>
impl CounterfactualKernel<Trained>
Sourcepub fn propensity_scores(&self) -> &Array1<Float>
pub fn propensity_scores(&self) -> &Array1<Float>
Get propensity scores from training data
Trait Implementations§
Source§impl<State: Clone> Clone for CounterfactualKernel<State>
impl<State: Clone> Clone for CounterfactualKernel<State>
Source§fn clone(&self) -> CounterfactualKernel<State>
fn clone(&self) -> CounterfactualKernel<State>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<State: Debug> Debug for CounterfactualKernel<State>
impl<State: Debug> Debug for CounterfactualKernel<State>
Source§impl Estimator for CounterfactualKernel<Untrained>
impl Estimator for CounterfactualKernel<Untrained>
Source§type Config = CausalKernelConfig
type Config = CausalKernelConfig
Configuration type for the estimator
Source§type Error = SklearsError
type Error = SklearsError
Error type for the estimator
Source§fn validate_config(&self) -> Result<(), SklearsError>
fn validate_config(&self) -> Result<(), SklearsError>
Validate estimator configuration with detailed error context
Source§fn check_compatibility(
&self,
n_samples: usize,
n_features: usize,
) -> Result<(), SklearsError>
fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>
Check if estimator is compatible with given data dimensions
Source§fn metadata(&self) -> EstimatorMetadata
fn metadata(&self) -> EstimatorMetadata
Get estimator metadata
Source§impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for CounterfactualKernel<Untrained>
impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for CounterfactualKernel<Untrained>
Source§type Fitted = CounterfactualKernel<Trained>
type Fitted = CounterfactualKernel<Trained>
The fitted model type
Source§fn fit(self, x: &Array2<Float>, _y: &()) -> Result<Self::Fitted>
fn fit(self, x: &Array2<Float>, _y: &()) -> Result<Self::Fitted>
Fit the model to the provided data with validation
Source§fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
Fit with custom validation and early stopping
Auto Trait Implementations§
impl<State> Freeze for CounterfactualKernel<State>
impl<State> RefUnwindSafe for CounterfactualKernel<State>where
State: RefUnwindSafe,
impl<State> Send for CounterfactualKernel<State>where
State: Send,
impl<State> Sync for CounterfactualKernel<State>where
State: Sync,
impl<State> Unpin for CounterfactualKernel<State>where
State: Unpin,
impl<State> UnwindSafe for CounterfactualKernel<State>where
State: UnwindSafe,
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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>
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 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>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> StableApi for Twhere
T: Estimator,
impl<T> StableApi for Twhere
T: Estimator,
Source§const STABLE_SINCE: &'static str = "0.1.0"
const STABLE_SINCE: &'static str = "0.1.0"
API version this type was stabilized in
Source§const HAS_EXPERIMENTAL_FEATURES: bool = false
const HAS_EXPERIMENTAL_FEATURES: bool = false
Whether this API has any experimental features