.\"Text automatically generated by txt2man
.TH perceptron  "1" "" ""
.SH NAME
\fBperceptron \fP- perceptron
.SH SYNOPSIS
.nf
.fam C
 \fBperceptron\fP [\fB-h\fP] [\fB-v\fP] \fB-T\fP \fIstring\fP \fB-t\fP \fIstring\fP [\fB-i\fP \fIint\fP] [\fB-l\fP \fIstring\fP] [\fB-o\fP \fIstring\fP] \fB-V\fP 
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION


This program implements a \fBperceptron\fP, which is a single level Neural Network.
The \fBperceptron\fP makes its predictions based on a linear predictor function
combining a set of weights with the feature vector.
The \fBperceptron\fP learning rule is able to converge, given enough iterations
using the \fB--iterations\fP (\fB-i\fP) parameter, if the data supplied is linearly
separable. 
The Perceptron is parameterized by a matrix of weight vectors which denotes
the numerical weights of the Neural Network.
This program allows training of a \fBperceptron\fP, and then application of the
learned \fBperceptron\fP to a test dataset. To train a \fBperceptron\fP, a training
dataset must be passed to \fB--train_file\fP (\fB-t\fP). Labels can either be present as
the last dimension of the training dataset, or given explicitly with the
\fB--labels_file\fP (\fB-l\fP) parameter.
A test file is given through the \fB--test_file\fP (\fB-T\fP) parameter. The predicted
labels for the test set will be stored in the file specified by the
\fB--output_file\fP (\fB-o\fP) parameter.
.SH REQUIRED OPTIONS 

.TP
.B
\fB--test_file\fP (\fB-T\fP) [\fIstring\fP]
A file containing the test set. 
.TP
.B
\fB--train_file\fP (\fB-t\fP) [\fIstring\fP]
A file containing the training set.  
.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--iterations\fP (\fB-i\fP) [\fIint\fP]
The maximum number of iterations the \fBperceptron\fP is to be run Default value 1000. 
.TP
.B
\fB--labels_file\fP (\fB-l\fP) [\fIstring\fP]
A file containing labels for the training set.  Default value ''. 
.TP
.B
\fB--output\fP (\fB-o\fP) [\fIstring\fP]
The file in which the predicted labels for the test set will be written. Default value 'output.csv'. 
.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.