Skip to main content

A package for calculating permutation importance and selecting features.

Project description

Permutation Feature Selector

Run Tests Upload Python Package Python Versions

Acknowledgements

This library is inspired by the functionality and design of Scikit-learn's permutation importance.

Links

PyPI:https://pypi.org/project/permutation_feature_selector/

Installation

To install the Library,

Standard Installation

You can install the package directly from PyPI using pip. This is the easiest and most common method:

$ pip install permutation_feature_selector

Installation from Source

If you prefer to install from the source or if you want the latest version that may not yet be released on PyPI, you can use the following commands:

$ git clone https://github.com/Itsuki-2822/permutation_feature_selector.git
$ cd permutation_feature_selector
$ python setup.py install

For developer

If you are a contributor or if you want to install the latest development version of the library, use the following command to install directly from the GitHub repository:

$ pip install --upgrade git+https://github.com/Itsuki-2822/permutation_feature_selector

What Permutation Importance

Basic Concept

The calculation of permutation importance proceeds through the following steps:

  • Evaluate Model Performance:

    • Measure the performance metric (e.g., accuracy or error) of the model using the original dataset before any permutation.
  • Shuffle the Feature:

    • Randomly shuffle the order of values in one feature of the dataset. This disrupts the relationship between that feature and the target variable.
  • Re-evaluate Performance:

    • Assess the model's performance again, using the dataset with the shuffled feature.
  • Calculate Importance:

    • Compute the difference in performance before and after the permutation. A larger difference indicates that the feature is more "important."

Model-Independent Advantage

Permutation importance is independent of the internal mechanisms of any specific model, which means it does not rely on the evaluation mechanisms specific to models like gradient boosting or decision trees. It can be applied across various predictive models (linear models, decision trees, neural networks, etc.)

Considerations for Use

  • Randomness:

    • Since the feature shuffling is a random process, the results may vary slightly each time. To obtain stable evaluations, averaging several assessments is recommended.
  • Correlated Features:

    • If multiple features are strongly correlated, their importance may be underestimated. Addressing this issue may require careful feature selection and engineering.

Examples

import numpy as np
import pandas as pd
from sklearn.model_selection import train_test_split
from sklearn.datasets import load_diabetes
import lightgbm as lgb
import matplotlib.pyplot as plt
from permutation_feature_selector import PermutationFeatureSelector

data = load_diabetes()
X = pd.DataFrame(data.data, columns=data.feature_names)
y = data.target

X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=42)

model = lgb.LGBMRegressor()
model.fit(X_train, y_train)

selector = PermutationFeatureSelector(model, X_test, y_test, metric='rmse', n_repeats=30, random_state=42)

# Calculation of permutation importance
perm_importance = selector.calculate_permutation_importance()
print(perm_importance)

# Permutation Importance Plot
selector.plot_permutation_importance()

# Feature selection (e.g., select features with importance at least 1x the average)
chosen_features, chosen_features_df = selector.choose_feat(threshold_method='mean', threshold_value=1.0)
print(chosen_features)
print(chosen_features_df)

References

scikit-learn.org:

medium.com:

hacarus.github.io:

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

permutation_feature_selector-0.1.10.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file permutation_feature_selector-0.1.10.tar.gz.

File metadata

File hashes

Hashes for permutation_feature_selector-0.1.10.tar.gz
Algorithm Hash digest
SHA256 22587f576752986ed6bbf9c8ce0b9508085782df5624b5f8ad4b4784f2bc02e7
MD5 cabe21f269583d926f397633e6e0ed20
BLAKE2b-256 88dcbb714f87f7f09d095176544eef2921a17a31b1f0428507cf6087b1bc14b8

See more details on using hashes here.

File details

Details for the file permutation_feature_selector-0.1.10-py3-none-any.whl.

File metadata

File hashes

Hashes for permutation_feature_selector-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 3eb3e5264ccb08f167a792f5d9dd61690024603e73b657275f4924995f4ef550
MD5 10a7d6d6847ae1cc2020e3aeac179bc1
BLAKE2b-256 31cf2a3fbe3ac1e4c44b1c3e3fd13fd4d7208f484ece66f23fcafac968fc2ca6

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