Group feature importance
This release looks at the role of joint feature importance for explainability in instances where features may be highly correlated when providing an output. Specifically, the method operates by regrouping the correlated features and then looking at the group-level impact of imputation. Doing so allows us to consider the impact of a joint permutation of the correlated features.
Examples
Some examples are available in examples
Installation
Installing with pip
This repository is tested on Python 3.9, and Linux systems. It is recommended to install in a virtual environment to keep your system in order. The following command installs the latest version of the library:
pip install groufi
Installing from source
To install groufi from source, you can follow the steps below. First, you will need to
install poetry. poetry is used to manage and install
the dependencies.
If poetry is already installed on your machine, you can skip this step. There are several ways to
install poetry so
you can use the one that you prefer. You can check the poetry installation by running the
following command:
poetry --version
Then, you can clone the git repository:
git clone git@github.com:BorealisAI/group-feature-importance.git
Then, it is recommended to create a Python 3.8+ virtual environment. This step is optional so you can skip it. To create a virtual environment, you can use the following command:
make conda
It automatically creates a conda virtual environment. When the virtual environment is created, you can activate it with the following command:
conda activate groufi
This example uses conda to create a virtual environment, but you can use other tools or
configurations. Then, you
should install the required package to use groufi with the following command:
make install
This command will install all the required packages. You can also use this command to update the required packages. This command will check if there is a more recent package available and will install it. Finally, you can test the installation with the following command:
make test
License
This repository is released under the Attribution-NonCommercial-ShareAlike 4.0 International license as found in the LICENSE file.
Metadata
Release files for groufi 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| groufi-0.0.3.tar.gz | 13.2 kB | Without provenance | Details for groufi-0.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| groufi-0.0.3-py3-none-any.whl | Python 3 | none | any | Details for groufi-0.0.3-py3-none-any.whl |
Total release size: 26.1 kB
Release files / groufi-0.0.3.tar.gz
| Download URL | groufi-0.0.3.tar.gz |
|---|---|
| Size | 13.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4779abd13b86cd544119f1abf8d3b68ff95ec4279da254620483f01431383ac4
|
|
BLAKE2b-256 checksum How to use checksums |
14e81903003dcbcea5b873f57aff7d32e72328a25d7344a8f94894acff0c98fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.9.15 Linux/5.15.0-1022-azure
|
Release files / groufi-0.0.3-py3-none-any.whl
| Download URL | groufi-0.0.3-py3-none-any.whl |
|---|---|
| Size | 12.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
023c55ad6cbecfe26c7df7751bf1aee0bb0a800d723b08404b35ed34b7509023
|
|
BLAKE2b-256 checksum How to use checksums |
917b7e048f7c0fc324be087026cc06d04da36342dfef6cb9fea67f798336e2ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.9.15 Linux/5.15.0-1022-azure
|
Security for groufi 0.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.