This class implements a simple perceptron (i.e., a single layer neural network). More...

Public Member Functions
	Perceptron (const size_t numClasses=0, const size_t dimensionality=0, const size_t maxIterations=1000)
	Constructor: create the perceptron with the given number of classes and initialize the weight matrix, but do not perform any training. More...

	Perceptron (const MatType &data, const arma::Row< size_t > &labels, const size_t numClasses, const size_t maxIterations=1000)
	Constructor: constructs the perceptron by building the weights matrix, which is later used in classification. More...

	Perceptron (const Perceptron &other, const MatType &data, const arma::Row< size_t > &labels, const size_t numClasses, const arma::rowvec &instanceWeights)
	Alternate constructor which copies parameters from an already initiated perceptron. More...

const arma::vec &	Biases () const
	Get the biases. More...

arma::vec &	Biases ()
	Modify the biases. You had better know what you are doing! More...

void	Classify (const MatType &test, arma::Row< size_t > &predictedLabels)
	Classification function. More...

size_t	MaxIterations () const
	Get the maximum number of iterations. More...

size_t &	MaxIterations ()
	Modify the maximum number of iterations. More...

size_t	NumClasses () const
	Get the number of classes this perceptron has been trained for. More...

template < typename Archive >
void	serialize (Archive &ar, const uint32_t)
	Serialize the perceptron. More...

void	Train (const MatType &data, const arma::Row< size_t > &labels, const size_t numClasses, const arma::rowvec &instanceWeights=arma::rowvec())
	Train the perceptron on the given data for up to the maximum number of iterations (specified in the constructor or through MaxIterations()). More...

const arma::mat &	Weights () const
	Get the weight matrix. More...

arma::mat &	Weights ()
	Modify the weight matrix. You had better know what you are doing! More...

Detailed Description

template
<
typename
LearnPolicy
=
SimpleWeightUpdate
,
typename
WeightInitializationPolicy
=
ZeroInitialization
,
typename
MatType
=
arma::mat
>

class mlpack::perceptron::Perceptron< LearnPolicy, WeightInitializationPolicy, MatType >

This class implements a simple perceptron (i.e., a single layer neural network).

It converges if the supplied training dataset is linearly separable.

Template Parameters

LearnPolicy	Options of SimpleWeightUpdate and GradientDescent.
WeightInitializationPolicy	Option of ZeroInitialization and RandomInitialization.

Definition at line 36 of file perceptron.hpp.

Constructor & Destructor Documentation

◆ Perceptron() [1/3]

Perceptron	(	const size_t	numClasses = `0`,
		const size_t	dimensionality = `0`,
		const size_t	maxIterations = `1000`
	)

Constructor: create the perceptron with the given number of classes and initialize the weight matrix, but do not perform any training.

(Call the Train() function to perform training.)

Parameters

numClasses	Number of classes in the dataset.
dimensionality	Dimensionality of the dataset.
maxIterations	Maximum number of iterations for the perceptron learning algorithm.

◆ Perceptron() [2/3]

Perceptron	(	const MatType &	data,
		const arma::Row< size_t > &	labels,
		const size_t	numClasses,
		const size_t	maxIterations = `1000`
	)

Constructor: constructs the perceptron by building the weights matrix, which is later used in classification.

The number of classes should be specified separately, and the labels vector should contain values in the range [0, numClasses - 1]. The data::NormalizeLabels() function can be used if the labels vector does not contain values in the required range.

Parameters

data	Input, training data.
labels	Labels of dataset.
numClasses	Number of classes in the dataset.
maxIterations	Maximum number of iterations for the perceptron learning algorithm.

◆ Perceptron() [3/3]

Perceptron	(	const Perceptron< LearnPolicy, WeightInitializationPolicy, MatType > &	other,
		const MatType &	data,
		const arma::Row< size_t > &	labels,
		const size_t	numClasses,
		const arma::rowvec &	instanceWeights
	)

Alternate constructor which copies parameters from an already initiated perceptron.

Parameters

other	The other initiated Perceptron object from which we copy the values from.
data	The data on which to train this Perceptron object on.
labels	The labels of data.
numClasses	Number of classes in the data.
instanceWeights	Weight vector to use while training. For boosting purposes.

Member Function Documentation

◆ Biases() [1/2]

const arma::vec& Biases ( ) const

inline

Get the biases.

Definition at line 139 of file perceptron.hpp.

◆ Biases() [2/2]

arma::vec& Biases ( )

inline

Modify the biases. You had better know what you are doing!

Definition at line 141 of file perceptron.hpp.

◆ Classify()

void Classify	(	const MatType &	test,
		arma::Row< size_t > &	predictedLabels
	)

Classification function.

After training, use the weights matrix to classify test, and put the predicted classes in predictedLabels.

Parameters

test	Testing data or data to classify.
predictedLabels	Vector to store the predicted classes after classifying test.

◆ MaxIterations() [1/2]

size_t MaxIterations ( ) const

inline

Get the maximum number of iterations.

Definition at line 126 of file perceptron.hpp.

◆ MaxIterations() [2/2]

size_t& MaxIterations ( )

inline

Modify the maximum number of iterations.

Definition at line 128 of file perceptron.hpp.

◆ NumClasses()

size_t NumClasses ( ) const

inline

Get the number of classes this perceptron has been trained for.

Definition at line 131 of file perceptron.hpp.

◆ serialize()

void serialize	(	Archive &	ar,
		const uint32_t
	)

Serialize the perceptron.

◆ Train()

void Train	(	const MatType &	data,
		const arma::Row< size_t > &	labels,
		const size_t	numClasses,
		const arma::rowvec &	instanceWeights = `arma::rowvec()`
	)

Train the perceptron on the given data for up to the maximum number of iterations (specified in the constructor or through MaxIterations()).

A single iteration corresponds to a single pass through the data, so if you want to pass through the dataset only once, set MaxIterations() to 1.

This training does not reset the model weights, so you can call Train() on multiple datasets sequentially.

Parameters

data	Dataset on which training should be performed.
labels	Labels of the dataset.
numClasses	Number of classes in the data.
instanceWeights	Cost matrix. Stores the cost of mispredicting instances. This is useful for boosting.

◆ Weights() [1/2]

const arma::mat& Weights ( ) const

inline

Get the weight matrix.

Definition at line 134 of file perceptron.hpp.

◆ Weights() [2/2]

arma::mat& Weights ( )

inline

Modify the weight matrix. You had better know what you are doing!

Definition at line 136 of file perceptron.hpp.

The documentation for this class was generated from the following file:

/home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/perceptron/perceptron.hpp

Public Member Functions

Detailed Description

template<typenameLearnPolicy=SimpleWeightUpdate,typenameWeightInitializationPolicy=ZeroInitialization,typenameMatType=arma::mat> class mlpack::perceptron::Perceptron< LearnPolicy, WeightInitializationPolicy, MatType >

Constructor & Destructor Documentation

◆ Perceptron() [1/3]

◆ Perceptron() [2/3]

◆ Perceptron() [3/3]

Member Function Documentation

◆ Biases() [1/2]

◆ Biases() [2/2]

◆ Classify()

◆ MaxIterations() [1/2]

◆ MaxIterations() [2/2]

◆ NumClasses()

◆ serialize()

◆ Train()

◆ Weights() [1/2]

◆ Weights() [2/2]

template
<
typename
LearnPolicy
=
SimpleWeightUpdate
,
typename
WeightInitializationPolicy
=
ZeroInitialization
,
typename
MatType
=
arma::mat
>

class mlpack::perceptron::Perceptron< LearnPolicy, WeightInitializationPolicy, MatType >