Merge pull request #365 from aiverify-foundation/add-local-shap-readme

Add Local Shap Readme.md
aiverify-foundation · Oct 17, 2024 · 44a08f9 · 44a08f9
2 parents 5b14833 + 4df4b42
commit 44a08f9
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/stock-plugins/aiverify.stock.shap-toolbox/algorithms/local_shap_toolbox/README.md b/stock-plugins/aiverify.stock.shap-toolbox/algorithms/local_shap_toolbox/README.md
@@ -0,0 +1,34 @@
+# SHAP Toolbox
+
+## Description
+This plugin explains how your features affect your overall prediction for a single row of data by using Shapley Values.
+
+## Plugin Content
+- Algorithms
+
+| Name               | Description                                                                                      |
+| ------------------ | ------------------------------------------------------------------------------------------------ |
+| SHAP Toolbox | SHAP (SHapley Additive exPlanations) is a game theoretic approach to explain the output of any machine learning model. |
+
+- Widgets
+
+| Name                       | Description                                                                              |
+| -------------------------- | ---------------------------------------------------------------------------------------- |
+| Local Explainability Chart | To display the SHAP values using a bar chart for the selection row, and display row data |
+
+## Using the Plugin in AI Verify
+### Data Preparation
+- Tabular dataset ([Tutorial for Preparation](https://imda-btg.github.io/aiverify/getting-started/prepare-tabular/))
+
+### Algorithm User Input(s)
+
+| Input Field                 | Description                                                |   Type   |
+| --------------------------- | -----------------------------------------------------------| :------: |
+| Row Number                  | Row number of data to perform local explainability test    |  `int`   |
+| Path of the background data | Background data path                                       | `string` |
+| Size of the background      | Background samples (eg. 25)                                |  `int`   |
+| Size of the test dataset    | Data Samples (eg. 25)                                      |  `int`   |
+
+### Sample use of the widgets
+
+![SHAP sample](images/local_shap_sample.png)