Skip to main content

A Python library for explainability of machine learinng algorithms in an agnostic, deterministic, and simple way.

Project description

image image image CodeQL image codecov Downloads image image

A Python library for explainability of machine learinng algorithms in an agnostic, deterministic, and simple way.

Introduction

pudu is a Python package that helps intepret and explore the results of machinme learning algorythms. It does this by quantifying the change in probability according to the change in the features. This library works with any case that has a probability function, which is normally available in scikit-learn and keras methods, and works for both 1-d (vectrors) and 2-d problems (images). In order to see the exact procedure and format needed, please refer to the examples in the docs.

Features

The following is a list of the main procedures that pudu package enables.

  • Importance: estimates the absolute or relative importance oif the features.
  • Speed: calculates how fast a preditci0on changes according to the changes in the features.
  • Synergy: tests teh synergy between features and the change in classification probability.
  • Easy plotting of the results from the above.

Quickstart

  1. Install this library using pip:

     pip install pudu
    
  2. Install this library using conda-forge:

     conda install -c conda-forge pudu
    
  3. Test it by running one of the examples in the docs.

  4. If you find this library useful, please consider a reference or citation as:

     ...
    
  5. Stay up-to-date by updating the library using:

    conda update pudu
    pip install --update pudu
    
  6. If you encounter problems when updating, try uninstalling and then re-installing::

     pip uninstall pudu
     conda remove pudu
    

Credits

This package was created with Cookiecutter and the giswqs/pypackage project template.

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

pudu-0.0.2.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

pudu-0.0.2-py2.py3-none-any.whl (7.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pudu-0.0.2.tar.gz.

File metadata

  • Download URL: pudu-0.0.2.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for pudu-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f74f774bf4c879f5d727493e951bbaee9f1af69cd4f4eeecb2b21c1daa0c984c
MD5 06cc4f12ccfacbd88c96f472583885cd
BLAKE2b-256 f886d3bdcb605d2546021449cd27e121110d56909265411c306a8bbe6ef3142d

See more details on using hashes here.

File details

Details for the file pudu-0.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: pudu-0.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for pudu-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 427000dbd5112c3e77a0c45b5ffe50031acd6c73e2085c30060ec10f37e1f714
MD5 8053527a126070013e68aef3edd63554
BLAKE2b-256 814e9843ba006446b35171f88b8722d1b1e9bbd28d851bcbc1f66735317c1880

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