[Doc] Add readme to mxnet gat (dmlc#300)

* readme * Update and rename README to README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
ihaeyong · Dec 17, 2018 · 632d598 · 632d598
1 parent f8811c7
commit 632d598
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/examples/mxnet/README.md b/examples/mxnet/README.md
@@ -1,5 +1,14 @@
 # Model Examples using DGL (w/ MXNet backend)
 
+use `DGLBACKEND=mxnet` to use MXNet as DGL's backend
+
+## Examples:
+
+```
+DGLBACKEND=mxnet python gcn_batch.py --dataset cora
+DGLBACKEND=mxnet python gat_batch.py --dataset cora
+```
+
 Each model is hosted in their own folders. Please read their README.md to see how to
 run them.
 

diff --git a/examples/mxnet/gat/README.md b/examples/mxnet/gat/README.md
@@ -0,0 +1,14 @@
+Graph Attention Networks (GAT)
+============
+
+- Paper link: [https://arxiv.org/abs/1710.10903](https://arxiv.org/abs/1710.10903)
+- Author's code repo:
+  [https://github.com/PetarV-/GAT](https://github.com/PetarV-/GAT).
+
+Note that the original code is implemented with Tensorflow for the paper.
+
+
+## Usage (make sure that DGLBACKEND is changed into mxnet)
+```bash
+DGLBACKEND=mxnet python gat_batch.py --dataset cora --gpu 0 --num-heads 8
+```