From 94c13c317aa008b6e67b47895799d121f44a3820 Mon Sep 17 00:00:00 2001 From: Aurora Rossi Date: Thu, 7 Nov 2024 20:22:47 +0100 Subject: [PATCH] Fix --- GNNLux/docs/src/api/basic.md | 3 ++- GNNLux/docs/src/api/conv.md | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 GNNLux/docs/src/api/conv.md diff --git a/GNNLux/docs/src/api/basic.md b/GNNLux/docs/src/api/basic.md index 2242745d6..aef66c50a 100644 --- a/GNNLux/docs/src/api/basic.md +++ b/GNNLux/docs/src/api/basic.md @@ -4,5 +4,6 @@ CurrentModule = GNNLux ## GNNLayer ```@docs -GNNLux.GNNLayer +GNNLayer +GNNChain ``` \ No newline at end of file diff --git a/GNNLux/docs/src/api/conv.md b/GNNLux/docs/src/api/conv.md new file mode 100644 index 000000000..0b839a4ea --- /dev/null +++ b/GNNLux/docs/src/api/conv.md @@ -0,0 +1,27 @@ +```@meta +CurrentModule = GNNLux +``` + +# Convolutional Layers + +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. +Multiple graph convolutional layers are typically stacked together to create a graph neural network model (see [`GNNChain`](@ref)). + +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: +- *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. +- *Edge Weight*: supports scalar weights (or equivalently scalar features) on edges. +- *Edge Features*: supports feature vectors on edges. +- *Heterograph*: supports heterogeneous graphs (see [`GNNHeteroGraph`](@ref)). +- *TemporalSnapshotsGNNGraphs*: supports temporal graphs (see [`TemporalSnapshotsGNNGraph`](@ref)) by applying the convolution layers to each snapshot independently. + +| Layer |Sparse Ops|Edge Weight|Edge Features| Heterograph | TemporalSnapshotsGNNGraphs | +| :-------- | :---: |:---: |:---: | :---: | :---: | ✓ | +| [`GCNConv`](@ref) | ✓ | ✓ | | ✓ | | + +## Docs + +```@autodocs +Modules = [GraphNeuralNetworks] +Pages = ["layers/conv.jl"] +Private = false +``` \ No newline at end of file