Skip to content

Commit

Permalink
Aggregate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Nov 9, 2024
1 parent cb5258b commit d4bdf32
Show file tree
Hide file tree
Showing 40 changed files with 465 additions and 96 deletions.
2 changes: 1 addition & 1 deletion gnngraphs/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-11-08T08:44:16","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-11-09T14:46:50","documenter_version":"1.7.0"}}
46 changes: 23 additions & 23 deletions gnngraphs/api/gnngraph/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions gnngraphs/api/heterograph/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
julia> hg.ndata[:A].x
2×10 Matrix{Float64}:
0.825882 0.0797502 0.245813 0.142281 0.231253 0.685025 0.821457 0.888838 0.571347 0.53165
0.631286 0.316292 0.705325 0.239211 0.533007 0.249233 0.473736 0.595475 0.0623298 0.159307</code></pre><p>See also <a href="../gnngraph/#GNNGraph"><code>GNNGraph</code></a> for a homogeneous graph type and <a href="../gnngraph/#GNNGraphs.rand_heterograph"><code>rand_heterograph</code></a> for a function to generate random heterographs.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/25b887232500fc1ff638c353b3971528d293e68b/GNNGraphs/src/gnnheterograph.jl#L7-L84" 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.edge_type_subgraph-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}}" id="GNNGraphs.edge_type_subgraph-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}}"><code>GNNGraphs.edge_type_subgraph</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">edge_type_subgraph(g::GNNHeteroGraph, edge_ts)</code></pre><p>Return a subgraph of <code>g</code> that contains only the edges of type <code>edge_ts</code>. Edge types can be specified as a single edge type (i.e. a tuple containing 3 symbols) or a vector of edge types.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/25b887232500fc1ff638c353b3971528d293e68b/GNNGraphs/src/gnnheterograph.jl#L246-L251" 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.num_edge_types-Tuple{GNNGraph}" id="GNNGraphs.num_edge_types-Tuple{GNNGraph}"><code>GNNGraphs.num_edge_types</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">num_edge_types(g)</code></pre><p>Return the number of edge types in the graph. For <a href="../gnngraph/#GNNGraph"><code>GNNGraph</code></a>s, this is always 1. For <a href="#GNNHeteroGraph"><code>GNNHeteroGraph</code></a>s, this is the number of unique edge types.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/25b887232500fc1ff638c353b3971528d293e68b/GNNGraphs/src/gnnheterograph.jl#L226-L231" 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.num_node_types-Tuple{GNNGraph}" id="GNNGraphs.num_node_types-Tuple{GNNGraph}"><code>GNNGraphs.num_node_types</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">num_node_types(g)</code></pre><p>Return the number of node types in the graph. For <a href="../gnngraph/#GNNGraph"><code>GNNGraph</code></a>s, this is always 1. For <a href="#GNNHeteroGraph"><code>GNNHeteroGraph</code></a>s, this is the number of unique node types.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/25b887232500fc1ff638c353b3971528d293e68b/GNNGraphs/src/gnnheterograph.jl#L236-L241" 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="#Graphs.has_edge-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}, Integer, Integer}" id="Graphs.has_edge-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}, Integer, Integer}"><code>Graphs.has_edge</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">has_edge(g::GNNHeteroGraph, edge_t, i, j)</code></pre><p>Return <code>true</code> if there is an edge of type <code>edge_t</code> from node <code>i</code> to node <code>j</code> in <code>g</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; g = rand_bipartite_heterograph((2, 2), (4, 0), bidirected=false)
0.631286 0.316292 0.705325 0.239211 0.533007 0.249233 0.473736 0.595475 0.0623298 0.159307</code></pre><p>See also <a href="../gnngraph/#GNNGraph"><code>GNNGraph</code></a> for a homogeneous graph type and <a href="../gnngraph/#GNNGraphs.rand_heterograph"><code>rand_heterograph</code></a> for a function to generate random heterographs.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/b0632631f0d99b85296184e9c12e9c93ced608dc/GNNGraphs/src/gnnheterograph.jl#L7-L84" 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.edge_type_subgraph-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}}" id="GNNGraphs.edge_type_subgraph-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}}"><code>GNNGraphs.edge_type_subgraph</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">edge_type_subgraph(g::GNNHeteroGraph, edge_ts)</code></pre><p>Return a subgraph of <code>g</code> that contains only the edges of type <code>edge_ts</code>. Edge types can be specified as a single edge type (i.e. a tuple containing 3 symbols) or a vector of edge types.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/b0632631f0d99b85296184e9c12e9c93ced608dc/GNNGraphs/src/gnnheterograph.jl#L246-L251" 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.num_edge_types-Tuple{GNNGraph}" id="GNNGraphs.num_edge_types-Tuple{GNNGraph}"><code>GNNGraphs.num_edge_types</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">num_edge_types(g)</code></pre><p>Return the number of edge types in the graph. For <a href="../gnngraph/#GNNGraph"><code>GNNGraph</code></a>s, this is always 1. For <a href="#GNNHeteroGraph"><code>GNNHeteroGraph</code></a>s, this is the number of unique edge types.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/b0632631f0d99b85296184e9c12e9c93ced608dc/GNNGraphs/src/gnnheterograph.jl#L226-L231" 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.num_node_types-Tuple{GNNGraph}" id="GNNGraphs.num_node_types-Tuple{GNNGraph}"><code>GNNGraphs.num_node_types</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">num_node_types(g)</code></pre><p>Return the number of node types in the graph. For <a href="../gnngraph/#GNNGraph"><code>GNNGraph</code></a>s, this is always 1. For <a href="#GNNHeteroGraph"><code>GNNHeteroGraph</code></a>s, this is the number of unique node types.</p></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/b0632631f0d99b85296184e9c12e9c93ced608dc/GNNGraphs/src/gnnheterograph.jl#L236-L241" 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="#Graphs.has_edge-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}, Integer, Integer}" id="Graphs.has_edge-Tuple{GNNHeteroGraph, Tuple{Symbol, Symbol, Symbol}, Integer, Integer}"><code>Graphs.has_edge</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">has_edge(g::GNNHeteroGraph, edge_t, i, j)</code></pre><p>Return <code>true</code> if there is an edge of type <code>edge_t</code> from node <code>i</code> to node <code>j</code> in <code>g</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; g = rand_bipartite_heterograph((2, 2), (4, 0), bidirected=false)
GNNHeteroGraph:
num_nodes: (:A =&gt; 2, :B =&gt; 2)
num_edges: ((:A, :to, :B) =&gt; 4, (:B, :to, :A) =&gt; 0)
Expand All @@ -48,4 +48,4 @@
true

julia&gt; has_edge(g, (:B,:to,:A), 1, 1)
false</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/25b887232500fc1ff638c353b3971528d293e68b/GNNGraphs/src/query.jl#L58-L77" target="_blank">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../gnngraph/">« GNNGraph</a><a class="docs-footer-nextpage" 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.7.0 on <span class="colophon-date" title="Friday 8 November 2024 08:44">Friday 8 November 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></HTML>
false</code></pre></div><a class="docs-sourcelink" href="https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/blob/b0632631f0d99b85296184e9c12e9c93ced608dc/GNNGraphs/src/query.jl#L58-L77" target="_blank">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../gnngraph/">« GNNGraph</a><a class="docs-footer-nextpage" 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.7.0 on <span class="colophon-date" title="Saturday 9 November 2024 14:46">Saturday 9 November 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></HTML>
Loading

0 comments on commit d4bdf32

Please sign in to comment.