From 6dbf515b5e8364567de5be12d5e58d7a6ac14c6d Mon Sep 17 00:00:00 2001
From: es-dell <168178251+es-dell@users.noreply.github.com>
Date: Fri, 16 Aug 2024 01:00:43 +0800
Subject: [PATCH] update README

---
 .../algorithms/local_shap_toolbox/README.md   | 36 +++++++++++++++----
 1 file changed, 30 insertions(+), 6 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
index 217bd9cf1..727b2a6c4 100644
--- 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
@@ -1,10 +1,34 @@
-# Algorithm - local SHAP toolbox
+# SHAP Toolbox
 
 ## Description
-* local shap algorithm
+This plugin explains how your features affect your overall prediction for a single row of data by using Shapley Values.
 
-## License
-* Licensed under Apache Software License 2.0
+## 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. |
 
-## Developers:
-* Example Author
+- 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)
\ No newline at end of file