Skip to content

Commit

Permalink
Completed first draft GNNGraphs.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
aurorarossi committed Sep 19, 2024
1 parent e71795e commit f059a95
Show file tree
Hide file tree
Showing 33 changed files with 115 additions and 102 deletions.
2 changes: 1 addition & 1 deletion GNNGraphs/docs/build/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-19T11:02:41","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-19T13:45:05","documenter_version":"1.7.0"}}
44 changes: 22 additions & 22 deletions GNNGraphs/docs/build/api/gnngraph.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions GNNGraphs/docs/build/api/heterograph.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions GNNGraphs/docs/build/api/temporalgraph.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions GNNGraphs/docs/build/datasets.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions GNNGraphs/docs/build/gnngraph.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions GNNGraphs/docs/build/heterograph.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion GNNGraphs/docs/build/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · GNNGraphs.jl</title><meta name="title" content="Home · GNNGraphs.jl"/><meta property="og:title" content="Home · GNNGraphs.jl"/><meta property="twitter:title" content="Home · GNNGraphs.jl"/><meta name="description" content="Documentation for GNNGraphs.jl."/><meta property="og:description" content="Documentation for GNNGraphs.jl."/><meta property="twitter:description" content="Documentation for GNNGraphs.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">GNNGraphs.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href="index.html">Home</a></li><li><span class="tocitem">Graphs</span><ul><li><a class="tocitem" href="gnngraph.html">Working with GNNGraph</a></li><li><a class="tocitem" href="heterograph.html">Heterogeneous Graphs</a></li><li><a class="tocitem" href="temporalgraph.html">Temporal Graphs</a></li></ul></li><li><a class="tocitem" href="datasets.html">Datasets</a></li><li><span class="tocitem">API Reference</span><ul><li><a class="tocitem" href="api/gnngraph.html">GNNGraph</a></li><li><a class="tocitem" href="api/heterograph.html">Heterogeneous Graphs</a></li><li><a class="tocitem" href="api/temporalgraph.html">Temporal Graphs</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="index.html">Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/aurorarossi/GraphNeuralNetworks.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/aurorarossi/GraphNeuralNetworks.jl/blob/master/GNNGraphs/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Write-introduction-GNNGraphs"><a class="docs-heading-anchor" href="#Write-introduction-GNNGraphs">Write introduction GNNGraphs</a><a id="Write-introduction-GNNGraphs-1"></a><a class="docs-heading-anchor-permalink" href="#Write-introduction-GNNGraphs" title="Permalink"></a></h1></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="gnngraph.html">Working with GNNGraph »</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><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><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="Thursday 19 September 2024 11:02">Thursday 19 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · GNNGraphs.jl</title><meta name="title" content="Home · GNNGraphs.jl"/><meta property="og:title" content="Home · GNNGraphs.jl"/><meta property="twitter:title" content="Home · GNNGraphs.jl"/><meta name="description" content="Documentation for GNNGraphs.jl."/><meta property="og:description" content="Documentation for GNNGraphs.jl."/><meta property="twitter:description" content="Documentation for GNNGraphs.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">GNNGraphs.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href="index.html">Home</a></li><li><span class="tocitem">Graphs</span><ul><li><a class="tocitem" href="gnngraph.html">Static Graphs</a></li><li><a class="tocitem" href="heterograph.html">Heterogeneous Graphs</a></li><li><a class="tocitem" href="temporalgraph.html">Temporal Graphs</a></li></ul></li><li><a class="tocitem" href="datasets.html">Datasets</a></li><li><span class="tocitem">API Reference</span><ul><li><a class="tocitem" href="api/gnngraph.html">GNNGraph</a></li><li><a class="tocitem" href="api/heterograph.html">Heterogeneous Graphs</a></li><li><a class="tocitem" href="api/temporalgraph.html">Temporal Graphs</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="index.html">Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/aurorarossi/GraphNeuralNetworks.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/aurorarossi/GraphNeuralNetworks.jl/blob/master/GNNGraphs/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="GNNGraphs.jl"><a class="docs-heading-anchor" href="#GNNGraphs.jl">GNNGraphs.jl</a><a id="GNNGraphs.jl-1"></a><a class="docs-heading-anchor-permalink" href="#GNNGraphs.jl" title="Permalink"></a></h1><p>GNNGraphs.jl is a package that provides graph data structures and helper functions specifically designed for working with graph neural networks. This package allows to store not only the graph structure, but also features associated with nodes, edges, and the graph itself. It is the core foundation for the GNNlib, GraphNeuralNetworks, and GNNLux packages.</p><p>It supports three types of graphs: </p><ul><li><p><strong>Static graph</strong> is the basic graph type represented by <a href="api/gnngraph.html#GNNGraph"><code>GNNGraph</code></a>, where each node and edge can have associated features. This type of graph is used in typical graph neural network applications, where neural networks operate on both the structure of the graph and the features stored in it. It can be used to represent a graph where the structure does not change over time, but the features of the nodes and edges can change over time.</p></li><li><p><strong>Temporal graph</strong> is a graph that changes over time, and is represented by <a href="api/temporalgraph.html#TemporalSnapshotsGNNGraph"><code>TemporalSnapshotsGNNGraph</code></a>. Edges and features can change dynamically. This type of graph is useful for applications that involve tracking time-dependent relationships, such as social networks.</p></li><li><p><strong>Heterogeneous graph</strong> is a graph that supports multiple types of nodes and edges, and is represented by <a href="api/heterograph.html#GNNHeteroGraph"><code>GNNHeteroGraph</code></a>. Each type can have its own properties and relationships. This is useful in scenarios with different entities and interactions, such as in citation graphs or multi-relational data.</p></li></ul><p>This package depends on the package <a href="https://github.com/JuliaGraphs/Graphs.jl">Graphs.jl</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="gnngraph.html">Static Graphs »</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><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><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="Thursday 19 September 2024 13:45">Thursday 19 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Binary file modified GNNGraphs/docs/build/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion GNNGraphs/docs/build/search_index.js

Large diffs are not rendered by default.

Loading

0 comments on commit f059a95

Please sign in to comment.