Skip to content

Commit c60d8a1

Browse files
committed
fix readme
1 parent db782eb commit c60d8a1

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This SEMB library allows fast onboarding to get and evaluate structural node emb
66

77
The library itself has already included a set of popular methods and datasets ready for immediate use.
88

9-
- Built-in methods: [node2vec](https://github.com/aditya-grover/node2vec), [struc2vec](https://github.com/leoribeiro/struc2vec), [GraphWave](https://github.com/snap-stanford/graphwave), [xNetMF](https://github.com/GemsLab/REGAL), [role2vec](https://github.com/benedekrozemberczki/role2vec), [DRNE](https://github.com/tadpole/DRNE), [MultiLENS](https://github.com/GemsLab/MultiLENS), [RiWalk](github.com/maxuewei2/RiWalk), [SEGK](https://github.com/giannisnik/segk)
9+
- Built-in methods: [node2vec](https://github.com/aditya-grover/node2vec), [struc2vec](https://github.com/leoribeiro/struc2vec), [GraphWave](https://github.com/snap-stanford/graphwave), [xNetMF](https://github.com/GemsLab/REGAL), [role2vec](https://github.com/benedekrozemberczki/role2vec), [DRNE](https://github.com/tadpole/DRNE), [MultiLENS](https://github.com/GemsLab/MultiLENS), [RiWalk](github.com/maxuewei2/RiWalk), [SEGK](https://github.com/giannisnik/segk), (more datasets to be added in the future)
1010

1111
- Built-in datasets:
1212

@@ -59,7 +59,7 @@ Currently, SEMB only supports embedding and evaluation on *undirected* and *unwe
5959
- Within the package root directory, make sure `__init__.py` is present
6060
- Create a ` method.py` and make a `Method` class that inherits from `from semb.methods import BaseMethod` and implement the required methods. See `semb/methods/node2vec/method.py` for more details.
6161
- Please make sure that your implemented method accepts `networkx.classes.graph.Graph` as input.
62-
- Please make sure that after `train()` is called, the `self.embeddings` should be a Python built-in `dict()` with key as `<Node_id (int)>` and value(embedding) as `<List(float)>`.
62+
- Please make sure that when `train()` is called, the `self.embeddings` should be a Python built-in `dict()` with key as `<Node_id (int)>` and value(embedding) as `<List(float)>`.
6363
- Install the package via `setup.py` or pip.
6464
- Now the method is load-able by the main client program that uses `semb`!
6565

@@ -68,3 +68,13 @@ For both `dataset` and `method` extensions, make sure the `get_id()` to be overr
6868

6969

7070

71+
### Malicious
72+
73+
If you encounter any question using our SEMB library, feel free to raise an issue or send an email to [kinmark@umich.edu](kinmark@umich.edu). Go Blue!
74+
75+
76+
77+
78+
79+
80+

0 commit comments

Comments
 (0)