Move NeighborLoader to GNNGraphs (#522)

JuliaGraphs · Nov 14, 2024 · ce34b64 · ce34b64
1 parent 530457c
commit ce34b64
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 9 deletions.
diff --git a/GNNGraphs/docs/make.jl b/GNNGraphs/docs/make.jl
@@ -22,6 +22,7 @@ makedocs(;
                  "GNNGraph" => "api/gnngraph.md",
                  "GNNHeteroGraph" => "api/heterograph.md",
                  "TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
+                 "Samplers" => "api/samplers.md",
               ],      
          ]
          )

diff --git a/GraphNeuralNetworks/docs/src/api/samplers.md → GNNGraphs/docs/src/api/samplers.md b/GraphNeuralNetworks/docs/src/api/samplers.md → GNNGraphs/docs/src/api/samplers.md
@@ -1,5 +1,5 @@
 ```@meta
-CurrentModule = GraphNeuralNetworks
+CurrentModule = GNNGraphs
 ```
 
 # Samplers
@@ -8,7 +8,7 @@ CurrentModule = GraphNeuralNetworks
 ## Docs
 
 ```@autodocs
-Modules = [GraphNeuralNetworks]
+Modules = [GNNGraphs]
 Pages   = ["samplers.jl"]
 Private = false
 ```
diff --git a/GNNGraphs/src/GNNGraphs.jl b/GNNGraphs/src/GNNGraphs.jl
@@ -113,4 +113,7 @@ export mldataset2gnngraph
 
 include("deprecations.jl")
 
+include("samplers.jl")
+export NeighborLoader
+
 end #module
diff --git a/GraphNeuralNetworks/src/samplers.jl → GNNGraphs/src/samplers.jl b/GraphNeuralNetworks/src/samplers.jl → GNNGraphs/src/samplers.jl
@@ -3,8 +3,7 @@
 
 A data structure for sampling neighbors from a graph for training Graph Neural Networks (GNNs). 
 It supports multi-layer sampling of neighbors for a batch of input nodes, useful for mini-batch training
-originally introduced in "Inductive Representation Learning on Large Graphs" paper.
-[see https://arxiv.org/abs/1706.02216]
+originally introduced in ["Inductive Representation Learning on Large Graphs"}(https://arxiv.org/abs/1706.02216) paper.
 
 # Fields
 - `graph::GNNGraph`: The input graph.
@@ -21,6 +20,7 @@ julia> batch_counter = 0
 julia> for mini_batch_gnn in loader
             batch_counter += 1
             println("Batch ", batch_counter, ": Nodes in mini-batch graph: ", nv(mini_batch_gnn))
+        end
 ```
 """
 struct NeighborLoader

diff --git a/GNNGraphs/test/runtests.jl b/GNNGraphs/test/runtests.jl
@@ -37,7 +37,8 @@ tests = [
     "gnnheterograph",
     "temporalsnapshotsgnngraph",
     "mldatasets",
-    "ext/SimpleWeightedGraphs"
+    "ext/SimpleWeightedGraphs",
+    "samplers"
 ]
 
 !CUDA.functional() && @warn("CUDA unavailable, not testing GPU support")

diff --git a/GraphNeuralNetworks/test/samplers.jl → GNNGraphs/test/samplers.jl b/GraphNeuralNetworks/test/samplers.jl → GNNGraphs/test/samplers.jl
diff --git a/GraphNeuralNetworks/docs/make.jl b/GraphNeuralNetworks/docs/make.jl
@@ -37,7 +37,6 @@ makedocs(;
                   "Pooling layers" => "api/pool.md",
                   "Temporal Convolutional layers" => "api/temporalconv.md",
                   "Hetero Convolutional layers" => "api/heteroconv.md",
-                  "Samplers" => "api/samplers.md",
 
 
               ],

diff --git a/GraphNeuralNetworks/src/GraphNeuralNetworks.jl b/GraphNeuralNetworks/src/GraphNeuralNetworks.jl
@@ -67,7 +67,4 @@ export GlobalPool,
 
 include("deprecations.jl")
 
-include("samplers.jl")
-export NeighborLoader
-
 end