Enum ShapError 

pub enum ShapError {
    DimensionMismatch {
        expected: String,
        found: String,
    },
    InvalidFeatureIndex {
        index: usize,
        n_features: usize,
    },
    InvalidSampleIndex {
        index: usize,
        n_samples: usize,
    },
    InvalidOutputIndex {
        index: usize,
        n_outputs: usize,
    },
    EmptyData,
    EmptyBackground,
    InvalidConfiguration(String),
    ModelError(String),
    MaskerError(String),
    NumericalError(String),
    SolverError(String),
    Unsupported(String),
    AdditivityError {
        expected: f64,
        actual: f64,
        difference: f64,
        tolerance: f64,
    },
    MissingMetadata(String),
    OutputDimensionMismatch {
        expected: usize,
        found: usize,
    },
    Other(String),
}

Errors that can occur while constructing or evaluating SHAP explainers.

Variants

DimensionMismatch

Two or more arrays have incompatible dimensions.

Fields

expected: String

found: String

InvalidFeatureIndex

A feature index is outside the valid feature range.

Fields

index: usize

n_features: usize

InvalidSampleIndex

A sample index is outside the valid sample range.

Fields

index: usize

n_samples: usize

InvalidOutputIndex

An output index is outside the valid model-output range.

Fields

index: usize

n_outputs: usize

EmptyData

The supplied data contains no samples.

EmptyBackground

The supplied background dataset contains no samples.

InvalidConfiguration(String)

An invalid configuration was supplied to an explainer or component.

ModelError(String)

A model prediction failed.

MaskerError(String)

A masking operation failed.

NumericalError(String)

A numerical operation failed.

SolverError(String)

A linear-system or weighted least-squares solver failed.

Unsupported(String)

The requested functionality is not supported.

AdditivityError

An explanation failed the SHAP additivity check.

Fields

expected: f64

actual: f64

difference: f64

tolerance: f64

MissingMetadata(String)

A required feature name or other metadata item was missing.

OutputDimensionMismatch

An operation was requested with incompatible output dimensions.

Fields

expected: usize

found: usize

Other(String)

An underlying error that does not have a more specific SHAP error type.

Trait Implementations

impl Clone for ShapError

fn clone(&self) -> ShapError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShapError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShapError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ShapError

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

Formats the value using the given formatter.

impl Error for ShapError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for ShapError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ShapError

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 ShapError