Skip to main content

GradientExplainer

Struct GradientExplainer 

Source
pub struct GradientExplainer<M> { /* private fields */ }
Expand description

Expected Gradients (Gradient SHAP) with background interpolation and optional Gaussian local smoothing.

Implementations§

Source§

impl<M> GradientExplainer<M>

Source

pub fn new(model: M, background: Background) -> Self

Source

pub fn with_nsamples(self, n: usize) -> Self

Source

pub fn with_seed(self, s: u64) -> Self

Source

pub fn with_local_smoothing(self, s: f64) -> Self

Source

pub fn with_batch_size(self, batch_size: usize) -> Self

Limits gradient rows submitted to the autodiff backend in one call.

Source§

impl<M: DifferentiablePredict> GradientExplainer<M>

Source

pub fn explain_with_uncertainty( &self, x: ArrayView2<'_, f64>, repeats: usize, ) -> Result<UncertainExplanation>

Repeats Expected Gradients with independent deterministic seeds and returns the standard error of the mean attribution.

Trait Implementations§

Auto Trait Implementations§

§

impl<M> Freeze for GradientExplainer<M>
where M: Freeze,

§

impl<M> RefUnwindSafe for GradientExplainer<M>
where M: RefUnwindSafe,

§

impl<M> Send for GradientExplainer<M>
where M: Send,

§

impl<M> Sync for GradientExplainer<M>
where M: Sync,

§

impl<M> Unpin for GradientExplainer<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for GradientExplainer<M>
where M: UnsafeUnpin,

§

impl<M> UnwindSafe for GradientExplainer<M>
where M: 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<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<E> ExplainerExt for E
where E: Explainer,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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