Skip to content

Commit aae34bf

Browse files
Merge pull request #7 from Moeflon/patch-1
🏋️ emoji README
2 parents fc6e7ec + 17698af commit aae34bf

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# PowerSHAP
1+
# PowerShap 🏋️
22

33
> *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.
44
5-
## Installation
5+
## Installation ⚙️
66

77
| [**pip**](https://pypi.org/project/powershap/) | `pip install powershap` |
88
| ---| ----|
99

10-
## Usage
10+
## Usage 🛠
1111

1212
*powershap* is built to be intuitive, it supports various models including linear, tree-based, and even deep learning models.
1313
<!-- It is also implented as sklearn `Transformer` component, allowing convenient integration in `sklearn` pipelines. -->
@@ -27,19 +27,19 @@ selector.transform(X) # Reduce the dataset to the selected features
2727

2828
```
2929

30-
## Features
30+
## Features
3131

3232
* default automatic mode
3333
* `scikit-learn` compatible
3434
* supports various models
3535
* insights into the feature selection method: call the `._processed_shaps_df` on a fitted `PowerSHAP` feature selector.
3636
* tested code!
3737

38-
## Benchmarks
38+
## Benchmarks
3939

4040
Check out our benchmark results [here](examples/results/).
4141

42-
## How it works
42+
## How it works ⁉️
4343

4444
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.*
4545

@@ -49,7 +49,7 @@ Powershap is built on the core assumption that *an informative feature will have
4949
* Powershap then outputs all features with a p-value below the provided threshold. The threshold is by default 0.01.
5050

5151

52-
### Automatic mode
52+
### Automatic mode 🤖
5353

5454
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.
5555

0 commit comments

Comments
 (0)