diff options
Diffstat (limited to 'doc/label_prop.1')
| -rw-r--r-- | doc/label_prop.1 | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/doc/label_prop.1 b/doc/label_prop.1 new file mode 100644 index 0000000..8ba45f6 --- /dev/null +++ b/doc/label_prop.1 @@ -0,0 +1,112 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "LABEL_PROP" "1" "September 2017" "www.complex-networks.net" "www.complex-networks.net" +. +.SH "NAME" +\fBlabel_prop\fR \- Find communities using label propagation +. +.SH "SYNOPSIS" +\fBlabel_prop\fR [SYNC|ASYNC] \fIgraph_in\fR [\fImax_epochs\fR] +. +.SH "DESCRIPTION" +\fBlabel_prop\fR finds the communities in \fIgraph_in\fR using the label propagation algorithm proposed by Raghavan, Albert, and Kumara\. The program prints on STDOUT the partition obtained where no more label flips are possible, and reports on STDERR the number of communities and the corresponding value of modularity at each epoch\. When used in ASYNC mode, the algorithm is suitable to find communities in large graphs\. +. +.SH "PARAMETERS" +. +.TP +\fBSYNC\fR|\fBASYNC\fR +The first parameter is used to choose between synchronous (\fBSYNC\fR) or asynchronous (\fBASYNC\fR) label update\. +. +.TP +\fIgraph_in\fR +undirected input graph (edge list)\. If is equal to \fB\-\fR (dash), read the edge list from STDIN\. +. +.TP +\fImax_epochs\fR +Sets the maximum number of epochs to run (optional)\. +. +.SH "OUTPUT" +The program prints on STDOUT the partition obtained where no more label flips are possible, in the format: +. +.IP "" 4 +. +.nf + + ## nc: NUM_COMM Q_max: Q_MAX Epochs: EPOCHS + node_1 comm_1 + node_2 comm_2 + node_3 comm_3 + \.\.\. +. +.fi +. +.IP "" 0 +. +.P +where \fBcomm_i\fR is the community to which \fBnode_i\fR belongs\. The first output line reports the number of communities \fBNUM_COMM\fR, the corresponding value of modularity \fBQ_MAX\fR, and the number of epochs \fBEPOCHS\fR used to find the partition\. +. +.P +The program prints on STDERR the epoch number, the value of modularity of the partition at that epoch, and the number of flips made in that epoch, in the format: +. +.IP "" 4 +. +.nf + + 1 Q_1 flips_1 + 2 Q_2 flips_2 + 3 Q_3 flips_3 + \.\.\.\. +. +.fi +. +.IP "" 0 +. +.P +where \fBQ_i\fR is the modularity of the partition at the i\-th epoch, and \fBflips_i\fR is the number of label flips performed during that epoch\. +. +.SH "EXAMPLES" +We can use \fBlabel_prop\fR to find communities in the graph \fBkarate_club_unweighted\.net\fR (Zachary Karate Club network) with the command: +. +.IP "" 4 +. +.nf + + $ label_prop ASYNC karate_club_unweighted\.net 2> karate_label\-prop_trace + ### nc: 2 Q_max: 0\.371795 Epochs: 6 + 0 0 + 1 0 + 2 0 + 3 0 + \.\.\. + 30 1 + 31 1 + 32 1 + 33 1 + $ +. +.fi +. +.IP "" 0 +. +.P +The program has found a partition with 2 communities corrisponding to a modularity Q=0\.371795\. Notice that node 0, 1, 2, 3, are in community 0, while node 30, 31, 32, 33 are in community 1\. In this example, we have chosen to save the information about the modularity and number of flips at each epoch in the file \fBkarate_label\-prop_trace\fR\. +. +.SH "SEE ALSO" +modularity(1), gn(1), cnm(1) +. +.SH "REFERENCES" +. +.IP "\(bu" 4 +U\. N\. Raghavan, R\. Albert, and S\. Kumara\. "Near linear time algorithm to detect community structures in large\-scale networks"\. Phys\. Rev\. E 76 (2007), 036106\. +. +.IP "\(bu" 4 +V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Appendix 19, Cambridge University Press (2017) +. +.IP "\(bu" 4 +V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Chapter 9, Cambridge University Press (2017) +. +.IP "" 0 +. +.SH "AUTHORS" +(c) Vincenzo \'KatolaZ\' Nicosia 2009\-2017 \fB<v\.nicosia@qmul\.ac\.uk>\fR\. |