Implementation of the base layer. More...

Public Member Functions
	BaseLayer ()
	Create the BaseLayer object. More...

template<typename eT >
void	Backward (const arma::Mat< eT > &&input, arma::Mat< eT > &&gy, arma::Mat< eT > &&g)
	Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backwards trough f. More...

OutputDataType const &	Delta () const
	Get the delta. More...

OutputDataType &	Delta ()
	Modify the delta. More...

template<typename InputType , typename OutputType >
void	Forward (const InputType &&input, OutputType &&output)
	Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activity forward through f. More...

InputDataType const &	InputParameter () const
	Get the input parameter. More...

InputDataType &	InputParameter ()
	Modify the input parameter. More...

OutputDataType const &	OutputParameter () const
	Get the output parameter. More...

OutputDataType &	OutputParameter ()
	Modify the output parameter. More...

template<typename Archive >
void	Serialize (Archive &, const unsigned int)
	Serialize the layer. More...

Private Attributes
OutputDataType	delta
	Locally-stored delta object. More...

InputDataType	inputParameter
	Locally-stored input parameter object. More...

OutputDataType	outputParameter
	Locally-stored output parameter object. More...

Detailed Description

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
class mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >

Implementation of the base layer.

The base layer works as a metaclass which attaches various functions to the embedding layer.

A few convenience typedefs are given:

SigmoidLayer
IdentityLayer
ReLULayer
TanHLayer

Template Parameters

ActivationFunction	Activation function used for the embedding layer.
InputDataType	Type of the input data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).
OutputDataType	Type of the output data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).

Definition at line 47 of file base_layer.hpp.

Constructor & Destructor Documentation

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::BaseLayer ( )

inline

Create the BaseLayer object.

Definition at line 53 of file base_layer.hpp.

Member Function Documentation

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

template<typename eT >

void mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::Backward	(	const arma::Mat< eT > &&	input,
		arma::Mat< eT > &&	gy,
		arma::Mat< eT > &&	g
	)

inline

Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backwards trough f.

Using the results from the feed forward pass.

Parameters

input	The propagated input activation.
gy	The backpropagated error.
g	The calculated gradient.

Definition at line 81 of file base_layer.hpp.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

OutputDataType const& mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::Delta ( ) const

inline

Get the delta.

Definition at line 101 of file base_layer.hpp.

References mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::delta.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

OutputDataType& mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::Delta ( )

inline

Modify the delta.

Definition at line 103 of file base_layer.hpp.

References mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::delta.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

template<typename InputType , typename OutputType >

void mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::Forward	(	const InputType &&	input,
		OutputType &&	output
	)

inline

Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activity forward through f.

Parameters

input	Input data used for evaluating the specified function.
output	Resulting output activation.

Definition at line 66 of file base_layer.hpp.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

InputDataType const& mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::InputParameter ( ) const

inline

Get the input parameter.

Definition at line 91 of file base_layer.hpp.

References mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::inputParameter.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

InputDataType& mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::InputParameter ( )

inline

Modify the input parameter.

Definition at line 93 of file base_layer.hpp.

References mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::inputParameter.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

OutputDataType const& mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 96 of file base_layer.hpp.

References mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::outputParameter.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

OutputDataType& mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::OutputParameter ( )

inline

Modify the output parameter.

Definition at line 98 of file base_layer.hpp.

References mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::outputParameter.

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

template<typename Archive >

void mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::Serialize	(	Archive &	,
		const unsigned	int
	)

inline

Serialize the layer.

Definition at line 109 of file base_layer.hpp.

Member Data Documentation

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

OutputDataType mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::delta

private

Locally-stored delta object.

Definition at line 116 of file base_layer.hpp.

Referenced by mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::Delta().

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

InputDataType mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::inputParameter

private

Locally-stored input parameter object.

Definition at line 119 of file base_layer.hpp.

Referenced by mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::InputParameter().

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>

OutputDataType mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::outputParameter

private

Locally-stored output parameter object.

Definition at line 122 of file base_layer.hpp.

Referenced by mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >::OutputParameter().

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

src/mlpack/methods/ann/layer/base_layer.hpp

Public Member Functions

Private Attributes

Detailed Description

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat> class mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class ActivationFunction = LogisticFunction, typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
class mlpack::ann::BaseLayer< ActivationFunction, InputDataType, OutputDataType >