andrewsleader commited on
Commit
6e18ca2
1 Parent(s): 4a97a9b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -114
README.md CHANGED
@@ -19,7 +19,6 @@ Overview of the Temporal Graph Benchmark (TGB) pipeline:
19
  - TGB provides public and online leaderboards to track recent developments in temporal graph learning domain.
20
 
21
 
22
-
23
  ```
24
  pip install py-tgb
25
  ```
@@ -36,116 +35,3 @@ TGB dataloader will also automatically download the dataset as well as the negat
36
 
37
  if website is unaccessible, please use [this link](https://tgb-website.pages.dev/) instead.
38
 
39
-
40
- ### Running Example Methods
41
-
42
- - For the dynamic link property prediction task, see the [`examples/linkproppred`](https://github.com/shenyangHuang/TGB/tree/main/examples/linkproppred) folder for example scripts to run TGN, DyRep and EdgeBank on TGB datasets.
43
- - For the dynamic node property prediction task, see the [`examples/nodeproppred`](https://github.com/shenyangHuang/TGB/tree/main/examples/nodeproppred) folder for example scripts to run TGN, DyRep and EdgeBank on TGB datasets.
44
- - For all other baselines, please see the [TGB_Baselines](https://github.com/fpour/TGB_Baselines) repo.
45
-
46
- ### Acknowledgments
47
- We thank the [OGB](https://ogb.stanford.edu/) team for their support throughout this project and sharing their website code for the construction of [TGB website](https://tgb.complexdatalab.com/).
48
-
49
-
50
- ### Citation
51
-
52
- If code or data from this repo is useful for your project, please consider citing our paper:
53
- ```
54
- @article{huang2023temporal,
55
- title={Temporal graph benchmark for machine learning on temporal graphs},
56
- author={Huang, Shenyang and Poursafaei, Farimah and Danovitch, Jacob and Fey, Matthias and Hu, Weihua and Rossi, Emanuele and Leskovec, Jure and Bronstein, Michael and Rabusseau, Guillaume and Rabbany, Reihaneh},
57
- journal={Advances in Neural Information Processing Systems},
58
- year={2023}
59
- }
60
- ```
61
- <!--
62
-
63
- ### Install dependency
64
- Our implementation works with python >= 3.9 and can be installed as follows
65
-
66
- 1. set up virtual environment (conda should work as well)
67
- ```
68
- python -m venv ~/tgb_env/
69
- source ~/tgb_env/bin/activate
70
- ```
71
-
72
- 2. install external packages
73
- ```
74
- pip install pandas==1.5.3
75
- pip install matplotlib==3.7.1
76
- pip install clint==0.5.1
77
- ```
78
-
79
- install Pytorch and PyG dependencies (needed to run the examples)
80
- ```
81
- pip install torch==2.0.0 --index-url https://download.pytorch.org/whl/cu117
82
- pip install torch_geometric==2.3.0
83
- pip install pyg_lib torch_scatter torch_sparse torch_cluster torch_spline_conv -f https://data.pyg.org/whl/torch-2.0.0+cu117.html
84
- ```
85
-
86
- 3. install local dependencies under root directory `/TGB`
87
- ```
88
- pip install -e .
89
- ```
90
-
91
-
92
- ### Instruction for tracking new documentation and running mkdocs locally
93
-
94
- 1. first run the mkdocs server locally in your terminal
95
- ```
96
- mkdocs serve
97
- ```
98
-
99
- 2. go to the local hosted web address similar to
100
- ```
101
- [14:18:13] Browser connected: http://127.0.0.1:8000/
102
- ```
103
-
104
- Example: to track documentation of a new hi.py file in tgb/edgeregression/hi.py
105
-
106
-
107
- 3. create docs/api/tgb.hi.md and add the following
108
- ```
109
- # `tgb.edgeregression`
110
-
111
- ::: tgb.edgeregression.hi
112
- ```
113
-
114
- 4. edit mkdocs.yml
115
- ```
116
- nav:
117
- - Overview: index.md
118
- - About: about.md
119
- - API:
120
- other *.md files
121
- - tgb.edgeregression: api/tgb.hi.md
122
- ```
123
-
124
- ### Creating new branch ###
125
- ```
126
- git fetch origin
127
-
128
- git checkout -b test origin/test
129
- ```
130
-
131
- ### dependencies for mkdocs (documentation)
132
- ```
133
- pip install mkdocs
134
- pip install mkdocs-material
135
- pip install mkdocstrings-python
136
- pip install mkdocs-jupyter
137
- pip install notebook
138
- ```
139
-
140
-
141
- ### full dependency list
142
- Our implementation works with python >= 3.9 and has the following dependencies
143
- ```
144
- pytorch == 2.0.0
145
- torch-geometric == 2.3.0
146
- torch-scatter==2.1.1
147
- torch-sparse==0.6.17
148
- torch-spline-conv==1.2.2
149
- pandas==1.5.3
150
- clint==0.5.1
151
- ``` -->
 
19
  - TGB provides public and online leaderboards to track recent developments in temporal graph learning domain.
20
 
21
 
 
22
  ```
23
  pip install py-tgb
24
  ```
 
35
 
36
  if website is unaccessible, please use [this link](https://tgb-website.pages.dev/) instead.
37