Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add READMEs to some examples #8825

Merged
merged 5 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions examples/contrib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Examples for External Contributions

This directory contains examples demonstrating functionality included in the `torch_geometric.contrib` package.
The `contrib` package of PyG is a staging area for early-stage, experimental code.
Modules included here might be moved to the main library in the future.

| Example | Description |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| [`rbcd_attack.py`](./rbcd_attack.py) | An example of the RBCD (Resource-based Critical Data) attack |
| [`rbcd_attack_poisoning.py`](./rbcd_attack_poisoning.py) | An example of the RBCD (Resource-Based Critical Data) attack with data poisoning strategies |
| [`pgm_explainer_node_classification.py`](./pgm_explainer_node_classification.py) | An example of the PGM (Probabilistic Graphical Model) explainer for node classification |
| [`pgm_explainer_graph_classification.py`](./pgm_explainer_graph_classification.py) | An example of the PGM (Probabilistic Graphical Model) explainer for graph classification |
7 changes: 7 additions & 0 deletions examples/distributed/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Examples for Distributed Graph Learning

This directory contains examples for distributed graph learning.
The examples are organized into two subdirectories:

1. `pyg`: Distributed training via PyG's own `torch_geometric.distributed` package.
1. `graphlearn_for_pytorch`: Distributed training via the external GraphLearn-for-PyTorch (GLT) package.
13 changes: 13 additions & 0 deletions examples/explain/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Examples for Generating Explanations of Graph Neural Networks

This directory contains examples demonstrating the use of the `torch_geometric.explain` package.
The `explain` package of PyG provides a set of tools to explain the predictions of a GNN model or to explain the underlying phenomenon of a dataset.

| Example | Description |
| ---------------------------------------------------------------------- | ------------------------------------------------------- |
| [`gnn_explainer.py`](./gnn_explainer.py) | `GNNExplainer` for node classification |
| [`gnn_explainer_link_pred.py`](./gnn_explainer_link_pred.py) | `GNNExplainer` for link prediction |
| [`gnn_explainer_ba_shapes.py`](./gnn_explainer_ba_shapes.py) | `GNNExplainer` applied on the `BAShapes` dataset |
| [`captum_explainer.py`](./captum_explainer.py) | Captum-based explainer for node classification |
| [`captum_explainer_hetero_link.py`](./captum_explainer_hetero_link.py) | Captum-based explainer for heterogenous link prediction |
| [`graphmask_explainer.py`](./graphmask_explainer.py) | `GraphMaskExplainer` for node classification |
10 changes: 10 additions & 0 deletions examples/jit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# JIT Examples

This directory contains examples demonstrating the use of Just-In-Time (JIT) compilation in different GNN models.

| Example | Description |
| ---------------------- | ----------------------------------------------------------------- |
| [`gcn.py`](./gcn.py) | JIT compilation in `GCN` |
| [`gat.py`](./gat.py) | JIT compilation in `GAT` |
| [`gin.py`](./gin.py) | JIT compilation in `GIN` |
| [`film.py`](./film.py) | JIT compilation in [`GNN-FiLM`](https://arxiv.org/abs/1906.12192) |
7 changes: 7 additions & 0 deletions examples/pytorch_ignite/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Examples for PyTorch Ignite

This directory provides examples showcasing the integration of PyG with [PyTorch Ingite](https://pytorch.org/ignite/index.html).

| Example | Description |
| -------------------- | ---------------------------------------------------------------- |
| [`gin.py`](./gin.py) | Demonstrates how to implement the GIN model using PyTorch Ignite |
9 changes: 9 additions & 0 deletions examples/pytorch_lightning/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Examples for PyTorch Lightning

This directory provides examples showcasing the integration of PyG with [PyTorch Lightning](https://github.com/Lightning-AI/pytorch-lightning).

| Example | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------------ |
| [`graph_sage.py`](./graph_sage.py) | Combines PyG and PyTorch Lightning for node classification via the `GraphSAGE` model |
| [`gin.py`](./gin.py) | Combines PyG and PyTorch Lightning for graph classification via the `GIN` model |
| [`relational_gnn.py`](./relational_gnn.py) | Combines PyG and PyTorch Lightning for heterogeneous node classification |
Loading