Skip to content

Commit 2f1653e

Browse files
yifanfeng97yifanfeng97
committed
update doc
1 parent 201a64d commit 2f1653e

43 files changed

Lines changed: 238 additions & 25 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,6 @@ DHG is available for **Python 3.8** and **Pytorch 1.11.0** and above.
7474
```bash
7575
pip install dhg
7676
```
77-
### Install from Github Repository
78-
79-
```bash
80-
pip install git+https://github.com/iMoonLab/DeepHypergraph.git
81-
```
8277

8378
## Quick Start
8479

‎docs/source/examples/auto_ml/gcn_on_cora.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
GCN on Cora
22
===============
33

4+
.. hint::
5+
6+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
7+
- Proof: Xinwei Zhang
8+
49
In the following example, we present a simple example of Auto-ML for vertex classification on simple graph.
510
More details for how to use the :doc:`/api/experiments` to auto tuning your own model can be found in the tutorial <:doc:`/tutorial/auto_ml`>.
611

‎docs/source/examples/auto_ml/hgnnp_on_cooking200.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
HGNN+ on Cooking200
22
=======================
33

4+
.. hint::
5+
6+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
7+
- Proof: Xinwei Zhang
8+
49
In the following example, we present a simple example of Auto-ML for vertex classification on simple hypergraph.
510
More details for how to use the :doc:`/api/experiments` to auto tuning your own model can be found in the tutorial <:doc:`/tutorial/auto_ml`>.
611

‎docs/source/examples/auto_ml/lightgcn_on_gowalla.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
LightGCN on Gowalla
22
=======================
33

4+
.. hint::
5+
6+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
7+
- Proof: Xinwei Zhang
8+
49
In the following example, we present a simple example of Auto-ML for recommender task on User-Item bipartite graph.
510
More details for how to use the :doc:`/api/experiments` to auto tuning your own model can be found in the tutorial <:doc:`/tutorial/auto_ml`>.
611

‎docs/source/examples/recommender.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
User-Item Recommender
22
====================================
33

4+
.. hint::
5+
6+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
7+
- Proof: Xinwei Zhang
8+
49
In the following examples, two typical collaborative filtering neural networks are used to perform item recommender on the User-Item bipartite graph.
510

611
Models

‎docs/source/examples/vertex_cls/graph.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
On Simple Graph
22
==========================================
33

4+
.. hint::
5+
6+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
7+
- Proof: Xinwei Zhang
8+
49
In the following examples, four typical graph/hypergraph neural networks are used to perform vertex classification task on the simple graph structure.
510

611
Models

‎docs/source/examples/vertex_cls/hypergraph.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
On Simple Hypergraph
22
==========================================
33

4+
.. hint::
5+
6+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
7+
- Proof: Xinwei Zhang
8+
49

510
In the following examples, three typical graph/hypergraph neural networks are used to perform vertex classification task on the simple hypergraph structure.
611

‎docs/source/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
DHG Documentation
77
=======================
88

9-
.. caution::
9+
.. attention::
1010

1111
We are rushing the documentation and tutorials, which will be updated twice a day!
1212

‎docs/source/start/contribution.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Contribute to DHG
22
======================
33

4+
.. hint::
5+
6+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
7+
- Proof: Xinwei Zhang
8+
49
DHG is a free software; you can redistribute it and/or modify it under the terms
510
of the Apache License 2.0. We welcome contributions.
611

‎docs/source/start/high_order/hypergraph.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Learning on Simple Hypergraph
44
=================================
55

6+
.. hint::
7+
8+
- Author: `Yifan Feng (丰一帆) <https://fengyifan.site/>`_
9+
- Proof: Xinwei Zhang
10+
611
Definition
712
-----------------
813
A `simple hypergraph <https://en.wikipedia.org/wiki/Hypergraph>`_ (also called undirected hypergraph) can be indicated with :math:`\mathcal{G} = \{\mathcal{V}, \mathcal{E}\}`.

0 commit comments

Comments
 (0)