Struct Background 

pub struct Background { /* private fields */ }

A reference dataset used by a SHAP explainer.

Background owns its data so that explainers can safely retain it for their entire lifetime.

The data has shape:

(n_background_samples, n_features)

Implementations

impl Background

pub fn validate(&self) -> Result<()>

Revalidates a background after deserialization.

pub fn new(data: Array2<f64>) -> Result<Self>

Creates a background dataset from an owned array.

Errors

Returns ShapError::EmptyBackground when the supplied array has zero rows.

pub fn from_view(data: ArrayView2<'_, f64>) -> Result<Self>

Creates a background dataset by copying an array view.

pub fn data(&self) -> ArrayView2<'_, f64>

Returns the underlying background data.

pub fn n_samples(&self) -> usize

Returns the number of background observations.

pub fn n_features(&self) -> usize

Returns the number of features.

pub fn row(&self, index: usize) -> Result<ArrayView1<'_, f64>>

Returns one background observation.

Errors

Returns ShapError::InvalidConfiguration if index is outside the background dataset.

pub fn sample<R: Rng + ?Sized>( &self, n_samples: usize, rng: &mut R, ) -> Result<Self>

Creates a new background dataset containing a random sample of the existing observations.

Sampling is performed without replacement.

If n_samples is greater than or equal to the current number of observations, a clone of the complete background dataset is returned.

pub fn select(&self, indices: &[usize]) -> Result<Self>

Returns a background dataset containing the specified rows.

This method preserves the order of indices.

Trait Implementations

impl Clone for Background

fn clone(&self) -> Background

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Background

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Background

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Background

fn eq(&self, other: &Background) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Background

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Background