Learn R Programming

Train Interpretable, Spline Based, Additive, Surrogate Models

Overview

The xspliner package is a collection of tools for training interpretable surrogate ML models.

The package helps to build simple, interpretable models that inherits informations provided by more complicated ones - resulting model may be treated as explanation of provided black box, that was supplied prior to the algorithm. Provided functionality offers graphical and statistical evaluation both for overall model and its components.

Key functions:

  • xspline() or model_surrogate_xspliner() for training surrogate model,
  • plot_model_comparison() or plot generic for visual predictions comparison of surrogate and original ML model,
  • plot_variable_transition() or plot generic for graphical presentation of variables profiles and related information,
  • summary() for statistical comparison of surrogate and original ML models,
  • print() for getting details about surrogate model components.

The approach that stands behind surrogate model construction offered by xspliner sums up below graphics:

More details can be found in xspliner's page.

Installation

# the easiest way to get xspliner is to install it from CRAN:
install.packages("xspliner")

# Or the the development version from GitHub:
devtools::install_github("ModelOriented/xspliner")

Copy Link

Version

Install

install.packages('xspliner')

Monthly Downloads

3

Version

0.0.4

License

GPL

Maintainer

Krystian Igras

Last Published

September 25th, 2019

Functions in xspliner (0.0.4)

xspline

Builds predictive model based GLM.
summary.xspliner

Summary method for xspliner object
xf_opts_default

Default parameters for transition methods
transition

Extract variable transformation from xspliner
xspliner-package

Easy way for approximating data with splines.
log_msg

Helper function to print out log messages
stats

Statistics used for better linear model selection
approx_with_spline

Approximate spline on data
plot_model_comparison

Plot models comparison
plot_variable_transition

Plot variable profile
plot.xspliner

Plot method for 'xspliner' model
build_xspliner

Helper function for building GLM object with transformed variables.
predict.xspliner

Predict xspliner method
print.xspliner

Print method for xspliner object