Aggregate documentation

Author: github-actions

gnngraphs/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-12-05T16:10:06","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-12-05T16:42:57","documenter_version":"1.8.0"}}

gnngraphs/api/gnngraph/index.html

@@ -5,4 +5,4 @@
 julia> for mini_batch_gnn in loader
             batch_counter += 1
             println("Batch ", batch_counter, ": Nodes in mini-batch graph: ", nv(mini_batch_gnn))
-        end</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/e260ff93a1659c5e231ee8a6d6bf80b432801047/GNNGraphs/src/samplers.jl#L1-L27" target="_blank">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../temporalgraph/">« TemporalSnapshotsGNNGraph</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label></p><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div><p></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 16:10">Thursday 5 December 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div><div data-docstringscollapsed="true"></div></body></HTML>
+        end</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/c6a489f3ad84350ae55a66824da855826c512487/GNNGraphs/src/samplers.jl#L1-L27" target="_blank">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../temporalgraph/">« TemporalSnapshotsGNNGraph</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label></p><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div><p></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 16:42">Thursday 5 December 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div><div data-docstringscollapsed="true"></div></body></HTML>

gnngraphs/api/heterograph/index.html

@@ -16,7 +16,7 @@
   num_edges: [20, 20, 20, 20, 20]
   num_snapshots: 5
   tgdata:
-        x = 4-element Vector{Float64}</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/e260ff93a1659c5e231ee8a6d6bf80b432801047/GNNGraphs/src/temporalsnapshotsgnngraph.jl#L1-L37" target="_blank">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.add_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64, GNNGraph}" id="GNNGraphs.add_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64, GNNGraph}"><code>GNNGraphs.add_snapshot</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add_snapshot(tg::TemporalSnapshotsGNNGraph, t::Int, g::GNNGraph)</code></pre><p>Return a <code>TemporalSnapshotsGNNGraph</code> created starting from <code>tg</code> by adding the snapshot <code>g</code> at time index <code>t</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using GNNGraphs
+        x = 4-element Vector{Float64}</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/c6a489f3ad84350ae55a66824da855826c512487/GNNGraphs/src/temporalsnapshotsgnngraph.jl#L1-L37" target="_blank">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.add_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64, GNNGraph}" id="GNNGraphs.add_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64, GNNGraph}"><code>GNNGraphs.add_snapshot</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">add_snapshot(tg::TemporalSnapshotsGNNGraph, t::Int, g::GNNGraph)</code></pre><p>Return a <code>TemporalSnapshotsGNNGraph</code> created starting from <code>tg</code> by adding the snapshot <code>g</code> at time index <code>t</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using GNNGraphs
 
 julia&gt; snapshots = [rand_graph(10, 20) for i in 1:5];
 
@@ -30,7 +30,7 @@
 TemporalSnapshotsGNNGraph:
   num_nodes: [10, 10, 10, 10, 10, 10]
   num_edges: [20, 20, 16, 20, 20, 20]
-  num_snapshots: 6</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/e260ff93a1659c5e231ee8a6d6bf80b432801047/GNNGraphs/src/temporalsnapshotsgnngraph.jl#L73-L97" target="_blank">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.remove_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64}" id="GNNGraphs.remove_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64}"><code>GNNGraphs.remove_snapshot</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">remove_snapshot(tg::TemporalSnapshotsGNNGraph, t::Int)</code></pre><p>Return a <a href="#TemporalSnapshotsGNNGraph"><code>TemporalSnapshotsGNNGraph</code></a> created starting from <code>tg</code> by removing the snapshot at time index <code>t</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using GNNGraphs
+  num_snapshots: 6</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/c6a489f3ad84350ae55a66824da855826c512487/GNNGraphs/src/temporalsnapshotsgnngraph.jl#L73-L97" target="_blank">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.remove_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64}" id="GNNGraphs.remove_snapshot-Tuple{TemporalSnapshotsGNNGraph, Int64}"><code>GNNGraphs.remove_snapshot</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">remove_snapshot(tg::TemporalSnapshotsGNNGraph, t::Int)</code></pre><p>Return a <a href="#TemporalSnapshotsGNNGraph"><code>TemporalSnapshotsGNNGraph</code></a> created starting from <code>tg</code> by removing the snapshot at time index <code>t</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using GNNGraphs
 
 julia&gt; snapshots = [rand_graph(10,20), rand_graph(10,14), rand_graph(10,22)];
 
@@ -44,7 +44,7 @@
 TemporalSnapshotsGNNGraph:
   num_nodes: [10, 10]
   num_edges: [20, 22]
-  num_snapshots: 2</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/e260ff93a1659c5e231ee8a6d6bf80b432801047/GNNGraphs/src/temporalsnapshotsgnngraph.jl#L133-L157" target="_blank">source</a></section></article><h2 id="Random-Generators"><a class="docs-heading-anchor" href="#Random-Generators">Random Generators</a><a id="Random-Generators-1"></a><a class="docs-heading-anchor-permalink" href="#Random-Generators" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.rand_temporal_radius_graph" id="GNNGraphs.rand_temporal_radius_graph"><code>GNNGraphs.rand_temporal_radius_graph</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">rand_temporal_radius_graph(number_nodes::Int, 
+  num_snapshots: 2</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/c6a489f3ad84350ae55a66824da855826c512487/GNNGraphs/src/temporalsnapshotsgnngraph.jl#L133-L157" target="_blank">source</a></section></article><h2 id="Random-Generators"><a class="docs-heading-anchor" href="#Random-Generators">Random Generators</a><a id="Random-Generators-1"></a><a class="docs-heading-anchor-permalink" href="#Random-Generators" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.rand_temporal_radius_graph" id="GNNGraphs.rand_temporal_radius_graph"><code>GNNGraphs.rand_temporal_radius_graph</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">rand_temporal_radius_graph(number_nodes::Int, 
                            number_snapshots::Int,
                            speed::AbstractFloat,
                            r::AbstractFloat;
@@ -56,7 +56,7 @@
 TemporalSnapshotsGNNGraph:
   num_nodes: [10, 10, 10, 10, 10]
   num_edges: [90, 90, 90, 90, 90]
-  num_snapshots: 5</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/e260ff93a1659c5e231ee8a6d6bf80b432801047/GNNGraphs/src/generate.jl#L224-L264" target="_blank">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.rand_temporal_hyperbolic_graph" id="GNNGraphs.rand_temporal_hyperbolic_graph"><code>GNNGraphs.rand_temporal_hyperbolic_graph</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">rand_temporal_hyperbolic_graph(number_nodes::Int, 
+  num_snapshots: 5</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/c6a489f3ad84350ae55a66824da855826c512487/GNNGraphs/src/generate.jl#L224-L264" target="_blank">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" href="#GNNGraphs.rand_temporal_hyperbolic_graph" id="GNNGraphs.rand_temporal_hyperbolic_graph"><code>GNNGraphs.rand_temporal_hyperbolic_graph</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">rand_temporal_hyperbolic_graph(number_nodes::Int, 
                                number_snapshots::Int;
                                α::Real,
                                R::Real,
@@ -69,4 +69,4 @@
 TemporalSnapshotsGNNGraph:
   num_nodes: [10, 10, 10, 10, 10]
   num_edges: [44, 46, 48, 42, 38]
-  num_snapshots: 5</code></pre><p><strong>References</strong></p><p>Section D of the paper <a href="https://arxiv.org/pdf/2101.00414.pdf">Dynamic Hidden-Variable Network Models</a> and the paper  <a href="https://arxiv.org/pdf/1006.5169.pdf">Hyperbolic Geometry of Complex Networks</a></p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/e260ff93a1659c5e231ee8a6d6bf80b432801047/GNNGraphs/src/generate.jl#L299-L339" target="_blank">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heterograph/">« GNNHeteroGraph</a><a class="docs-footer-nextpage" href="../samplers/">Samplers »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label></p><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div><p></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 16:10">Thursday 5 December 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div><div data-docstringscollapsed="true"></div></body></HTML>
+  num_snapshots: 5</code></pre><p><strong>References</strong></p><p>Section D of the paper <a href="https://arxiv.org/pdf/2101.00414.pdf">Dynamic Hidden-Variable Network Models</a> and the paper  <a href="https://arxiv.org/pdf/1006.5169.pdf">Hyperbolic Geometry of Complex Networks</a></p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/c6a489f3ad84350ae55a66824da855826c512487/GNNGraphs/src/generate.jl#L299-L339" target="_blank">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heterograph/">« GNNHeteroGraph</a><a class="docs-footer-nextpage" href="../samplers/">Samplers »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label></p><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div><p></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 16:42">Thursday 5 December 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div><div data-docstringscollapsed="true"></div></body></HTML>