Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
EdisonLeeeee committed Oct 7, 2020
1 parent 0501ea7 commit 5f628bf
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
GraphGallery is a gallery of state-of-the-arts graph neural networks for [TensorFlow 2.x](https://github.com/tensorflow/tensorflow) and [PyTorch](https://github.com/pytorch/pytorch). GraphGallery 0.4.x is a total re-write from previous versions, and some things have changed.

# 👀 What's important
Difference between GraphGallery and [pytorch geometric (PyG)](https://github.com/rusty1s/pytorch_geometric), [deep graph library (DGL)](https://github.com/dmlc/dgl), etc...
+ PyG and DGL are just like **TensorFlow**, but GraphGallery is more like **Keras**
Difference between GraphGallery and [Pytorch Geometric (PyG)](https://github.com/rusty1s/pytorch_geometric), [Deep Graph Library (DGL)](https://github.com/dmlc/dgl), etc...
+ PyG and DGL are just like **TensorFlow** while GraphGallery is more like **Keras**
+ GraphGallery is more friendly to use
+ GraphGallery is more efficiient

Expand All @@ -50,7 +50,7 @@ python setup.py install
```bash
pip install -U graphgallery
```
# :octocat: Implementations
# 🤖 Implementations
In detail, the following methods are currently implemented:

## Semi-supervised models
Expand Down Expand Up @@ -216,7 +216,7 @@ model.build()
# verbose takes 0, 1, 2, 3, 4
his = model.train(idx_train, idx_val, verbose=1, epochs=100)
# test your model
# verbose takes 0, 1
# verbose takes 0, 1, 2
loss, accuracy = model.test(idx_test, verbose=1)
print(f'Test loss {loss:.5}, Test accuracy {accuracy:.2%}')
```
Expand Down Expand Up @@ -313,7 +313,7 @@ Test loss 1.0131, Test accuracy 82.20%

```

# ❓ How to add your custom datasets
# ❓ How to add your datasets
This is motivated by [gnn-benchmark](https://github.com/shchur/gnn-benchmark/)
```python
from graphgallery.data import Graph
Expand All @@ -330,13 +330,13 @@ mydataset.to_npz('path/to/mydataset.npz')
mydataset = Graph.from_npz('path/to/mydataset.npz')
```

# ❓ How to define your custom models
# ❓ How to define your models
TODO

# 😎 More Examples
Please refer to the [examples](https://github.com/EdisonLeeeee/GraphGallery/blob/master/examples) directory.

# ⭐ TODO Lists
# ⭐ TODO List
- [x] Add PyTorch models support
- [ ] Add more GNN models (TF and Torch backend)
- [ ] Support for more tasks, e.g., `graph Classification` and `link prediction`
Expand Down

0 comments on commit 5f628bf

Please sign in to comment.