Skip to content

Commit 2053ee9

Browse files
committed
update readme
1 parent b611dd6 commit 2053ee9

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,34 @@
3636
segmentation task in transductive learning.
3737
* **visualization**: some visualization functions.
3838
* **transductive**: visualize segmentation result in transductive learning.
39+
40+
41+
## Installation
42+
Ensure that at least Python3, PyTorch 1.2.0 is installed. HyperG is still under development. Before the first stable
43+
release (1.0), please clone the repository and run
44+
```commandline
45+
pip install .
46+
```
47+
48+
## Documentation
49+
Tutorial and Documentation will coming soon!
3950

40-
41-
42-
including edge construction, graph construction and graph/hypergraph convolution.
51+
## Examples
52+
We provide examples in classification, regression, segmentation tasks with hypergraph, for more detail refer to our tutorials.
53+
54+
## Citing HyperG
55+
If you find **HyperG** is useful in your research, please consider citing:
56+
```
57+
@inproceedings{feng2019hypergraph,
58+
title={Hypergraph neural networks},
59+
author={Feng, Yifan and You, Haoxuan and Zhang, Zizhao and Ji, Rongrong and Gao, Yue},
60+
booktitle={Proceedings of the AAAI Conference on Artificial Intelligence},
61+
volume={33},
62+
pages={3558--3565},
63+
year={2019}
64+
}
65+
```
66+
67+
## Contributing
68+
We always welcome contributions to help make HyperG better, and apply hypergraph in more application. If you would like
69+
to contribute, please contact [us](mailto:[email protected]).

0 commit comments

Comments
 (0)