Skip to content

Commit 53830c1

Browse files
committed
Better intro GNN
1 parent 77dde45 commit 53830c1

File tree

1 file changed

+10
-10
lines changed
  • GraphNeuralNetworks/docs/src

1 file changed

+10
-10
lines changed

GraphNeuralNetworks/docs/src/home.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# GraphNeuralNetworks
22

3-
This is the documentation page for [GraphNeuralNetworks.jl](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl), a graph neural network library written in Julia and based on the deep learning framework [Flux.jl](https://github.com/FluxML/Flux.jl).
4-
GraphNeuralNetworks.jl is largely inspired by [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/), [Deep Graph Library](https://docs.dgl.ai/),
5-
and [GeometricFlux.jl](https://fluxml.ai/GeometricFlux.jl/stable/).
3+
GraphNeuralNetworks.jl is a graph neural network package based on the deep learning framework [Flux.jl](https://github.com/FluxML/Flux.jl).
4+
5+
It provides a set of stateful graph convolutional layers and utilities to build graph neural networks.
66

77
Among its features:
88

@@ -11,15 +11,15 @@ Among its features:
1111
* Easy to define custom layers.
1212
* CUDA support.
1313
* Integration with [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl).
14-
* [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) of node, edge, and graph level machine learning tasks.
14+
* [Examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/GraphNeuralNetworks/examples) of node, edge, and graph level machine learning tasks.
15+
* Heterogeneous and temporal graphs.
1516

1617

1718
## Package overview
1819

19-
Let's give a brief overview of the package by solving a
20-
graph regression problem with synthetic data.
20+
Let's give a brief overview of the package by solving a graph regression problem with synthetic data.
2121

22-
Usage examples on real datasets can be found in the [examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) folder.
22+
Usage examples on real datasets can be found in the [examples](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/GraphNeuralNetworks/examples) folder.
2323

2424
### Data preparation
2525

@@ -33,8 +33,8 @@ all_graphs = GNNGraph[]
3333

3434
for _ in 1:1000
3535
g = rand_graph(10, 40,
36-
ndata=(; x = randn(Float32, 16,10)), # input node features
37-
gdata=(; y = randn(Float32))) # regression target
36+
ndata=(; x = randn(Float32, 16,10)), # Input node features
37+
gdata=(; y = randn(Float32))) # Regression target
3838
push!(all_graphs, g)
3939
end
4040
```
@@ -50,7 +50,7 @@ model = GNNChain(GCNConv(16 => 64),
5050
BatchNorm(64), # Apply batch normalization on node features (nodes dimension is batch dimension)
5151
x -> relu.(x),
5252
GCNConv(64 => 64, relu),
53-
GlobalPool(mean), # aggregate node-wise features into graph-wise features
53+
GlobalPool(mean), # Aggregate node-wise features into graph-wise features
5454
Dense(64, 1)) |> device
5555

5656
opt = Flux.setup(Adam(1f-4), model)

0 commit comments

Comments
 (0)