Skip to main content

Feature selection using statistical significance of shap values with powershap-statistical-analysis-rs

Project description

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_rs 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

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

powershap_rs-0.2.0.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

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

powershap_rs-0.2.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file powershap_rs-0.2.0.tar.gz.

File metadata

  • Download URL: powershap_rs-0.2.0.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Darwin/23.3.0

File hashes

Hashes for powershap_rs-0.2.0.tar.gz
Algorithm Hash digest
SHA256 acd814e0ecaa560aa79df385e3faf342a1fee960c9a159baea7ec121ae7129cf
MD5 ec7e6f24c687081fd9017169e31813ab
BLAKE2b-256 f678275ec847e7fb7dcdfa50f40953a2bcdc0293c927389db77fa74be5a580a6

See more details on using hashes here.

File details

Details for the file powershap_rs-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: powershap_rs-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Darwin/23.3.0

File hashes

Hashes for powershap_rs-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f24b3d32aa14e0d74c6bcbf13150f6b35a9f1544208948bc5742f8c0188dbf82
MD5 7ea226a8648299c3ddde0863fd8fe142
BLAKE2b-256 a5c667e43f03d067eb2213bfec1adc449c9a5f46e7da7281f56dc8764315dfa7

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