add eggpu doc

Author: jessicawwen

.gitignore

@@ -83,3 +83,5 @@ $RECYCLE.BIN/
 */.env
 .idea/
 
+docs/env/
+docs/_sources/env/

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 495056e95c5d3b016219afa0130528f0
+config: b628fa54c01d8e3cbd1efeb674b18d12
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/eggpu.rst.txt

@@ -0,0 +1,36 @@
+EGGPU
+========
+
+Overview
++++++++++++++
+
+EGGPU is a GPU-accelerated network analysis library that supports essential functions such as betweenness centrality, k-core centrality, and single-source shortest path. Built on top of the **EasyGraph** library, EGGPU delivers a user-friendly Python API while achieving remarkable speedups for large-scale network analysis.
+
+EGGPU is engineered with a three-layer architecture:
+- User Interface Layer: Developed in Python, this layer offers intuitive and easy-to-use APIs for end users.
+- Middleware Layer: Constructed in C++, this layer shares memory space with the Computation Layer and serves as the binding agent. It also provides a graph container responsible for graph loading, storage, and format conversion.
+- Computation Layer: Implemented in CUDA C/C++, this layer primarily executes the GPU-based network analysis functions, including betweenness centrality, k-core centrality, and SSSP.
+.. image:: eggpu_architecture.png
+
+Installation
++++++++++++++
+
+On Linux
+--------
+
+.. code-block:: bash
+
+   git clone --recursive https://github.com/easy-graph/Easy-Graph
+   export EASYGRAPH_ENABLE_GPU="TRUE"
+   pip install ./Easy-Graph
+
+On Windows
+----------
+
+.. code-block:: none
+
+   % For Windows users who want to enable GPU-based functions,
+   % you must execute the commands below in cmd but not PowerShell.
+   git clone --recursive https://github.com/easy-graph/Easy-Graph
+   set EASYGRAPH_ENABLE_GPU=TRUE
+   pip install ./Easy-Graph

docs/_sources/reference/easygraph.model.hypergraphs.rst.txt

@@ -44,6 +44,14 @@ easygraph.model.hypergraphs.hnhn module
    :undoc-members:
    :show-inheritance:
 
+easygraph.model.hypergraphs.hwnn module
+---------------------------------------
+
+.. automodule:: easygraph.model.hypergraphs.hwnn
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 easygraph.model.hypergraphs.hypergcn module
 -------------------------------------------
 

docs/_sources/reference/easygraph.nn.convs.hypergraphs.rst.txt

@@ -44,6 +44,14 @@ easygraph.nn.convs.hypergraphs.hnhn\_conv module
    :undoc-members:
    :show-inheritance:
 
+easygraph.nn.convs.hypergraphs.hwnn\_conv module
+------------------------------------------------
+
+.. automodule:: easygraph.nn.convs.hypergraphs.hwnn_conv
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 easygraph.nn.convs.hypergraphs.hypergcn\_conv module
 ----------------------------------------------------
 

docs/_sources/reference/easygraph.rst.txt

@@ -5,7 +5,7 @@ Subpackages
 -----------
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 4
 
    easygraph.classes
    easygraph.datapipe
@@ -18,7 +18,6 @@ Subpackages
    easygraph.readwrite
    easygraph.utils
 
-
 Submodules
 ----------
 
@@ -38,3 +37,10 @@ easygraph.exception module
    :undoc-members:
    :show-inheritance:
 
+Module contents
+---------------
+
+.. automodule:: easygraph
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/_sources/reference/modules.rst.txt

@@ -2,6 +2,6 @@ easygraph
 =========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
 
    easygraph

docs/_static/_sphinx_javascript_frameworks_compat.js

@@ -1,9 +1,20 @@
-/* Compatability shim for jQuery and underscores.js.
+/*
+ * _sphinx_javascript_frameworks_compat.js
+ * ~~~~~~~~~~
+ *
+ * Compatability shim for jQuery and underscores.js.
+ *
+ * WILL BE REMOVED IN Sphinx 6.0
+ * xref RemovedInSphinx60Warning
  *
- * Copyright Sphinx contributors
- * Released under the two clause BSD licence
  */
 
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+
 /**
  * small helper function to urldecode strings
  *

docs/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -236,6 +236,16 @@ div.body p, div.body dd, div.body li, div.body blockquote {
 a.headerlink {
     visibility: hidden;
 }
+a.brackets:before,
+span.brackets > a:before{
+    content: "[";
+}
+
+a.brackets:after,
+span.brackets > a:after {
+    content: "]";
+}
+
 
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
@@ -324,17 +334,11 @@ aside.sidebar {
 p.sidebar-title {
     font-weight: bold;
 }
-
-nav.contents,
-aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
-
-nav.contents,
-aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -373,17 +377,13 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
-nav.contents > :last-child,
-aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
-nav.contents::after,
-aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -608,27 +608,19 @@ ol.simple p,
 ul.simple p {
     margin-bottom: 0;
 }
-
-aside.footnote > span,
-div.citation > span {
+dl.footnote > dt,
+dl.citation > dt {
     float: left;
+    margin-right: 0.5em;
 }
-aside.footnote > span:last-of-type,
-div.citation > span:last-of-type {
-  padding-right: 0.5em;
-}
-aside.footnote > p {
-  margin-left: 2em;
-}
-div.citation > p {
-  margin-left: 4em;
-}
-aside.footnote > p:last-of-type,
-div.citation > p:last-of-type {
+
+dl.footnote > dd,
+dl.citation > dd {
     margin-bottom: 0em;
 }
-aside.footnote > p:last-of-type:after,
-div.citation > p:last-of-type:after {
+
+dl.footnote > dd:after,
+dl.citation > dd:after {
     content: "";
     clear: both;
 }
@@ -644,6 +636,10 @@ dl.field-list > dt {
     padding-left: 0.5em;
     padding-right: 5px;
 }
+dl.field-list > dt:after {
+    content: ":";
+}
+
 
 dl.field-list > dd {
     padding-left: 0.5em;