feat: ICE/PDP explainer #1284

ezherdeva · 2021-12-03T01:51:38Z

In this PR, I'm introducing ICETransformer and adding it in the com.microsoft.ml.spark.explainers package.

ICETransformer displays the model dependence on specified features with the given data frame.

ICETransformer supports categorical and numeric features.
It supports 2 types of plots: "average" - PDP and "individual" - ICE
This transformer only supports a one-way dependence plot.

Also, I added ICECategoricalFeature and ICENumericFeature classes which are used in ICETransformer.

All of these classes can be called from the python side.

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

…park into ezherdeva/ice_pdp

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

…park into ezherdeva/ice_pdp

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

…park into ezherdeva/ice_pdp

…g/FuzzingTest.scala Co-authored-by: Kashyap Patel <64443771+ms-kashyap@users.noreply.github.com>

ms-kashyap · 2021-12-03T18:59:38Z

/azp run

azure-pipelines · 2021-12-03T18:59:49Z

Azure Pipelines successfully started running 1 pipeline(s).

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala

mhamilton723

Thank you so much for this fantastic work! I put in a few nits but to give it a good review perhaps we should chat so I can get a better idea of what this does then

core/src/main/python/synapse/ml/explainers/ICETransformer.py

mhamilton723 · 2021-12-03T20:08:48Z

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala

+    val result = predicted.withColumn(targetCol, explainTarget)
+
+    getKind.toLowerCase match {
+      case this.averageKind =>


nit: idt you need the "this" here

Added backticks, because it's looking for a stable identifier. Ref: https://stackoverflow.com/questions/7078022/why-does-pattern-matching-in-scala-not-work-with-variables

mhamilton723 · 2021-12-03T20:09:08Z

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala

+    val targetClasses = DatasetExtensions.findUnusedColumnName("targetClasses", df)
+    val dfWithId = df
+      .withColumn(idCol, monotonically_increasing_id())
+      .withColumn(targetClasses, this.get(targetClassesCol).map(col).getOrElse(lit(getTargetClasses)))


nit: use getters directly here

targetClassesCol is Optional by design, that's why we're using get like this

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala

…park into ezherdeva/ice_pdp

mhamilton723 · 2021-12-14T05:08:11Z

/azp run

azure-pipelines · 2021-12-14T05:08:22Z

Azure Pipelines successfully started running 1 pipeline(s).

mhamilton723

Left a bit more detailed feedback. Looks awesome though and appreciate all the hard work and iterations!

core/src/main/python/synapse/ml/explainers/ICETransformer.py

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEFeature.scala

core/src/test/scala/com/microsoft/azure/synapse/ml/explainers/split1/ICEExplainerSuite.scala

…park into ezherdeva/ice_pdp

mhamilton723 · 2021-12-17T17:33:00Z

/azp run

azure-pipelines · 2021-12-17T17:33:10Z

Azure Pipelines successfully started running 1 pipeline(s).

mhamilton723

A lot of the comments that are marked as resolved don't seem to be resolved perhaps I'm missing something or commenting too early

core/src/main/python/synapse/ml/explainers/ICETransformer.py

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala

mhamilton723 · 2021-12-20T16:24:46Z

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala

+  }
+
+  private def collectCategoricalValues[_](df: DataFrame, feature: ICECategoricalFeature): Array[_] = {
+    val featureCount = DatasetExtensions.findUnusedColumnName("__feature__count__", df)


might want to rename this to featureCount to be consistent with other added columns

ezherdeva and others added 28 commits September 17, 2021 11:09

Initial PDP version.

aa166b5

Apply suggestions

151ef99

Added ICE

b47d410

Apply suggestions and fix

7d70110

Added discrete

f5049e3

Added logic for discrete features

e6e985e

New logic (without unit tests)

a23df5c

WIP

43d1648

WIP

9b379e8

rebased the main branch

b9cbb7b

small fix

5ba0bec

added some unit tests

c0c9ddf

added python code

51e3d4f

Update core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/…

bda7882

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

Update core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/…

fa0aa6f

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

Update core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/…

adc4301

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

fix1

058f27b

Merge branch 'ezherdeva/ice_pdp' of https://github.com/ezherdeva/mmls…

f234890

…park into ezherdeva/ice_pdp

Update core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/…

5d3d38e

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

Merge branch 'ezherdeva/ice_pdp' of https://github.com/ezherdeva/mmls…

b630d39

…park into ezherdeva/ice_pdp

Update core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/…

172a050

…ICEExplainer.scala Co-authored-by: Jason Wang <jasonwang_83@hotmail.com>

fix 2

69486ed

Merge branch 'ezherdeva/ice_pdp' of https://github.com/ezherdeva/mmls…

fd7d13b

…park into ezherdeva/ice_pdp

Fixed comments

1d658d5

fix comments

25ad8fa

fix comments 2

8045357

Merge branch 'master' into ezherdeva/ice_pdp

df4e6c6

last fix

2c207d3

ezherdeva requested review from memoryz and mhamilton723 as code owners December 3, 2021 01:51

Update src/test/scala/com/microsoft/azure/synapse/ml/core/test/fuzzin…

77b6267

…g/FuzzingTest.scala Co-authored-by: Kashyap Patel <64443771+ms-kashyap@users.noreply.github.com>

memoryz requested changes Dec 3, 2021

View reviewed changes

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala Outdated Show resolved Hide resolved

mhamilton723 requested changes Dec 3, 2021

View reviewed changes

ms-kashyap reviewed Dec 3, 2021

View reviewed changes

ezherdeva marked this pull request as draft December 3, 2021 20:54

ezherdeva added 6 commits December 6, 2021 22:26

fix 2

7c25c57

Merge branch 'ezherdeva/ice_pdp' of https://github.com/ezherdeva/mmls…

98173d5

…park into ezherdeva/ice_pdp

fix python issue

a11c718

fix python issue (small fix)

6483daf

fixed python issue

ef2c35e

fixed comments and add more docs

8c3a6dc

ezherdeva marked this pull request as ready for review December 11, 2021 00:56

ezherdeva requested review from mhamilton723 and memoryz December 11, 2021 00:57

Merge branch 'master' into ezherdeva/ice_pdp

5b53fa5

mhamilton723 requested changes Dec 14, 2021

View reviewed changes

ezherdeva added 3 commits December 15, 2021 15:11

fix comments

e492014

Merge branch 'ezherdeva/ice_pdp' of https://github.com/ezherdeva/mmls…

0043fb6

…park into ezherdeva/ice_pdp

fix code style

61624de

ezherdeva requested a review from mhamilton723 December 15, 2021 23:55

mhamilton723 requested changes Dec 17, 2021

View reviewed changes

core/src/main/python/synapse/ml/explainers/ICETransformer.py Outdated Show resolved Hide resolved

core/src/main/scala/com/microsoft/azure/synapse/ml/explainers/ICEExplainer.scala Outdated Show resolved Hide resolved

mhamilton723 approved these changes Dec 20, 2021

View reviewed changes

Merge branch 'master' into ezherdeva/ice_pdp

9254b8d

mhamilton723 merged commit 46cd375 into microsoft:master Dec 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ICE/PDP explainer #1284

feat: ICE/PDP explainer #1284

ezherdeva commented Dec 3, 2021

ms-kashyap commented Dec 3, 2021

azure-pipelines bot commented Dec 3, 2021

mhamilton723 left a comment

mhamilton723 Dec 3, 2021

ezherdeva Dec 11, 2021

mhamilton723 Dec 3, 2021

ezherdeva Dec 10, 2021

mhamilton723 commented Dec 14, 2021

azure-pipelines bot commented Dec 14, 2021

mhamilton723 left a comment

mhamilton723 commented Dec 17, 2021

azure-pipelines bot commented Dec 17, 2021

mhamilton723 left a comment

mhamilton723 Dec 20, 2021

feat: ICE/PDP explainer #1284

feat: ICE/PDP explainer #1284

Conversation

ezherdeva commented Dec 3, 2021

ms-kashyap commented Dec 3, 2021

azure-pipelines bot commented Dec 3, 2021

mhamilton723 left a comment

Choose a reason for hiding this comment

mhamilton723 Dec 3, 2021

Choose a reason for hiding this comment

ezherdeva Dec 11, 2021

Choose a reason for hiding this comment

mhamilton723 Dec 3, 2021

Choose a reason for hiding this comment

ezherdeva Dec 10, 2021

Choose a reason for hiding this comment

mhamilton723 commented Dec 14, 2021

azure-pipelines bot commented Dec 14, 2021

mhamilton723 left a comment

Choose a reason for hiding this comment

mhamilton723 commented Dec 17, 2021

azure-pipelines bot commented Dec 17, 2021

mhamilton723 left a comment

Choose a reason for hiding this comment

mhamilton723 Dec 20, 2021

Choose a reason for hiding this comment