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

[Example] Add Pytorch Geometric Example #4568

Merged
merged 34 commits into from
Nov 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
115cc62
add example for Pytorch Geometric
tchaton Nov 7, 2020
cd595f4
remove hydra
tchaton Nov 7, 2020
d2500ce
add docstring
tchaton Nov 7, 2020
3f68072
remove description
tchaton Nov 7, 2020
2c054c0
rename folder
tchaton Nov 7, 2020
dd1093a
update script to not break test
tchaton Nov 7, 2020
ccbc95e
Merge branch 'master' into ecosystem_examples
tchaton Nov 7, 2020
6145bd9
remove .lock
tchaton Nov 7, 2020
c0ca670
Merge branch 'master' into ecosystem_examples
tchaton Nov 7, 2020
ed8b9e0
Merge branch 'master' into ecosystem_examples
tchaton Nov 9, 2020
c5b8658
Merge branch 'ecosystem_examples' of https://github.com/PyTorchLightn…
tchaton Nov 9, 2020
e7747da
add Pytorch Geometric to doc
tchaton Nov 9, 2020
3f0df39
add docstring at the begining
tchaton Nov 9, 2020
291764c
add comments
tchaton Nov 9, 2020
2e75321
Merge branch 'master' into ecosystem_examples
tchaton Nov 9, 2020
366232d
Merge branch 'master' into ecosystem_examples
tchaton Nov 9, 2020
8a5623e
Merge branch 'master' into ecosystem_examples
tchaton Nov 9, 2020
83c9deb
Merge branch 'master' into ecosystem_examples
tchaton Nov 9, 2020
9e58b36
Merge branch 'master' into ecosystem_examples
tchaton Nov 9, 2020
8fd078e
Merge branch 'master' into ecosystem_examples
tchaton Nov 10, 2020
5947123
Merge branch 'master' into ecosystem_examples
tchaton Nov 10, 2020
ea06b28
Merge branch 'master' into ecosystem_examples
tchaton Nov 10, 2020
75cd4c4
Merge branch 'master' into ecosystem_examples
tchaton Nov 10, 2020
e653101
Merge branch 'master' into ecosystem_examples
tchaton Nov 11, 2020
4a0a502
Merge branch 'master' into ecosystem_examples
tchaton Nov 12, 2020
104e096
Merge branch 'master' into ecosystem_examples
tchaton Nov 12, 2020
3de0cef
Merge branch 'master' into ecosystem_examples
tchaton Nov 14, 2020
5739c3d
Update pl_examples/pytorch_ecosystem/pytorch_geometric/README.md
tchaton Nov 14, 2020
a0cded4
Update pl_examples/pytorch_ecosystem/pytorch_geometric/README.md
tchaton Nov 14, 2020
e990667
Update pl_examples/pytorch_ecosystem/pytorch_geometric/cora_dna.py
tchaton Nov 14, 2020
860367d
Merge branch 'master' into ecosystem_examples
tchaton Nov 16, 2020
e0679e7
Merge branch 'master' into ecosystem_examples
tchaton Nov 16, 2020
3ab225b
add toml
Borda Nov 16, 2020
1477eb0
Merge branch 'master' into ecosystem_examples
tchaton Nov 18, 2020
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
4 changes: 2 additions & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,14 @@ include *.md
include LICENSE

exclude *.sh
exclude *.toml
exclude *.svg
recursive-include pytorch_lightning *.py

# Include marker file for PEP 561
include pytorch_lightning/py.typed

# include examples
recursive-include pl_examples *.py *.md *.sh *.txt
recursive-include pl_examples *.py *.md *.sh *.txt *.toml

# exclude tests from package
recursive-exclude tests *
Expand All @@ -49,6 +48,7 @@ recursive-include docs/source/_images/general/ pl_overview* tf_* tutorial_* PTL1
recursive-include requirements *.txt
recursive-exclude requirements *.sh
include requirements.txt
include pyproject.toml

# Exclude build configs
exclude *.yml
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ PyTorch Lightning Documentation
:name: Examples
:caption: Examples

pytorch_ecoystem
community_examples
Autoencoder <https://pytorch-lightning-bolts.readthedocs.io/en/latest/autoencoders.html#autoencoders>
BYOL <https://pytorch-lightning-bolts.readthedocs.io/en/latest/self_supervised_models.html#byol>
Expand Down
4 changes: 4 additions & 0 deletions docs/source/pytorch_ecoystem.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Pytorch Ecosystem Examples
==========================

- `Pytorch Geometric: Deep learning on Graphs and other irregular structures <https://github.com/PyTorchLightning/pytorch-lightning/tree/master/pl_examples/pytorch_ecosystem/pytorch_geometric/README.md>`_.
38 changes: 38 additions & 0 deletions pl_examples/pytorch_ecosystem/pytorch_geometric/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# [Pytorch Geometric](https://github.com/rusty1s/pytorch_geometric) examples with Lighting

### Introduction

PyTorch Geometric (PyG) is a geometric deep learning extension library for PyTorch. It relies on lower level libraries such as

* PyTorch Cluster: A package consists of a small extension library of highly optimized graph cluster algorithms in Pytorch
* PyTorch Sparse: A package consists of a small extension library of optimized sparse matrix operations with autograd support in Pytorch
* PyTorch Scatter: A package consists of a small extension library of highly optimized sparse update (scatter and segment) operations for the use in PyTorch

## Setup

```
pyenv install 3.7.8
pyenv local 3.7.8
python -m venv
source .venv/bin/activate
poetry install
```

Run example

```
python cora_dna.py
```

## Current example lists

| `DATASET` | `MODEL` | `TASK` | DATASET DESCRIPTION | MODEL DESCRIPTION | |
tchaton marked this conversation as resolved.
Show resolved Hide resolved
| :---: | :---: | :---: | :---: | :---: | :---: |
| Cora | DNA | Node Classification | The citation network datasets "Cora", "CiteSeer" and "PubMed" from the "Revisiting Semi-Supervised Learning with Graph Embeddings" <https://arxiv.org/abs/1603.08861> | The dynamic neighborhood aggregation operator from the "Just Jump: Towards Dynamic Neighborhood Aggregation in Graph Neural Networks"


## DATASET SIZES

```
16M ./cora
```
Empty file.
Loading