[Model] Implemented SubgraphX Explainer for Homogeneous graph #4913

kunmukh · 2022-11-16T23:41:58Z

Description

Implemented SubgraphX Explainer (https://arxiv.org/pdf/2102.05152.pdf) for Homogeneous Graphs

Checklist

Please feel free to remove inapplicable items for your PR.

The PR title starts with [$CATEGORY] (such as [NN], [Model], [Doc], [Feature]])
I've leverage the tools to beautify the python and c++ code.
The PR is complete and small, read the Google eng practice (CL equals to PR) to understand more about small PR. In DGL, we consider PRs with less than 200 lines of core code change are small (for example, test, and documentation could be exempted).
All changes have test coverage
Code is well-documented
To the best of my knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change
Related issue is referred in this PR
If the PR is for a new model/paper, I've updated the example index here.

Changes

Added a new class, SubgraphXExplainer for homogeneous graph explanation.

The output of the model has been manually verified on MUTAG dataset. Unfortunately, there's no ground truth for the explanation, so we cannot quantify the model's performance. Instead, we manually investigated the results and confirmed that they aligned well with human intuition.

Inline documentation is added following the original style, and an example of using the module is included in the documentation.

* add HeteroGNNExplainer * GNNExplainer for heterogeenous graph * fix typo * variable name cleanup

Co-authored-by: Mufei Li <[email protected]>

Change DGLHeteroGraph to DGLGraph, and specified parameter inputs

…ppriopiate places to be consistent with existing practices

…ppriopiate places that were missed in the last commit

…claration.

…handled

dgl-bot · 2023-02-15T21:07:53Z

Commit ID: 70fe23bc95fc4be1e9708298e6147e90912eb831

Build ID: 65

Status: ❌ CI test failed in Stage [Authentication].

Report path: link

Full logs path: link

dgl-bot · 2023-02-15T21:08:01Z

Not authorized to trigger CI. Please ask core developer to help trigger via issuing comment:

@dgl-bot

dgl-bot · 2023-02-15T21:08:14Z

Commit ID: f201b69

Build ID: 66

Status: ❌ CI test failed in Stage [Authentication].

Report path: link

Full logs path: link

mufeili · 2023-02-16T07:17:59Z

python/dgl/nn/pytorch/explain/subgraphx.py

@@ -91,7 +91,7 @@ def __init__(
        model,
        num_hops,
        coef=10.0,
-        high2low=False,
+        high2low=True,


You also need to change the parameter description above.

mufeili · 2023-02-16T07:20:10Z

@dgl-bot

dgl-bot · 2023-02-16T08:12:01Z

Not authorized to trigger CI. Please ask core developer to help trigger via issuing comment:

@dgl-bot

dgl-bot · 2023-02-16T08:12:13Z

Commit ID: 730296f

Build ID: 67

Status: ❌ CI test failed in Stage [Authentication].

Report path: link

Full logs path: link

mufeili · 2023-02-16T08:21:28Z

@dgl-bot

dgl-bot · 2023-02-16T10:20:48Z

Not authorized to trigger CI. Please ask core developer to help trigger via issuing comment:

@dgl-bot

dgl-bot · 2023-02-16T10:21:01Z

Commit ID: 65975a5

Build ID: 69

Status: ❌ CI test failed in Stage [Authentication].

Report path: link

Full logs path: link

dgl-bot · 2023-02-16T11:21:21Z

Commit ID: 730296f

Build ID: 68

Status: ❌ CI test failed in Stage [Torch CPU (Win64) Unit test].

Report path: link

Full logs path: link

mufeili · 2023-02-16T12:02:16Z

The tests failed with

>           largest_cc_nids = subg.ndata[NID][largest_cc_nids].sort().values
E           IndexError: tensors used as indices must be long, byte or bool tensors

dgl-bot · 2023-02-16T13:52:06Z

Commit ID: 65975a5

Build ID: 70

Status: ❌ CI test failed in Stage [Torch CPU (Win64) Unit test].

Report path: link

Full logs path: link

dgl-bot · 2023-02-16T16:44:47Z

Not authorized to trigger CI. Please ask core developer to help trigger via issuing comment:

@dgl-bot

dgl-bot · 2023-02-16T16:44:59Z

Commit ID: 68535200ef20c8bc23a0bf566aa12ab63b22b210

Build ID: 71

Status: ❌ CI test failed in Stage [Authentication].

Report path: link

Full logs path: link

dgl-bot · 2023-02-16T16:53:10Z

Not authorized to trigger CI. Please ask core developer to help trigger via issuing comment:

@dgl-bot

dgl-bot · 2023-02-16T16:53:23Z

Commit ID: b8ba443

Build ID: 72

Status: ❌ CI test failed in Stage [Authentication].

Report path: link

Full logs path: link

dgl-bot · 2023-02-17T06:04:15Z

Not authorized to trigger CI. Please ask core developer to help trigger via issuing comment:

@dgl-bot

dgl-bot · 2023-02-17T06:04:27Z

Commit ID: d380df0

Build ID: 73

Status: ❌ CI test failed in Stage [Authentication].

Report path: link

Full logs path: link

mufeili · 2023-02-17T06:04:56Z

@dgl-bot

dgl-bot · 2023-02-17T08:09:47Z

Commit ID: d380df0

Build ID: 74

Status: ❌ CI test failed in Stage [Torch CPU (Win64) Unit test].

Report path: link

Full logs path: link

mufeili · 2023-02-17T08:32:21Z

It seems that this PR is never successfully built. I suspect there is something wrong with your fork/branch. Perhaps you should create a new fork from the latest DGL and move your code to that new fork. @kunmukh

kunmukh · 2023-02-17T19:20:51Z

New PR: #5315 . Therefore, closing this one. A new PR was created because the old PR test directory was re-structured and the test pipeline failed.

moeinfinityx and others added 30 commits August 15, 2022 19:35

[Model] Heterogeneous graph support for GNNExplainer (#1)

164530c

* add HeteroGNNExplainer * GNNExplainer for heterogeenous graph * fix typo * variable name cleanup

Merge branch 'master' into master

fdc3648

Merge branch 'master' into master

d4b33df

Merge branch 'master' into master

458db9b

added HeteroGNNExplainer test

227a020

added doc indexing for HeteroGNNExplainer

3df41a7

Merge branch 'master' into master

373ad9d

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

d86e052

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

c4c01ef

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

ac5b7e8

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

fd01972

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

c9e2560

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

5a8bd84

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

1582516

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

6c092cd

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

25d6621

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

ab56903

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

ae67e2f

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

1c04632

Co-authored-by: Mufei Li <[email protected]>

Update python/dgl/nn/pytorch/explain/gnnexplainer.py

70095dd

Co-authored-by: Mufei Li <[email protected]>

Update gnnexplainer.py

f418dc8

Change DGLHeteroGraph to DGLGraph, and specified parameter inputs

Added ntype parameter to the explainer_node call

04e81fd

responding to @mufeili's comment regarding restoring empty lines at a…

48a1b03

…ppriopiate places to be consistent with existing practices

Merge branch 'master' into master

e8a493a

responding to @mufeili's comment regarding restoring empty lines at a…

ee04b90

…ppriopiate places that were missed in the last commit

docstring comments added based on @mufeili suggestions

e436243

indorporated @mufeili requested changes related to docstring model de…

92ce82f

…claration.

Merge branch 'master' into master

5c62ccc

example model and test_nn.py added for explain_graphs

f0d2436

explain_nodes fixed and fixed the way hetero num nodes and edges are …

3094588

…handled

mufeili reviewed Feb 16, 2023

View reviewed changes

Merge branch 'master' into master

730296f

func docs updated to update the deafult value

65975a5

updated tensor index update to long type

5492ce4

Merge branch 'master' into master

b8ba443

Merge branch 'master' into master

d380df0

kunmukh mentioned this pull request Feb 17, 2023

[Model] Implemented SubgraphX Explainer for Homogeneous graph #5315

Merged

7 tasks

kunmukh closed this Feb 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Model] Implemented SubgraphX Explainer for Homogeneous graph #4913

[Model] Implemented SubgraphX Explainer for Homogeneous graph #4913

kunmukh commented Nov 16, 2022 •

edited

Loading

dgl-bot commented Feb 15, 2023

dgl-bot commented Feb 15, 2023

dgl-bot commented Feb 15, 2023

mufeili Feb 16, 2023

kunmukh Feb 16, 2023

mufeili commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

mufeili commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

mufeili commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 17, 2023

dgl-bot commented Feb 17, 2023

mufeili commented Feb 17, 2023

dgl-bot commented Feb 17, 2023

mufeili commented Feb 17, 2023

kunmukh commented Feb 17, 2023

[Model] Implemented SubgraphX Explainer for Homogeneous graph #4913

[Model] Implemented SubgraphX Explainer for Homogeneous graph #4913

Conversation

kunmukh commented Nov 16, 2022 • edited Loading

Description

Checklist

Changes

dgl-bot commented Feb 15, 2023

dgl-bot commented Feb 15, 2023

dgl-bot commented Feb 15, 2023

mufeili Feb 16, 2023

Choose a reason for hiding this comment

kunmukh Feb 16, 2023

Choose a reason for hiding this comment

mufeili commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

mufeili commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

mufeili commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 16, 2023

dgl-bot commented Feb 17, 2023

dgl-bot commented Feb 17, 2023

mufeili commented Feb 17, 2023

dgl-bot commented Feb 17, 2023

mufeili commented Feb 17, 2023

kunmukh commented Feb 17, 2023

kunmukh commented Nov 16, 2022 •

edited

Loading