diff --git a/README.md b/README.md index c5eeb7e..e801684 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ -Basic reference pytorch implementation of GraphSAGE. -Forgive the messiness; it was coded in a rush. +# Reference PyTorch GraphSAGE Implementation +### Author: William L. Hamilton + + +Basic reference PyTorch implementation of GraphSAGE. +This reference implementation is not as fast as the TensorFlow version for large graphs, but the code is easier to read and it performs better on small-graph benchmarks. +The code is also intended to be more extensible and easier to work with the the TensorFlow version. + +Currently, only supervised versions of GraphSAGE-mean and GraphSAGE-GCN are implemented. + +#### Requirements + +pytorch >0.2 is required. + +#### Running examples Execute `python -m graphsage.model` to run the Cora example. It assumes that CUDA is not being used, but modifying the run functions in `model.py` in the obvious way can change this.