Skip to content

Commit 94c13c3

Browse files
committed
Fix
1 parent ae58c08 commit 94c13c3

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

GNNLux/docs/src/api/basic.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ CurrentModule = GNNLux
44

55
## GNNLayer
66
```@docs
7-
GNNLux.GNNLayer
7+
GNNLayer
8+
GNNChain
89
```

GNNLux/docs/src/api/conv.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
```@meta
2+
CurrentModule = GNNLux
3+
```
4+
5+
# Convolutional Layers
6+
7+
Many different types of graphs convolutional layers have been proposed in the literature. Choosing the right layer for your application could involve a lot of exploration.
8+
Multiple graph convolutional layers are typically stacked together to create a graph neural network model (see [`GNNChain`](@ref)).
9+
10+
The table below lists all graph convolutional layers implemented in the *GNNLux.jl*. It also highlights the presence of some additional capabilities with respect to basic message passing:
11+
- *Sparse Ops*: implements message passing as multiplication by sparse adjacency matrix instead of the gather/scatter mechanism. This can lead to better CPU performances but it is not supported on GPU yet.
12+
- *Edge Weight*: supports scalar weights (or equivalently scalar features) on edges.
13+
- *Edge Features*: supports feature vectors on edges.
14+
- *Heterograph*: supports heterogeneous graphs (see [`GNNHeteroGraph`](@ref)).
15+
- *TemporalSnapshotsGNNGraphs*: supports temporal graphs (see [`TemporalSnapshotsGNNGraph`](@ref)) by applying the convolution layers to each snapshot independently.
16+
17+
| Layer |Sparse Ops|Edge Weight|Edge Features| Heterograph | TemporalSnapshotsGNNGraphs |
18+
| :-------- | :---: |:---: |:---: | :---: | :---: ||
19+
| [`GCNConv`](@ref) ||| || |
20+
21+
## Docs
22+
23+
```@autodocs
24+
Modules = [GraphNeuralNetworks]
25+
Pages = ["layers/conv.jl"]
26+
Private = false
27+
```

0 commit comments

Comments
 (0)