Skip to main content

PowerShap logo

PyPI Latest Release support-version codecov Downloads PRs Welcome Testing DOI

powershap is a feature selection method that uses statistical hypothesis testing and power calculations on Shapley values, enabling fast and intuitive wrapper-based feature selection.

Installation ⚙️

pip pip install powershap

Usage 🛠

powershap is built to be intuitive, it supports various models including linear, tree-based, and even deep learning models for classification and regression tasks.

from powershap import PowerShap
from catboost import CatBoostClassifier

X, y = ...  # your classification dataset

selector = PowerShap(
    model=CatBoostClassifier(n_estimators=250, verbose=0, use_best_model=True)
)

selector.fit(X, y)  # Fit the PowerShap feature selector
selector.transform(X)  # Reduce the dataset to the selected features

Features ✨

  • default automatic mode
  • scikit-learn compatible
  • supports various models
  • insights into the feature selection method: call the ._processed_shaps_df on a fitted PowerSHAP feature selector.
  • tested code!

Benchmarks ⏱

Check out our benchmark results here.

How does it work ⁉️

Powershap is built on the core assumption that an informative feature will have a larger impact on the prediction compared to a known random feature.

  • Powershap trains multiple models with different random seeds on different subsets of the data. Each iteration it adds a random uniform feature to the dataset for training.
  • In a single iteration after training a model, powershap calculates the absolute Shapley values of all features, including the random feature. If there are multiple outputs or multiple classes, powershap uses the maximum across these multiple outputs. These values are then averaged for each feature, symbolising the impact of the feature in this iteration.
  • After performing all iterations, each feature then has an array of impacts. The impact array of each feature is then compared to the average of the random feature impact array using the percentile formula to provide a p-value. This tests whether the feature has a larger impact than the random feature and outputs a low p-value if true.
  • Powershap then outputs all features with a p-value below the provided threshold. The threshold is by default 0.01.

Automatic mode 🤖

The required number of iterations and the threshold values are hyperparameters of powershap. However, to avoid manually optimizing the hyperparameters powershap by default uses an automatic mode that automatically determines these hyperparameters.

  • The automatic mode first starts with executing powershap using ten iterations.
  • Then, for each feature powershap calculates the effect size and the statistical power of the test using a student-t power test.
  • Using the calculated effect size, powershap then calculates the required iterations to achieve a predefined power requirement. By default this is 0.99, which represents a false positive probability of 0.01.
  • If the required iterations are larger than the already performed iterations, powershap then further executes for the extra required iterations.
  • Afterward, powershap re-calculates the required iterations and it keeps re-executing until the required iterations are met.

Referencing our package :memo:

If you use powershap in a scientific publication, we would highly appreciate citing us as:

@InProceedings{10.1007/978-3-031-26387-3_5,
author="Verhaeghe, Jarne
and Van Der Donckt, Jeroen
and Ongenae, Femke
and Van Hoecke, Sofie",
title="Powershap: A Power-Full Shapley Feature Selection Method",
booktitle="Machine Learning and Knowledge Discovery in Databases",
year="2023",
publisher="Springer International Publishing",
address="Cham",
pages="71--87",
isbn="978-3-031-26387-3"
}

Paper was presented at ECML PKDD 2022. The manuscript can be found here and on the github.


👤 Jarne Verhaeghe, Jeroen Van Der Donckt

License

This package is available under the MIT license. More information can be found here: https://github.com/predict-idlab/powershap/blob/main/LICENSE

Metadata

Release files for powershap 0.1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for powershap 0.1.0.1
File Size Uploaded
powershap-0.1.0.1.tar.gz 2.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for powershap 0.1.0.1
File Interpreter ABI Platform
powershap-0.1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 2.6 MB

Release files / powershap-0.1.0.1.tar.gz

Download URL powershap-0.1.0.1.tar.gz
Size 2.6 MB
Tags Source
SHA-256 checksum
How to use checksums
214a2725e5c13b33b49f22ad6f58fae28b8ced5b9cf9260a0e7ffd7028f6b38a
BLAKE2b-256 checksum
How to use checksums
4136ce47c83981db8a18d4ec7a1928008def94ba35a814ec6bed68a67035013e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.11

Release files / powershap-0.1.0.1-py3-none-any.whl

Download URL powershap-0.1.0.1-py3-none-any.whl
Size 17.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7006f3d0d27fbd3c7479cd621a076b7073bd89057b8fe128c5c6b1bedcbc10ce
BLAKE2b-256 checksum
How to use checksums
1ce41b7a4016b82daf2ca398261182c2b31f80abfa73010b8dea16d4828a73dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.11

Release history Release notifications | RSS feed

This release

0.1.0.1 This release

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page