[Model] Add Node explanation for Heterogenous PGExplainer Impl. #6050

ndbaker1 · 2023-07-27T04:41:31Z

Description

Implemented Node explanations for PGExplainer (https://arxiv.org/pdf/2011.04573.pdf) for Heterogenous Graphs. (extending #5739)

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 (example, test and documentation could be exempted). (majority of new lines are documentation)
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

Changes

Added the explain_node method for heterogeneous implementation of PGExplainer.
cleaned up explain_node internals for homogeneous implementation

An example of using the method is included in the documentation.

Tests run for MUTAG visualization scripts utilizing explain_node.

dgl-bot · 2023-07-27T04:42:01Z

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

@dgl-bot

dgl-bot · 2023-07-27T04:42:13Z

Commit ID: 1de768ee71f3a03b70249d9e52b1d62f7f3bcaa5

Build ID: 1

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

Report path: link

Full logs path: link

dgl-bot · 2023-08-03T08:06:01Z

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

@dgl-bot

dgl-bot · 2023-08-03T08:06:13Z

Commit ID: 464788b0f89d35e78ff84edd2508dac73ec5538c

Build ID: 2

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

Report path: link

Full logs path: link

frozenbugs · 2023-08-10T02:23:05Z

@ndbaker1 Hi, are you still working on this PR, what's the status of it?

dgl-bot · 2023-08-13T08:15:50Z

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

@dgl-bot

dgl-bot · 2023-08-13T08:16:03Z

Commit ID: fb2d1b06f459565d6c75dd505f6f928f85a4f6ac

Build ID: 3

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

Report path: link

Full logs path: link

dgl-bot · 2023-08-13T08:16:05Z

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

@dgl-bot

dgl-bot · 2023-08-13T08:16:17Z

Commit ID: 6692a94722cd85d02673df52f79ac1aba26d4927

Build ID: 4

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

Report path: link

Full logs path: link

dgl-bot · 2023-08-13T08:17:09Z

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

@dgl-bot

dgl-bot · 2023-08-13T08:17:21Z

Commit ID: e9483441f488ad92c3c17d9d6aa11401395409e0

Build ID: 5

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

Report path: link

Full logs path: link

dgl-bot · 2023-08-13T08:45:39Z

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

@dgl-bot

dgl-bot · 2023-08-13T08:45:52Z

Commit ID: 82514a32dafe75f5c463c838fd0a79e6b2726177

Build ID: 6

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

Report path: link

Full logs path: link

ndbaker1 · 2023-08-13T08:48:01Z

@ndbaker1 Hi, are you still working on this PR, what's the status of it?

hi @frozenbugs, I'm still working on these changes but response time may vary as it has been difficult to allocate time for work.

As of now the documentation is updated and sanity checks are running, so it will move out of draft status 👏

frozenbugs · 2023-08-14T00:13:13Z

@dgl-bot

dgl-bot · 2023-08-14T00:58:18Z

Commit ID: ceb4137b604bceeaaeb682c7d50b7a82504d150c

Build ID: 7

Status: ❌ CI test failed in Stage [Torch GPU Unit test].

Report path: link

Full logs path: link

dgl-bot · 2023-08-25T09:39:39Z

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

@dgl-bot

dgl-bot · 2023-08-25T09:39:52Z

Commit ID: 5d316939a9fc012f7308d871dac953273acdb7a7

Build ID: 8

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

Report path: link

Full logs path: link

frozenbugs · 2023-08-26T02:18:48Z

@dgl-bot

dgl-bot · 2023-08-26T02:55:15Z

Commit ID: 0852f78d7618f877f99cbf12bcce4078b3c451df

Build ID: 9

Status: ❌ CI test failed in Stage [Torch GPU Unit test].

Report path: link

Full logs path: link

dgl-bot · 2023-08-28T05:51:51Z

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

@dgl-bot

dgl-bot · 2023-08-28T05:52:02Z

Commit ID: 9f6ea74fcac5a0eb1cc3faff0ab9f973c0623908

Build ID: 10

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

Report path: link

Full logs path: link

dgl-bot · 2023-09-12T05:11:24Z

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

@dgl-bot

dgl-bot · 2023-09-12T05:11:36Z

Commit ID: 4b93a61f492eea258e42704158d0521f9f96aa21

Build ID: 16

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

Report path: link

Full logs path: link

ndbaker1 · 2023-09-12T05:18:07Z

comments addressed, ready for bot trigger 👍

frozenbugs · 2023-09-12T06:06:41Z

@dgl-bot

dgl-bot · 2023-09-12T06:08:49Z

Commit ID: 7d772ca5d82adc62fd0eebcdaf3ee7ee93ab063f

Build ID: 17

Status: ❌ CI test failed in Stage [Lint Check].

Report path: link

Full logs path: link

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

frozenbugs · 2023-09-12T07:49:42Z

@ndbaker1 it seems I can not edit your PR directly so you have to handle the nit comment by yourself.

BarclayII

I'm good. Please feel free to merge after incorporating the suggestion from @frozenbugs .

Co-authored-by: Hongzhi (Steve), Chen <chenhongzhi.nkcs@gmail.com>

dgl-bot · 2023-09-13T05:41:22Z

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

@dgl-bot

dgl-bot · 2023-09-13T05:41:34Z

Commit ID: 669630ae51908d5b002f437ae3c3863c935cbf8f

Build ID: 18

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

Report path: link

Full logs path: link

frozenbugs · 2023-09-13T05:55:26Z

@dgl-bot

dgl-bot · 2023-09-13T05:57:41Z

Commit ID: 5ee92605a56174770d87fd5a8a2cb2518728288b

Build ID: 19

Status: ❌ CI test failed in Stage [Lint Check].

Report path: link

Full logs path: link

dgl-bot · 2023-09-13T06:03:27Z

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

@dgl-bot

dgl-bot · 2023-09-13T06:03:39Z

Commit ID: fecc0c55c23ea07a9d971e8e2449fb646b83c35b

Build ID: 20

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

Report path: link

Full logs path: link

frozenbugs · 2023-09-13T06:08:26Z

@dgl-bot

dgl-bot · 2023-09-13T07:06:37Z

Commit ID: 1379be5d9989fbc8acf34a8557ed7953af04d1d7

Build ID: 21

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

Report path: link

Full logs path: link

frozenbugs · 2023-09-13T07:12:34Z

@dgl-bot

dgl-bot · 2023-09-13T08:21:18Z

Commit ID: 889fbc77f85360483d5fe591a837a3e234942c55

Build ID: 22

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

Report path: link

Full logs path: link

ndbaker1 · 2023-09-14T01:53:05Z

logs show that relevant tests for this PR are passing

tests/python/pytorch/nn/test_nn.py::test_pgexplainer[2-g0-idtype0] PASSED [ 53%]
tests/python/pytorch/nn/test_nn.py::test_pgexplainer[2-g0-idtype1] PASSED [ 53%]
tests/python/pytorch/nn/test_nn.py::test_pgexplainer[2-g1-idtype0] PASSED [ 53%]
tests/python/pytorch/nn/test_nn.py::test_pgexplainer[2-g1-idtype1] PASSED [ 53%]
tests/python/pytorch/nn/test_nn.py::test_heteropgexplainer[2-5-idtype0-g0] PASSED [ 53%]
tests/python/pytorch/nn/test_nn.py::test_heteropgexplainer[2-5-idtype0-g1] PASSED [ 53%]

frozenbugs · 2023-09-14T02:00:50Z

@ndbaker1 thanks for letting us know, yes, something wrong with the CI, we will take a look at it, and I will handle the merge of the PR.

frozenbugs · 2023-09-14T02:04:13Z

@dgl-bot

dgl-bot · 2023-09-14T02:40:54Z

Commit ID: c894750c83f72c15ce6fd19fe1c1d0a33a27bca9

Build ID: 23

Status: ✅ CI test succeeded.

Report path: link

Full logs path: link

…#6050) Co-authored-by: Quan (Andy) Gan <coin2028@hotmail.com> Co-authored-by: Hongzhi (Steve), Chen <chenhongzhi.nkcs@gmail.com>

test cases and work in progress impls. for pgexplainer explain_node

4af12ee

update explain node strategy and test hetero node impl

41e2474

cleanup batching code by taking advantage of stored node data

f700b92

cleanup

7c328d1

update docs

79e875f

ndbaker1 marked this pull request as ready for review August 13, 2023 08:48

convert mask tensor to subgraph device

452a663

convert from tensor to avoid device conflict

b725c6e

update tmp to temperature to remove ambiguity

aafee79

frozenbugs reviewed Sep 12, 2023

View reviewed changes

python/dgl/nn/pytorch/explain/pgexplainer.py Outdated Show resolved Hide resolved

frozenbugs reviewed Sep 12, 2023

View reviewed changes

python/dgl/nn/pytorch/explain/pgexplainer.py Outdated Show resolved Hide resolved

BarclayII approved these changes Sep 12, 2023

View reviewed changes

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

0348111

Co-authored-by: Hongzhi (Steve), Chen <chenhongzhi.nkcs@gmail.com>

allow super delegation with updated doc-string

826d6b4

frozenbugs approved these changes Sep 14, 2023

View reviewed changes

frozenbugs merged commit eb40ed5 into dmlc:master Sep 14, 2023
2 checks passed

ndbaker1 deleted the hetero-pgexplainer-explain-node branch September 14, 2023 02:45

[Model] Add Node explanation for Heterogenous PGExplainer Impl. #6050

[Model] Add Node explanation for Heterogenous PGExplainer Impl. #6050

Conversation

ndbaker1 commented Jul 27, 2023 • edited

Description

Checklist

Changes

dgl-bot commented Jul 27, 2023

dgl-bot commented Jul 27, 2023

dgl-bot commented Aug 3, 2023

dgl-bot commented Aug 3, 2023

frozenbugs commented Aug 10, 2023

dgl-bot commented Aug 13, 2023

dgl-bot commented Aug 13, 2023

dgl-bot commented Aug 13, 2023

dgl-bot commented Aug 13, 2023

dgl-bot commented Aug 13, 2023

dgl-bot commented Aug 13, 2023

dgl-bot commented Aug 13, 2023

dgl-bot commented Aug 13, 2023

ndbaker1 commented Aug 13, 2023

frozenbugs commented Aug 14, 2023

dgl-bot commented Aug 14, 2023

dgl-bot commented Aug 25, 2023

dgl-bot commented Aug 25, 2023

frozenbugs commented Aug 26, 2023

dgl-bot commented Aug 26, 2023

dgl-bot commented Aug 28, 2023

dgl-bot commented Aug 28, 2023

dgl-bot commented Sep 12, 2023

dgl-bot commented Sep 12, 2023

ndbaker1 commented Sep 12, 2023

frozenbugs commented Sep 12, 2023

dgl-bot commented Sep 12, 2023

frozenbugs commented Sep 12, 2023

BarclayII left a comment

Choose a reason for hiding this comment

dgl-bot commented Sep 13, 2023

dgl-bot commented Sep 13, 2023

frozenbugs commented Sep 13, 2023

dgl-bot commented Sep 13, 2023

dgl-bot commented Sep 13, 2023

dgl-bot commented Sep 13, 2023

frozenbugs commented Sep 13, 2023

dgl-bot commented Sep 13, 2023

frozenbugs commented Sep 13, 2023

dgl-bot commented Sep 13, 2023

ndbaker1 commented Sep 14, 2023

frozenbugs commented Sep 14, 2023

frozenbugs commented Sep 14, 2023

dgl-bot commented Sep 14, 2023

ndbaker1 commented Jul 27, 2023 •

edited