Skip to content
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

Update Readme to add a link to graphstorm paper #885

Merged
merged 2 commits into from
Jun 19, 2024
Merged
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
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## GraphStorm
|[Document and Tutorial Site](https://graphstorm.readthedocs.io/en/latest/) |
| [Document and Tutorial Site](https://graphstorm.readthedocs.io/en/latest/) | [GraphStorm Paper](https://arxiv.org/abs/2406.06022) |
classicsong marked this conversation as resolved.
Show resolved Hide resolved

GraphStorm is a graph machine learning (GML) framework for enterprise use cases.
It simplifies the development, training and deployment of GML models for industry-scale graphs
Expand Down Expand Up @@ -41,7 +41,7 @@ python /graphstorm/tools/partition_graph.py --dataset ogbn-arxiv \
--output /tmp/ogbn_arxiv_nc_train_val_1p_4t
```

GraphStorm training relies on ssh to launch training jobs. The GraphStorm standalone mode uses ssh services in port 22.
GraphStorm training relies on ssh to launch training jobs. The GraphStorm standalone mode uses ssh services in port 22.

In addition, to run GraphStorm training in a single machine, users need to create a ``ip_list.txt`` file that contains one row as below, which will facilitate ssh communication to the machine itself.

Expand Down Expand Up @@ -106,6 +106,20 @@ python -m graphstorm.run.gs_link_prediction \

To learn GraphStorm's full capabilities, please refer to our [Documentations and Tutorials](https://graphstorm.readthedocs.io/en/latest/).


## Cite

If you use GraphStorm in a scientific publication, we would appreciate citations to the following paper:
```
@article{zheng2024graphstorm,
title={GraphStorm: all-in-one graph machine learning framework for industry applications},
author={Zheng, Da and Song, Xiang and Zhu, Qi and Zhang, Jian and Vasiloudis, Theodore and Ma, Runjie and Zhang, Houyu and Wang, Zichen and Adeshina, Soji and Nisa, Israt and others},
journal={arXiv preprint arXiv:2406.06022},
year={2024}
}
```


## Limitation
GraphStorm framework now supports using CPU or NVidia GPU for model training and inference. But it only works with PyTorch-gloo backend. It was only tested on AWS CPU instances or AWS GPU instances equipped with NVidia GPUs including P4, V100, A10 and A100.

Expand Down
Loading