Skip to main content

XAISuite: Training and Explanation Generation Utilities for Machine Learning Models

Reason this release was yanked:

This is an unstable version without complete functionalities.

Project description



XAISuite: Training and Explaining Machine Learning Models

Table of Contents

  1. Introduction
  2. Installation
  3. Getting Started
  4. How to Contribute
  5. Technical Report and Citing XAISuite

Introduction

XAISuite (Explanatory Artificial Intelligence Suite) is a library for training and explaining machine learning models for tabular datasets in Python. It provides a unified interface for training any sklearn model using just a line of code and allows users to easily comparing the results of different explainers!

XAISuite accomplishes machine learning model training and explanation generation in three steps: (1) data loading, (2) model training and (3) explanation generation. Each of these steps are delved into more detail in our documentation and in the demo tutorials.

Basic Flowchart of how XAISuite works

XAISuite was created as a helper library to [this paper](insert link), which studied the difference in SHAP and LIME explanations for different models on tabular datasets.

Installation

You can install the XAI Suite through PyPI:

pip install XAISuite

Getting Started

For example code and an introduction to the library, see the Demo Folder.

If you are looking for a model or dataset to use, sklearn has several cool options.

How to Contribute

We welcome the contribution from the open-source community to improve the library!

To add a new functionality into the library or point out a flaw, please create a new issue on Github. We'll try to look into your requests as soon as we can.

Technical Report and Citing XAISuite

A paper proposing and using XAISuite to compare explanatory methods is still in pre-publication. Use the following BibTex to cite XAISuite:

@article{mitra2022-xaisuite,
  author    = {Shreyan Mitra and Leilani Gilpin},
  title     = {Comparison of SHAP and LIME Explanations for Supervised
Machine Learning Models Trained on Tabular Datasets},
  year      = {2022},
  doi       = {},
  url       = {},
  archivePrefix = {},
  eprint    = {},
}

Contact Us

If you have any questions, comments or suggestions, please do not hesitate to contact us at xaisuite@gmail.com

License

This This work is licensed under a BSD 3-Clause License.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

XAISuite-0.6.9.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

XAISuite-0.6.9-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file XAISuite-0.6.9.tar.gz.

File metadata

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

File hashes

Hashes for XAISuite-0.6.9.tar.gz
Algorithm Hash digest
SHA256 d36be3060b8515bd753a00bc7bd39893a9f667f52cdab192e0d9e6bc3b4f9c33
MD5 3704e088f79cb7b50b62d2392e1e45bf
BLAKE2b-256 6d16c00d7c3a86df6da44614d4b9e8a391b9161600255a88892548b1ad12590a

See more details on using hashes here.

File details

Details for the file XAISuite-0.6.9-py3-none-any.whl.

File metadata

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

File hashes

Hashes for XAISuite-0.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 b8b33fa87ae939f2b189fd3a186a26cb5fad6ea52722bbd783dde9af7d671e65
MD5 7174abf8bbd4a267a16e7515bc878a52
BLAKE2b-256 d315571ed826e3b70a8ead2e3d469cb4f211b39e8e7539eacd70492bdd5235ac

See more details on using hashes here.

Supported by

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