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
JuliaGraphs · Nov 9, 2024 · b063263 · b063263
1 parent 25b8872
commit b063263
Show file tree

Hide file tree

Showing 3 changed files with 949 additions and 32 deletions.
diff --git a/GNNLux/docs/make.jl b/GNNLux/docs/make.jl
@@ -21,12 +21,12 @@ makedocs(;
          format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
          sitename = "GNNLux.jl",
          pages = ["Home" => "index.md",
-         "Basic" => "api/basic.md"],
+                   "API Reference" => [
+                                    "Basic" => "api/basic.md",
+                                    "Convolutional layers" => "api/conv.md"]]
          )
 
 
-
-
 deploydocs(;repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git",
 devbranch = "master",
 push_preview = true,

diff --git a/GNNLux/docs/src/api/conv.md b/GNNLux/docs/src/api/conv.md
@@ -15,8 +15,24 @@ The table below lists all graph convolutional layers implemented in the *GNNLux.
 - *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 |
-| :--------                   |  :---:   |:---:      |:---:        |  :---:       | :---:                      |         ✓               |
+| :--------                   |  :---:   |:---:      |:---:        |  :---:       | :---:                      |
+| [`AGNNConv`](@ref)          |          |           |     ✓       |              |                    |                          
+| [`CGConv`](@ref)            |          |           |     ✓       |       ✓      |             ✓             | 
+| [`ChebConv`](@ref)          |          |           |             |              |                ✓           |
+| [`EGNNConv`](@ref)          |          |           |     ✓       |              |                           |
+| [`EdgeConv`](@ref)          |          |           |             |       ✓      |                            |  
+| [`GATConv`](@ref)           |          |           |     ✓       |       ✓      |              ✓             |
+| [`GATv2Conv`](@ref)         |          |           |     ✓       |       ✓      |             ✓              |
+| [`GatedGraphConv`](@ref)    |     ✓    |           |             |              |            ✓               |
 | [`GCNConv`](@ref)           |     ✓    |     ✓     |             |       ✓      |                            |
+| [`GINConv`](@ref)           |     ✓    |           |             |       ✓      |               ✓           |
+| [`GMMConv`](@ref)           |          |           |     ✓       |              |                            |
+| [`GraphConv`](@ref)         |     ✓    |           |             |       ✓      |              ✓             |   
+| [`MEGNetConv`](@ref)        |          |           |     ✓       |              |                            |              
+| [`NNConv`](@ref)            |          |           |     ✓       |              |                            |
+| [`ResGatedGraphConv`](@ref) |          |           |             |       ✓      |               ✓             |
+| [`SAGEConv`](@ref)          |     ✓    |           |             |       ✓      |             ✓               |
+| [`SGConv`](@ref)            |     ✓    |           |             |              |             ✓             |
 
 ## Docs