Skip to content

Commit

Permalink
Readme refined
Browse files Browse the repository at this point in the history
  • Loading branch information
luav committed Jul 20, 2017
1 parent abed610 commit 04e8fc5
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,19 @@ $ gecmi file1 file2

Execution Options:
```
-h [ --help ] produce help message
--input arg name of the input files
-s [ --sync ] synchronize the node base, for example to fairly
evaluate against top K selected clusters that
are subset of the original nodes
-n [ --nmis ] output both NMI [max] and NMI_sqrt
-f [ --fnmi ] evaluate also FNMI, includes '-x'
-r [ --risk ] arg (=0.01) probability of value being outside
-e [ --error ] arg (=0.01) admissible error
-a [ --fast ] apply fast approximate evaluations that are less
accurate, but much faster on large networks
-m [ --membership ] arg (=1) average expected membership of nodes in the
clusters, > 0, typically >= 1
-h [ --help ] produce help message
--input arg name of the input files
-s [ --sync ] synchronize the node base, for example to fairly
evaluate against top K selected clusters that
are subset of the original nodes
-n [ --nmis ] output both NMI [max] and NMI_sqrt
-f [ --fnmi ] evaluate also FNMI, includes '-x'
-r [ --risk ] arg (=0.01) probability of value being outside
-e [ --error ] arg (=0.01) admissible error
-a [ --fast ] apply fast approximate evaluations that are less
accurate, but much faster on large networks
-m [ --membership ] arg (=1) average expected membership of nodes in the
clusters, > 0, typically >= 1
```
If you want to tweak the precision, use the options `-e` and `-r`, to set the error and
the risk respectively. See the [paper](http://arxiv.org/abs/1202.0425) for the meaning of these concepts.
Expand Down

0 comments on commit 04e8fc5

Please sign in to comment.