.\"Text automatically generated by txt2man .TH nmf "1" "" "" .SH NAME \fBnmf \fP- non-negative matrix factorization .SH SYNOPSIS .nf .fam C \fBnmf\fP [\fB-h\fP] [\fB-v\fP] \fB-H\fP \fIstring\fP \fB-i\fP \fIstring\fP \fB-r\fP \fIint\fP \fB-W\fP \fIstring\fP [\fB-m\fP \fIint\fP] [\fB-e\fP \fIdouble\fP] [\fB-s\fP \fIint\fP] [\fB-u\fP \fIstring\fP] \fB-V\fP .fam T .fi .fam T .fi .SH DESCRIPTION This program performs non-negative matrix factorization on the given dataset, storing the resulting decomposed matrices in the specified files. For an input dataset V, NMF decomposes V into two matrices W and H such that .PP V = W * H .PP where all elements in W and H are non-negative. If V is of size (n x m), then W will be of size (n x r) and H will be of size (r x m), where r is the rank of the factorization (specified by \fB--rank\fP). .PP Optionally, the desired update rules for each NMF iteration can be chosen from the following list: .RS .IP \(bu 3 multdist: multiplicative distance-based update rules (Lee and Seung 1999) .IP \(bu 3 multdiv: multiplicative divergence-based update rules (Lee and Seung 1999) .IP \(bu 3 als: alternating least squares update rules (Paatero and Tapper 1994) .RE .PP The maximum number of iterations is specified with \fB--max_iterations\fP, and the minimum residue required for algorithm termination is specified with \fB--min_residue\fP. .SH REQUIRED OPTIONS .TP .B \fB--h_file\fP (\fB-H\fP) [\fIstring\fP] File to save the calculated H matrix to. .TP .B \fB--input_file\fP (\fB-i\fP) [\fIstring\fP] Input dataset to perform NMF on. .TP .B \fB--rank\fP (\fB-r\fP) [\fIint\fP] Rank of the factorization. .TP .B \fB--w_file\fP (\fB-W\fP) [\fIstring\fP] File to save the calculated W matrix to. .SH OPTIONS .TP .B \fB--help\fP (\fB-h\fP) Default help info. .TP .B \fB--info\fP [\fIstring\fP] Get help on a specific module or option. Default value ''. .TP .B \fB--max_iterations\fP (\fB-m\fP) [\fIint\fP] Number of iterations before NMF terminates (0 runs until convergence. Default value 10000. .TP .B \fB--min_residue\fP (\fB-e\fP) [\fIdouble\fP] The minimum root mean square residue allowed for each iteration, below which the program terminates. Default value 1e-05. .TP .B \fB--seed\fP (\fB-s\fP) [\fIint\fP] Random seed. If 0, 'std::time(NULL)' is used. Default value 0. \fB--update_rules\fP (\fB-u\fP) [\fIstring\fP] Update rules for each iteration; ( multdist | multdiv | als ). Default value 'multdist'. .TP .B \fB--verbose\fP (\fB-v\fP) Display informational messages and the full list of parameters and timers at the end of execution. .TP .B \fB--version\fP (\fB-V\fP) Display the version of mlpack. .SH ADDITIONAL INFORMATION For further information, including relevant papers, citations, and theory, consult the documentation found at http://www.mlpack.org or included with your distribution of MLPACK.