Skip to main content

Model Interpretability via Hierarchical Feature Perturbation

Project description

.. highlight:: shell

========
mihifepe
========

.. image:: https://img.shields.io/pypi/v/mihifepe.svg
:target: https://pypi.python.org/pypi/mihifepe
:alt: Release status

.. image:: https://img.shields.io/travis/cloudbopper/mihifepe.svg
:target: https://travis-ci.org/cloudbopper/mihifepe
:alt: Build status

.. image:: https://readthedocs.org/projects/mihifepe/badge/?version=latest
:target: https://mihifepe.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/cloudbopper/mihifepe/shield.svg
:target: https://pyup.io/repos/github/cloudbopper/mihifepe/
:alt: Updates


--------
Overview
--------

``mihifepe`` is a library that implements Model Interpretability via Hierarchical Feature Perturbation ([Paper link here])).

-------------
Documentation
-------------

https://mihifepe.readthedocs.io

------------
Installation
------------

Recommended installation method is via `virtual environments`_ and pip_.

When making the virtual environment, specify python3 as the python executable (python3 version must be 3.5+)::

mkvirtualenv -p python3 mihifepe_env

To install the latest stable release::

pip install mihifepe

Or to install the latest development version from GitHub::

pip install git+https://github.com/cloudbopper/mihifepe.git@master#egg=mihifepe

.. _pip: https://pip.pypa.io/
.. _virtual environments: https://python-guide-cn.readthedocs.io/en/latest/dev/virtualenvs.html

-----------
Development
-----------

https://mihifepe.readthedocs.io/en/latest/contributing.html

-----
Usage
-----

https://mihifepe.readthedocs.io/en/latest/usage.html

-------
License
-------

``mihifepe`` is free, open source software, released under the MIT license. See LICENSE_ for details.

.. _LICENSE: https://github.com/cloudbopper/mihifepe/blob/master/LICENSE

-------
Contact
-------

`Akshay Sood`_

.. _Akshay Sood: https://github.com/cloudbopper


=========
Changelog
=========

------------------
0.1.0 (2018-09-14)
------------------

* First release on PyPI


Project details


Release history Release notifications

Download files

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

Files for mihifepe, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size mihifepe-0.1.1-py2.py3-none-any.whl (15.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size mihifepe-0.1.1.tar.gz (20.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page