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.

Sign up for GitHub

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

Add GNNLux docstrings #515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
696ee42
Add ChebConv docstring
aurorarossi Nov 9, 2024
08c7900
Add GraphConv docstring
aurorarossi Nov 9, 2024
61137f7
Add AGNNConv dostring
aurorarossi Nov 9, 2024
bb9cb67
Add CGConv docstring
aurorarossi Nov 9, 2024
5dc4cf6
Add EdgeConv docstring
aurorarossi Nov 9, 2024
9944798
Add EGNNConv docstring
aurorarossi Nov 9, 2024
8b30efd
Add DConv docstring
aurorarossi Nov 9, 2024
2d1a643
Add GATConv docstring
aurorarossi Nov 9, 2024
0681b54
Add GATv2Conv doscting
aurorarossi Nov 9, 2024
866d20c
Add SGConv
aurorarossi Nov 9, 2024
60985a3
Add GatedGraphConv docs
aurorarossi Nov 9, 2024
6b0bf24
Add GINConv docs
aurorarossi Nov 9, 2024
831d41b
Add GMMConv docs
aurorarossi Nov 9, 2024
9ed8049
Add MEGNetConv docs
aurorarossi Nov 9, 2024
56e5eb6
Add NNConv
aurorarossi Nov 9, 2024
b3d7462
ResGatedGraphConv docs
aurorarossi Nov 9, 2024
ffebc07
Add SAGEConv docs
aurorarossi Nov 9, 2024
94ffdee
Add Table
aurorarossi Nov 9, 2024
3296ff9
Add conv page
aurorarossi Nov 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions GNNLux/docs/make.jl
View file
Open in desktop
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
View file
Open in desktop
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