API Reference#

This page contains the API reference for public objects and functions in ixai.

explainer

This modul gathers the explainers.

storage

imputer

This module contains Imputer Mechanisms for Efficient Feature Removal.

utils

Explainer#

explainer.IncrementalPFI

Incremental PFI Explainer

explainer.sage.IncrementalSage

Incremental SAGE Explainer

explainer.sage.BatchSage

Batch SAGE Explainer

explainer.sage.IntervalSage

Interval SAGE Explainer

Storage#

storage.GeometricReservoirStorage

Geometric Reservoir Storage

storage.UniformReservoirStorage

Uniform Reservoir Storage

storage.TreeStorage

A Tree Storage that trains incremental decision trees for each feature.

storage.IntervalStorage

An Interval Storage storing last k samples.

storage.SequenceStorage

An Interval Storage storing the last sample.

storage.BatchStorage

A Batch Storage storing all seen samples.

Imputer#

Utils#

utils.wrappers

This modul gathers basic wrapper objects to transform common ML model architectures into callable functions.

utils.tracker

This module gathers objects to keep track of incremental / sequential data

utils.validators

Wrappers#

utils.wrappers.RiverWrapper

Wrapper for river prediction functions.

utils.wrappers.TorchWrapper

Wrapper for torch link functions.

utils.wrappers.SklearnWrapper

Wrapper for sklearn prediction functions.

utils.wrappers.RiverMetricToLossFunction

Wrapper that transforms a river.metrics.base.Metric into a loss function.

utils.wrappers.base.Wrapper

Base Wrapper

Tracker#

utils.tracker.SlidingWindowTracker

A sliding window tracker that stores the k last elements of the stream allowing for computation of the mean and variance of the last k values.

utils.tracker.ExponentialSmoothingTracker

A Tracker that applies Exponential Smoothing on the numeric input values.

utils.tracker.WelfordTracker

A Tracker that applies Welford's Algorithm to estimate the mean and variance of a sequence.

utils.tracker.MultiValueTracker

A Tracker for storing multiple values at once in the form of a dict mapping from keys to individual Trackers.

utils.tracker.base.Tracker

Base Tracker

Validators#