Struct FnModel 

pub struct FnModel<F> { /* private fields */ }

A convenience implementation allowing a prediction closure to be used as a SHAP model.

This is particularly useful for model-agnostic explainers.

Example

use ndarray::{Array2, ArrayView2};
use shap_rs::model::{FnModel, Predict};

let model = FnModel::new(|x: ArrayView2<'_, f64>| -> shap_rs::Result<Array2<f64>> {
    let mut output = Array2::<f64>::zeros((x.nrows(), 1));

    for i in 0..x.nrows() {
        output[[i, 0]] = x[[i, 0]] + x[[i, 1]];
    }

    Ok(output)
});

Implementations

impl<F> FnModel<F>

pub fn new(predict_fn: F) -> Self

Creates a model from a batch prediction function.

pub fn with_n_features(self, n_features: usize) -> Self

Sets the expected number of input features.

pub fn with_n_outputs(self, n_outputs: usize) -> Self

Sets the number of model outputs.

pub fn configured_n_features(&self) -> Option<usize>

Returns the configured feature count.

pub fn configured_n_outputs(&self) -> Option<usize>

Returns the configured output count.

Trait Implementations

impl<F> Predict for FnModel<F>

where F: Fn(ArrayView2<'_, f64>) -> Result<Array2<f64>>,

fn predict(&self, x: ArrayView2<'_, f64>) -> Result<Array2<f64>>

Predict outputs for a batch of samples.

fn n_features(&self) -> Option<usize>

Returns the number of input features expected by the model.

fn n_outputs(&self) -> Option<usize>

Returns the number of outputs produced by the model.

fn predict_owned(&self, x: Array2<f64>) -> Result<Array2<f64>>

Predicts from an owned batch.