pub struct SHAPValues { /* private fields */ }Expand description
SHAP Values kernel.
Computes SHAP (SHapley Additive exPlanations) values for model predictions. Uses Kernel SHAP approximation which is model-agnostic and works with any prediction function.
SHAP values satisfy:
- Local accuracy: f(x) = base_value + sum(shap_values)
- Missingness: Missing features have 0 contribution
- Consistency: If a feature’s contribution increases, its SHAP value increases
Implementations§
Source§impl SHAPValues
impl SHAPValues
Sourcepub fn explain<F>(
instance: &[f64],
background: &DataMatrix,
predict_fn: F,
config: &SHAPConfig,
) -> SHAPExplanation
pub fn explain<F>( instance: &[f64], background: &DataMatrix, predict_fn: F, config: &SHAPConfig, ) -> SHAPExplanation
Compute SHAP values for a single instance.
§Arguments
instance- The instance to explainbackground- Background dataset for baselinepredict_fn- Model prediction functionconfig- SHAP configuration
Sourcepub fn explain_batch<F>(
instances: &DataMatrix,
background: &DataMatrix,
predict_fn: F,
config: &SHAPConfig,
feature_names: Option<Vec<String>>,
) -> SHAPBatchResult
pub fn explain_batch<F>( instances: &DataMatrix, background: &DataMatrix, predict_fn: F, config: &SHAPConfig, feature_names: Option<Vec<String>>, ) -> SHAPBatchResult
Explain multiple instances.
Trait Implementations§
Source§impl Clone for SHAPValues
impl Clone for SHAPValues
Source§fn clone(&self) -> SHAPValues
fn clone(&self) -> SHAPValues
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 Debug for SHAPValues
impl Debug for SHAPValues
Source§impl Default for SHAPValues
impl Default for SHAPValues
Source§impl GpuKernel for SHAPValues
impl GpuKernel for SHAPValues
Source§fn metadata(&self) -> &KernelMetadata
fn metadata(&self) -> &KernelMetadata
Returns the kernel metadata.
Source§fn requires_gpu_native(&self) -> bool
fn requires_gpu_native(&self) -> bool
Returns true if this kernel requires GPU-native execution.
Source§fn health_check(&self) -> HealthStatus
fn health_check(&self) -> HealthStatus
Perform a health check on this kernel. Read more
Source§fn refresh_config(&mut self, _config: &KernelConfig) -> Result<(), KernelError>
fn refresh_config(&mut self, _config: &KernelConfig) -> Result<(), KernelError>
Refresh kernel configuration at runtime. Read more
Auto Trait Implementations§
impl Freeze for SHAPValues
impl RefUnwindSafe for SHAPValues
impl Send for SHAPValues
impl Sync for SHAPValues
impl Unpin for SHAPValues
impl UnwindSafe for SHAPValues
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
impl<F, W, T, D> Deserialize<With<T, W>, D> for F
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Gets the layout of the type.