Skip to content

Commit b063263

Browse files
authored
Add GNNLux docstrings (#515)
* Add ChebConv docstring * Add GraphConv docstring * Add AGNNConv dostring * Add CGConv docstring * Add EdgeConv docstring * Add EGNNConv docstring * Add DConv docstring * Add GATConv docstring * Add GATv2Conv doscting * Add SGConv * Add GatedGraphConv docs * Add GINConv docs * Add GMMConv docs * Add MEGNetConv docs * Add NNConv * ResGatedGraphConv docs * Add SAGEConv docs * Add Table * Add conv page
1 parent 25b8872 commit b063263

File tree

3 files changed

+949
-32
lines changed

3 files changed

+949
-32
lines changed

GNNLux/docs/make.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ makedocs(;
2121
format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
2222
sitename = "GNNLux.jl",
2323
pages = ["Home" => "index.md",
24-
"Basic" => "api/basic.md"],
24+
"API Reference" => [
25+
"Basic" => "api/basic.md",
26+
"Convolutional layers" => "api/conv.md"]]
2527
)
2628

2729

28-
29-
3030
deploydocs(;repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git",
3131
devbranch = "master",
3232
push_preview = true,

GNNLux/docs/src/api/conv.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,24 @@ The table below lists all graph convolutional layers implemented in the *GNNLux.
1515
- *TemporalSnapshotsGNNGraphs*: supports temporal graphs (see [`TemporalSnapshotsGNNGraph`](@ref)) by applying the convolution layers to each snapshot independently.
1616

1717
| Layer |Sparse Ops|Edge Weight|Edge Features| Heterograph | TemporalSnapshotsGNNGraphs |
18-
| :-------- | :---: |:---: |:---: | :---: | :---: ||
18+
| :-------- | :---: |:---: |:---: | :---: | :---: |
19+
| [`AGNNConv`](@ref) | | || | |
20+
| [`CGConv`](@ref) | | ||||
21+
| [`ChebConv`](@ref) | | | | ||
22+
| [`EGNNConv`](@ref) | | || | |
23+
| [`EdgeConv`](@ref) | | | || |
24+
| [`GATConv`](@ref) | | ||||
25+
| [`GATv2Conv`](@ref) | | ||||
26+
| [`GatedGraphConv`](@ref) || | | ||
1927
| [`GCNConv`](@ref) ||| || |
28+
| [`GINConv`](@ref) || | |||
29+
| [`GMMConv`](@ref) | | || | |
30+
| [`GraphConv`](@ref) || | |||
31+
| [`MEGNetConv`](@ref) | | || | |
32+
| [`NNConv`](@ref) | | || | |
33+
| [`ResGatedGraphConv`](@ref) | | | |||
34+
| [`SAGEConv`](@ref) || | |||
35+
| [`SGConv`](@ref) || | | ||
2036

2137
## Docs
2238

0 commit comments

Comments
 (0)