I've added documentation and examples for GNN explainability. #1587
Conversation
This commit adds documentation and example notebooks for the GNNExplainer and PGExplainer features.
Changes include:
- **README.md:** I created `captum/attr/_gnn/README.md` with an overview of GNN explainability methods in Captum.
- **Sphinx Documentation:**
- I added `sphinx/source/gnn_explainer.rst` and `sphinx/source/pg_explainer.rst`.
- I updated `sphinx/source/index.rst` to include these new files in the API reference.
- **Example Notebooks:**
- I created `tutorials/GNNExplainer_Tutorial.ipynb` demonstrating the usage of `GNNExplainer`.
- I created `tutorials/PGExplainer_Tutorial.ipynb` demonstrating the usage of `PGExplainer`, including training the explainer network and generating explanations.
These additions provide you with the necessary information and examples to start using the new GNN explainability features in Captum.
|
Hi @Adam-Guerin! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
This commit adds documentation and example notebooks for the GNNExplainer and PGExplainer features.
Changes include:
captum/attr/_gnn/README.mdwith an overview of GNN explainability methods in Captum.sphinx/source/gnn_explainer.rstandsphinx/source/pg_explainer.rst.sphinx/source/index.rstto include these new files in the API reference.tutorials/GNNExplainer_Tutorial.ipynbdemonstrating the usage ofGNNExplainer.tutorials/PGExplainer_Tutorial.ipynbdemonstrating the usage ofPGExplainer, including training the explainer network and generating explanations.These additions provide you with the necessary information and examples to start using the new GNN explainability features in Captum.