Skip to content

Tutorial #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"esbonio.sphinx.confDir": ""
}
Binary file modified docs_using_sphinx/_build/doctrees/aboutus.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/contributorGuide.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/dev.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/dev/easygraph-doc-source.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/dev/manual-releasing.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/dev/releasing.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/egeps.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/egeps/egep-0001.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/egeps/egep-0002.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/example.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/hypergraph.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/install.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/license.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/reference.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/reference/easygraph.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/reference/easygraph.model.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/reference/easygraph.nn.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/reference/modules.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/sourcecode.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/tutorial.doctree
Binary file not shown.
Binary file modified docs_using_sphinx/_build/doctrees/videos.doctree
Binary file not shown.
517 changes: 517 additions & 0 deletions docs_using_sphinx/_build/html/_modules/easygraph/datapipe/loader.html

Large diffs are not rendered by default.

532 changes: 532 additions & 0 deletions docs_using_sphinx/_build/html/_modules/easygraph/exception.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

463 changes: 463 additions & 0 deletions docs_using_sphinx/_build/html/_modules/easygraph/ml_metrics.html

Large diffs are not rendered by default.

519 changes: 519 additions & 0 deletions docs_using_sphinx/_build/html/_modules/easygraph/utils/download.html

Large diffs are not rendered by default.

465 changes: 465 additions & 0 deletions docs_using_sphinx/_build/html/_modules/easygraph/utils/logging.html

Large diffs are not rendered by default.

184 changes: 137 additions & 47 deletions docs_using_sphinx/_build/html/_modules/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
easygraph.datasets.dynamic package
==================================

Submodules
----------

easygraph.datasets.dynamic.email\_enron module
----------------------------------------------

.. automodule:: easygraph.datasets.dynamic.email_enron
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.dynamic.email\_eu module
-------------------------------------------

.. automodule:: easygraph.datasets.dynamic.email_eu
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.dynamic.hospital\_lyon module
------------------------------------------------

.. automodule:: easygraph.datasets.dynamic.hospital_lyon
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.dynamic.load\_dataset module
-----------------------------------------------

.. automodule:: easygraph.datasets.dynamic.load_dataset
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: easygraph.datasets.dynamic
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ easygraph.datasets.hypergraph.House\_Committees module
:undoc-members:
:show-inheritance:

easygraph.datasets.hypergraph.base module
easygraph.datasets.hypergraph.Yelp module
-----------------------------------------

.. automodule:: easygraph.datasets.hypergraph.base
.. automodule:: easygraph.datasets.hypergraph.Yelp
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -28,6 +28,14 @@ easygraph.datasets.hypergraph.cat\_edge\_Cooking module
:undoc-members:
:show-inheritance:

easygraph.datasets.hypergraph.coauthorship module
-------------------------------------------------

.. automodule:: easygraph.datasets.hypergraph.coauthorship
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.hypergraph.cocitation module
-----------------------------------------------

Expand All @@ -44,10 +52,18 @@ easygraph.datasets.hypergraph.contact\_primary\_school module
:undoc-members:
:show-inheritance:

easygraph.datasets.hypergraph.load\_dataset module
--------------------------------------------------
easygraph.datasets.hypergraph.cooking\_200 module
-------------------------------------------------

.. automodule:: easygraph.datasets.hypergraph.cooking_200
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.hypergraph.hypergraph\_dataset\_base module
--------------------------------------------------------------

.. automodule:: easygraph.datasets.hypergraph.load_dataset
.. automodule:: easygraph.datasets.hypergraph.hypergraph_dataset_base
:members:
:undoc-members:
:show-inheritance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,12 @@ Subpackages
.. toctree::
:maxdepth: 4

easygraph.datasets.dynamic
easygraph.datasets.hypergraph

Submodules
----------

easygraph.datasets.base module
------------------------------

.. automodule:: easygraph.datasets.base
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.citation\_graph module
-----------------------------------------

Expand All @@ -28,38 +21,6 @@ easygraph.datasets.citation\_graph module
:undoc-members:
:show-inheritance:

easygraph.datasets.cooking\_200 module
--------------------------------------

.. automodule:: easygraph.datasets.cooking_200
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.eg\_dataset module
-------------------------------------

.. automodule:: easygraph.datasets.eg_dataset
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.email\_enron module
--------------------------------------

.. automodule:: easygraph.datasets.email_enron
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.email\_eu module
-----------------------------------

.. automodule:: easygraph.datasets.email_eu
:members:
:undoc-members:
:show-inheritance:

easygraph.datasets.get\_sample\_graph module
--------------------------------------------

Expand All @@ -76,10 +37,10 @@ easygraph.datasets.gnn\_benchmark module
:undoc-members:
:show-inheritance:

easygraph.datasets.hospital\_lyon module
----------------------------------------
easygraph.datasets.graph\_dataset\_base module
----------------------------------------------

.. automodule:: easygraph.datasets.hospital_lyon
.. automodule:: easygraph.datasets.graph_dataset_base
:members:
:undoc-members:
:show-inheritance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,30 @@ easygraph.functions.hypergraph.centrality.degree module
:undoc-members:
:show-inheritance:

easygraph.functions.hypergraph.centrality.hypercoreness module
--------------------------------------------------------------

.. automodule:: easygraph.functions.hypergraph.centrality.hypercoreness
:members:
:undoc-members:
:show-inheritance:

easygraph.functions.hypergraph.centrality.s\_centrality module
--------------------------------------------------------------

.. automodule:: easygraph.functions.hypergraph.centrality.s_centrality
:members:
:undoc-members:
:show-inheritance:

easygraph.functions.hypergraph.centrality.vector\_centrality module
-------------------------------------------------------------------

.. automodule:: easygraph.functions.hypergraph.centrality.vector_centrality
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ easygraph.functions.hypergraph.hypergraph\_clustering module
:undoc-members:
:show-inheritance:

easygraph.functions.hypergraph.hypergraph\_operation module
-----------------------------------------------------------

.. automodule:: easygraph.functions.hypergraph.hypergraph_operation
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

Expand Down
12 changes: 11 additions & 1 deletion docs_using_sphinx/_build/html/_sources/tutorial.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -291,4 +291,14 @@ The PageRank algorithm
**Usage**

- For class methods, calling and parameter passing are the same as python.
- For module function, easygraph will select specific codes to execute according to the class of the graph.
- For module function, easygraph will select specific codes to execute according to the class of the graph.

View the tutorials in Colab.
-------------------------
`tutorial1: Two brief tutorials of how to do graph analysis with EasyGraph. <https://colab.research.google.com/drive/1563MGCebT5-EVB-GDMRgCGeXIHRXiJii#scrollTo=zaKmkvGe_j53>`_

`tutorial2: Using C++ code to achieve a better performance. <https://colab.research.google.com/drive/1Ypgjl4kkG7JMLgSVXJovxVVj7fiZlKij>`_

`tutorial3: Graph Embedding. <https://colab.research.google.com/drive/1G3HXIi36d0myVRdbJUCMVA2OJOj4RgP_>`_

`tutorial4: Community Detection. <https://colab.research.google.com/drive/1n7dsZVHlLVUc_4SqK3hwaL8fbEf0sw5V>`_
3 changes: 0 additions & 3 deletions docs_using_sphinx/_build/html/_static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
Expand Down Expand Up @@ -99,7 +98,6 @@ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /*
body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */
body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */
Expand Down Expand Up @@ -185,7 +183,6 @@ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: ital
body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */
body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */
body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */
Expand Down
2 changes: 1 addition & 1 deletion docs_using_sphinx/_build/html/_static/scripts/furo.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs_using_sphinx/_build/html/_static/styles/furo.css.map

Large diffs are not rendered by default.

Loading