Skip to main content

SLISEMAP: Combine local explanations with supervised dimensionality reduction

Project description

PyPI Documentation Tests Licence: MIT Binder

SLISEMAP: Combine supervised dimensionality reduction with local explanations

SLISEMAP is a supervised dimensionality reduction method, that takes data, in the form of vectors, and predictions from a black box regression or classification model as input. SLISEMAP then simultaneously finds local explanations for all data items and builds a (typically) two-dimensional global visualisation of the black box model such that data items with similar local explanations are projected nearby. The explanations consist of white box models that locally approximate the black box model.

SLISEMAP is implemented in Python using PyTorch for efficient optimisation, and optional GPU-acceleration. For more information see the full paper (arXiv), the demo paper, the demo video (slides), the examples, or the documentation.

Citation

Björklund, A., Mäkelä, J. & Puolamäki, K. (2022).
SLISEMAP: Supervised dimensionality reduction through local explanations.
Machine Learning, DOI 10.1007/s10994-022-06261-1

Installation

To install the package just run:

pip install slisemap

Or install the latest version directly from GitHub:

pip install git+https://github.com/edahelsinki/slisemap

PyTorch

Since SLISEMAP utilises PyTorch for efficient calculations, you might want to install a version that is optimised for your hardware. See https://pytorch.org/get-started/locally for details.

Example

import numpy as np
from slisemap import Slisemap

X = np.array(...)
y = np.array(...)
sm = Slisemap(X, y, radius=3.5, lasso=0.01)
sm.optimise()
sm.plot(clusters=5, bars=5)

Example plot of the results from using SLISEMAP on the Auto MPG dataset

See the examples for more detailed examples, and the documentation for more detailed instructions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

slisemap-1.3.1.tar.gz (36.8 kB view details)

Uploaded Source

Built Distribution

slisemap-1.3.1-py3-none-any.whl (39.4 kB view details)

Uploaded Python 3

File details

Details for the file slisemap-1.3.1.tar.gz.

File metadata

  • Download URL: slisemap-1.3.1.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for slisemap-1.3.1.tar.gz
Algorithm Hash digest
SHA256 0c1feef9cddb0bd28c829bbe569b17ae37005a61e267ce7554be77180860025a
MD5 c580e59ab453cab62d9c65d6638f6724
BLAKE2b-256 90ee1459af510cdcd3056537f9cba3e52c9edc34a35ecd6c3248e50b15cec52c

See more details on using hashes here.

File details

Details for the file slisemap-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: slisemap-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 39.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for slisemap-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eea7df780349f09ce30320f04d99e2dfc6bbe7c97fabe8ac96c7d68d076a50b8
MD5 8013ffa164675e032122586216d44b96
BLAKE2b-256 aea7469d90d4f5a3052173f9bb9805fcb7259d83dd974a5f08a1775b8dfc147d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page