Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
CarloLucibello committed Dec 8, 2024
1 parent 5ab85c5 commit 487c6e9
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 19 deletions.
3 changes: 2 additions & 1 deletion GNNGraphs/docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ makedocs(;
"GNNHeteroGraph" => "api/heterograph.md",
"TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
"Samplers" => "api/samplers.md",
],
"Datasets" => "api/datasets.md",
],
]
)

Expand Down
10 changes: 10 additions & 0 deletions GNNGraphs/docs/src/api/datasets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```@meta
CurrentModule = GNNGraphs
CollapsedDocStrings = true
```

# Datasets

```@docs
mldataset2gnngraph
```
20 changes: 10 additions & 10 deletions GNNGraphs/docs/src/api/gnngraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,42 +21,42 @@ Base.copy

## DataStore

```@autodocs
```@autodocs; canonical = true
Modules = [GNNGraphs]
Pages = ["datastore.jl"]
Private = false
```

## Query

```@autodocs
```@autodocs; canonical = true
Modules = [GNNGraphs]
Pages = ["src/query.jl"]
Private = false
```

```@docs
```@docs; canonical = true
Graphs.neighbors(::GNNGraph, ::Integer)
```

## Transform

```@autodocs
```@autodocs; canonical = true
Modules = [GNNGraphs]
Pages = ["src/transform.jl"]
Private = false
```

## Utils

```@docs
```@docs; canonical = true
GNNGraphs.sort_edge_index
GNNGraphs.color_refinement
```

## Generate

```@autodocs
```@autodocs; canonical = true
Modules = [GNNGraphs]
Pages = ["src/generate.jl"]
Private = false
Expand All @@ -65,24 +65,24 @@ Filter = t -> typeof(t) <: Function && t!=rand_temporal_radius_graph && t!=rand_

## Operators

```@autodocs
```@autodocs; canonical = true
Modules = [GNNGraphs]
Pages = ["src/operators.jl"]
Private = false
```

```@docs
```@docs; canonical = true
Base.intersect
```

## Sampling

```@autodocs
```@autodocs; canonical = true
Modules = [GNNGraphs]
Pages = ["src/sampling.jl"]
Private = false
```

```@docs
```@docs; canonical = true
Graphs.induced_subgraph(::GNNGraph, ::Vector{Int})
```
3 changes: 0 additions & 3 deletions GNNGraphs/docs/src/guides/datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,3 @@ For graphs with static structures and temporal features, datasets such as METRLA

GraphNeuralNetworks.jl provides the [`mldataset2gnngraph`](@ref) method for interfacing with MLDatasets.jl.

```@docs
mldataset2gnngraph
```
1 change: 1 addition & 0 deletions GNNLux/docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ makedocs(;
"GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
"TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
"Samplers" => "GNNGraphs/api/samplers.md",
"Datasets" => "GNNGraphs/api/datasets.md",
]

"Message Passing (GNNlib.jl)" => [
Expand Down
18 changes: 15 additions & 3 deletions GNNlib/docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Pkg.instantiate()
using Documenter
using GNNlib
using GNNGraphs
import Graphs
using DocumenterInterLinks

assets=[]
Expand All @@ -17,24 +18,35 @@ interlinks = InterLinks(
"NNlib" => "https://fluxml.ai/NNlib.jl/stable/",
)

# Copy the docs from GNNGraphs. Will be removed at the end of the script
cp(joinpath(@__DIR__, "../../GNNGraphs/docs/src/"),
joinpath(@__DIR__, "src/GNNGraphs/"), force=true)

makedocs(;
modules = [GNNlib],
doctest = false,
clean = true,
modules = [GNNlib, GNNGraphs],
doctest = false, # TODO enable doctest
plugins = [interlinks],
format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
sitename = "GNNlib.jl",
pages = [
"Home" => "index.md",
"Message Passing" => "guides/messagepassing.md",
"API Reference" => [
"Graphs (GNNGraphs.jl)" => [
"GNNGraph" => "GNNGraphs/api/gnngraph.md",
"GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
"TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
"Samplers" => "GNNGraphs/api/samplers.md",
"Datasets" => "GNNGraphs/api/datasets.md",
],
"Message Passing" => "api/messagepassing.md",
"Utils" => "api/utils.md",
]
]
)

rm(joinpath(@__DIR__, "src/GNNGraphs"), force=true, recursive=true)

deploydocs(
repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl",
target = "build",
Expand Down
4 changes: 2 additions & 2 deletions GNNlib/src/msgpass.jl
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ providing as input `f` a closure.
- `g`: A `GNNGraph`.
- `xi`: An array or a named tuple containing arrays whose last dimension's size
is `g.num_nodes`. It will be appropriately materialized on the
target node of each edge (see also [`edge_index`](@ref)).
target node of each edge (see also [`edge_index`](@ref GNNGraphs.edge_index)).
- `xj`: As `xj`, but to be materialized on edges' sources.
- `e`: An array or a named tuple containing arrays whose last dimension's size is `g.num_edges`.
- `fmsg`: A generic function that will be passed over to [`apply_edges`](@ref).
Expand Down Expand Up @@ -100,7 +100,7 @@ such tensors.
- `g`: An `AbstractGNNGraph`.
- `xi`: An array or a named tuple containing arrays whose last dimension's size
is `g.num_nodes`. It will be appropriately materialized on the
target node of each edge (see also [`edge_index`](@ref)).
target node of each edge (see also [`edge_index`](@ref GNNGraphs.edge_index)).
- `xj`: As `xi`, but now to be materialized on each edge's source node.
- `e`: An array or a named tuple containing arrays whose last dimension's size is `g.num_edges`.
- `fmsg`: A function that takes as inputs the edge-materialized `xi`, `xj`, and `e`.
Expand Down
1 change: 1 addition & 0 deletions GraphNeuralNetworks/docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ makedocs(;
"GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
"TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
"Samplers" => "GNNGraphs/api/samplers.md",
"Datasets" => "GNNGraphs/api/datasets.md",
]

"Message Passing (GNNlib.jl)" => [
Expand Down

0 comments on commit 487c6e9

Please sign in to comment.