scirs2_neural::interpretation::explanations

Struct CounterfactualGenerator

pub struct CounterfactualGenerator<F: Float + Debug> {
    pub max_features: usize,
    pub learning_rate: f64,
    pub max_iterations: usize,
    pub distance_metric: DistanceMetric,
    pub original_predictions: HashMap<String, F>,
}

Expand description

Counterfactual explanation generator

Fields§

§max_features: usize

Maximum number of features to perturb

§learning_rate: f64

Learning rate for optimization

§max_iterations: usize

Maximum optimization iterations

§distance_metric: DistanceMetric

Distance metric to use

§original_predictions: HashMap<String, F>

Cache of original predictions

Implementations§

Source §

impl<F> CounterfactualGenerator<F>
where F: Float + Debug + 'static + ScalarOperand + FromPrimitive + Sum + Clone + Copy,

Source

pub fn new( max_features: usize, learning_rate: f64, max_iterations: usize, distance_metric: DistanceMetric, ) -> Self

Create a new counterfactual generator

Source

pub fn generate_counterfactual( &mut self, original_input: &ArrayD<F>, _target_prediction: F, ) -> Result<ArrayD<F>>

Generate counterfactual explanation

Source

pub fn compute_distance(&self, input1: &ArrayD<F>, input2: &ArrayD<F>) -> f64

Compute distance between two inputs

Trait Implementations§

Source §

impl<F: Clone + Float + Debug> Clone for CounterfactualGenerator<F>

Source §

fn clone(&self) -> CounterfactualGenerator<F>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<F: Debug + Float + Debug> Debug for CounterfactualGenerator<F>

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> UnwindSafe for CounterfactualGenerator<F>
where F: UnwindSafe,

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<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §