Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GNNLux docstrings #515

Merged
merged 19 commits into from
Nov 9, 2024
Merged
6 changes: 3 additions & 3 deletions GNNLux/docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
18 changes: 17 additions & 1 deletion GNNLux/docs/src/api/conv.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading
Loading