Linear model in a kernel feature space. More...

#include <shark/Models/Kernels/KernelExpansion.h>

Inheritance diagram for shark::KernelExpansion< InputType >:

Public Types
typedef AbstractKernelFunction< InputType >	KernelType

typedef base_type::BatchInputType	BatchInputType

typedef base_type::BatchOutputType	BatchOutputType

Public Types inherited from shark::AbstractModel< InputType, RealVector >
enum	Feature

typedef InputType	InputType
	Defines the input type of the model. More...

typedef RealVector	OutputType
	Defines the output type of the model. More...

typedef AbstractModel< InputType, RealVector, RealVector >	ModelBaseType
	Defines the BaseType used by the model (this type). Useful for creating derived models. More...

typedef Batch< InputType >::type	BatchInputType
	defines the batch type of the input type. More...

typedef Batch< OutputType >::type	BatchOutputType
	defines the batch type of the output type More...

typedef TypedFlags< Feature >	Features

typedef TypedFeatureNotAvailableException< Feature >	FeatureNotAvailableException

Public Types inherited from shark::IParameterizable< RealVector >
typedef RealVector	ParameterVectorType

Public Member Functions
	KernelExpansion ()

	KernelExpansion (KernelType *kernel)

	KernelExpansion (KernelType *kernel, Data< InputType > const &basis, bool offset, std::size_t outputs=1)

void	setStructure (KernelType *kernel, Data< InputType > const &basis, bool offset, std::size_t outputs=1)

std::string	name () const
	From INameable: return the class name. More...

Shape	outputShape () const
	dimensionality of the output RealVector More...

Shape	inputShape () const
	Returns the expected shape of the input. More...

KernelType const *	kernel () const

KernelType *	kernel ()

void	setKernel (KernelType *kernel)

bool	hasOffset () const

RealMatrix &	alpha ()

RealMatrix const &	alpha () const

double &	alpha (std::size_t example, std::size_t cls)

double const &	alpha (std::size_t example, std::size_t cls) const

RealVector &	offset ()

RealVector const &	offset () const

double &	offset (std::size_t cls)

double const &	offset (std::size_t cls) const

Data< InputType > const &	basis () const

Data< InputType > &	basis ()

void	sparsify ()

RealVector	parameterVector () const
	Return the parameter vector. More...

void	setParameterVector (RealVector const &newParameters)
	Set the parameter vector. More...

std::size_t	numberOfParameters () const
	Return the number of parameters. More...

boost::shared_ptr< State >	createState () const
	Creates an internal state of the model. More...

void	eval (BatchInputType const &patterns, BatchOutputType &output) const
	Standard interface for evaluating the response of the model to a batch of patterns. More...

void	eval (BatchInputType const &patterns, BatchOutputType &outputs, State &state) const
	Standard interface for evaluating the response of the model to a batch of patterns. More...

void	read (InArchive &archive)
	From ISerializable, reads a model from an archive. More...

void	write (OutArchive &archive) const
	From ISerializable, writes a model to an archive. More...

Public Member Functions inherited from shark::AbstractModel< InputType, RealVector >
	AbstractModel ()

virtual	~AbstractModel ()

const Features &	features () const

virtual void	updateFeatures ()

bool	hasFirstParameterDerivative () const
	Returns true when the first parameter derivative is implemented. More...

bool	hasFirstInputDerivative () const
	Returns true when the first input derivative is implemented. More...

virtual void	eval (InputType const &pattern, OutputType &output) const
	Standard interface for evaluating the response of the model to a single pattern. More...

Data< OutputType >	operator() (Data< InputType > const &patterns) const
	Model evaluation as an operator for a whole dataset. This is a convenience function. More...

OutputType	operator() (InputType const &pattern) const
	Model evaluation as an operator for a single pattern. This is a convenience function. More...

BatchOutputType	operator() (BatchInputType const &patterns) const
	Model evaluation as an operator for a single pattern. This is a convenience function. More...

virtual void	weightedParameterDerivative (BatchInputType const &pattern, BatchOutputType const &outputs, BatchOutputType const &coefficients, State const &state, RealVector &derivative) const
	calculates the weighted sum of derivatives w.r.t the parameters. More...

virtual void	weightedInputDerivative (BatchInputType const &pattern, BatchOutputType const &outputs, BatchOutputType const &coefficients, State const &state, BatchInputType &derivative) const
	calculates the weighted sum of derivatives w.r.t the inputs More...

virtual void	weightedDerivatives (BatchInputType const &patterns, BatchOutputType const &outputs, BatchOutputType const &coefficients, State const &state, RealVector &parameterDerivative, BatchInputType &inputDerivative) const
	calculates weighted input and parameter derivative at the same time More...

Public Member Functions inherited from shark::IParameterizable< RealVector >
virtual	~IParameterizable ()

Public Member Functions inherited from shark::INameable
virtual	~INameable ()

Public Member Functions inherited from shark::ISerializable
virtual	~ISerializable ()
	Virtual d'tor. More...

void	load (InArchive &archive, unsigned int version)
	Versioned loading of components, calls read(...). More...

void	save (OutArchive &archive, unsigned int version) const
	Versioned storing of components, calls write(...). More...

	BOOST_SERIALIZATION_SPLIT_MEMBER ()

Protected Attributes
KernelType *	mep_kernel
	kernel function used in the expansion More...

Data< InputType >	m_basis
	"support" basis vectors More...

RealMatrix	m_alpha
	kernel coefficients More...

RealVector	m_b
	offset or bias term More...

Protected Attributes inherited from shark::AbstractModel< InputType, RealVector >
Features	m_features

Detailed Description

template<class InputType>
class shark::KernelExpansion< InputType >

Linear model in a kernel feature space.

An affine linear kernel expansion is a model of the type

\[ x : \mathbb{R}^d \to \mathbb{R}^d \enspace , \enspace x \mapsto \sum_{n=1}^{\ell} \alpha_n k(x_n, x) + b \enspace ,\]

with parameters \( \alpha_n \in \mathbb{R}^{d} \) for all \( n \in \{1, \dots, \ell\} \) and \( b \in \mathbb{R}^d \).

One way in which the possibility for vector-valued input and output of dimension \( d \) may be interpreted is as allowing for a KernelExpansion model for \( d \) different classes/outputs in multi-class problems. Then, the i-th column of the matrix m_alpha is the KernelExpansion for class/output i.

Template Parameters

InputType Type of basis elements supplied to the kernel

Definition at line 67 of file KernelExpansion.h.

Member Typedef Documentation

◆ BatchInputType

template<class InputType>

typedef base_type::BatchInputType shark::KernelExpansion< InputType >::BatchInputType

Definition at line 72 of file KernelExpansion.h.

◆ BatchOutputType

template<class InputType>

typedef base_type::BatchOutputType shark::KernelExpansion< InputType >::BatchOutputType

Definition at line 73 of file KernelExpansion.h.

◆ KernelType

template<class InputType>

typedef AbstractKernelFunction<InputType> shark::KernelExpansion< InputType >::KernelType

Definition at line 70 of file KernelExpansion.h.

Constructor & Destructor Documentation

◆ KernelExpansion() [1/3]

template<class InputType>

shark::KernelExpansion< InputType >::KernelExpansion ( )

inline

Definition at line 79 of file KernelExpansion.h.

◆ KernelExpansion() [2/3]

template<class InputType>

shark::KernelExpansion< InputType >::KernelExpansion ( KernelType * kernel )

inline

Definition at line 81 of file KernelExpansion.h.

References SHARK_ASSERT.

◆ KernelExpansion() [3/3]

template<class InputType>

shark::KernelExpansion< InputType >::KernelExpansion	(	KernelType *	kernel,
		Data< InputType > const &	basis,
		bool	offset,
		std::size_t	outputs = `1`
	)

inline

Definition at line 85 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::setStructure(), and SHARK_ASSERT.

Member Function Documentation

◆ alpha() [1/4]

template<class InputType>

RealMatrix& shark::KernelExpansion< InputType >::alpha ( )

inline

Definition at line 134 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha.

Referenced by shark::AbstractBudgetMaintenanceStrategy< RealVector >::findSmallestVector(), shark::MergeBudgetMaintenanceStrategy< RealVector >::reduceBudget(), shark::Perceptron< InputType >::train(), shark::KernelSGDTrainer< InputType, CacheType >::train(), and shark::KernelBudgetedSGDTrainer< InputType, CacheType >::train().

◆ alpha() [2/4]

template<class InputType>

RealMatrix const& shark::KernelExpansion< InputType >::alpha ( ) const

inline

Definition at line 137 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha.

◆ alpha() [3/4]

template<class InputType>

double& shark::KernelExpansion< InputType >::alpha	(	std::size_t	example,
		std::size_t	cls
	)

inline

Definition at line 140 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha.

◆ alpha() [4/4]

template<class InputType>

double const& shark::KernelExpansion< InputType >::alpha	(	std::size_t	example,
		std::size_t	cls
	)		const

inline

Definition at line 143 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha.

◆ basis() [1/2]

template<class InputType>

Data<InputType> const& shark::KernelExpansion< InputType >::basis ( ) const

inline

Definition at line 168 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_basis.

Referenced by shark::RemoveBudgetMaintenanceStrategy< InputType >::addToModel(), shark::ProjectBudgetMaintenanceStrategy< RealVector >::addToModel(), shark::MergeBudgetMaintenanceStrategy< RealVector >::addToModel(), shark::MergeBudgetMaintenanceStrategy< RealVector >::reduceBudget(), and shark::KernelExpansion< InputType >::setStructure().

◆ basis() [2/2]

template<class InputType>

Data<InputType>& shark::KernelExpansion< InputType >::basis ( )

inline

Definition at line 172 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_basis.

◆ createState()

template<class InputType>

boost::shared_ptr<State> shark::KernelExpansion< InputType >::createState ( ) const

inlinevirtual

Creates an internal state of the model.

The state is needed when the derivatives are to be calculated. Eval can store a state which is then reused to speed up the calculations of the derivatives. This also allows eval to be evaluated in parallel!

Reimplemented from shark::AbstractModel< InputType, RealVector >.

Reimplemented in shark::MissingFeaturesKernelExpansion< InputType >.

Definition at line 229 of file KernelExpansion.h.

◆ eval() [1/2]

template<class InputType>

void shark::KernelExpansion< InputType >::eval	(	BatchInputType const &	patterns,
		BatchOutputType &	outputs
	)		const

inlinevirtual

Standard interface for evaluating the response of the model to a batch of patterns.

Parameters

patterns	the inputs of the model
outputs	the predictions or response of the model to every pattern

Reimplemented from shark::AbstractModel< InputType, RealVector >.

Reimplemented in shark::MissingFeaturesKernelExpansion< InputType >.

Definition at line 234 of file KernelExpansion.h.

References shark::batchSize(), shark::KernelExpansion< InputType >::hasOffset(), shark::KernelExpansion< InputType >::m_alpha, shark::KernelExpansion< InputType >::mep_kernel, and SHARK_ASSERT.

Referenced by shark::KernelExpansion< InputType >::eval().

◆ eval() [2/2]

template<class InputType>

void shark::KernelExpansion< InputType >::eval	(	BatchInputType const &	patterns,
		BatchOutputType &	outputs,
		State &	state
	)		const

inlinevirtual

Standard interface for evaluating the response of the model to a batch of patterns.

Parameters

patterns	the inputs of the model
outputs	the predictions or response of the model to every pattern
state	intermediate results stored by eval which can be reused for derivative computation.

Implements shark::AbstractModel< InputType, RealVector >.

Reimplemented in shark::MissingFeaturesKernelExpansion< InputType >.

Definition at line 259 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::eval().

◆ hasOffset()

template<class InputType>

bool shark::KernelExpansion< InputType >::hasOffset ( ) const

inline

Definition at line 131 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_b.

Referenced by shark::CSvmDerivative< InputType, CacheType >::CSvmDerivative(), shark::MissingFeaturesKernelExpansion< InputType >::eval(), shark::KernelExpansion< InputType >::eval(), shark::KernelExpansion< InputType >::numberOfParameters(), shark::KernelExpansion< InputType >::offset(), shark::KernelExpansion< InputType >::parameterVector(), and shark::MissingFeatureSvmTrainer< InputType, CacheType >::train().

◆ inputShape()

template<class InputType>

Shape shark::KernelExpansion< InputType >::inputShape ( ) const

inlinevirtual

Returns the expected shape of the input.

Implements shark::AbstractModel< InputType, RealVector >.

Definition at line 109 of file KernelExpansion.h.

◆ kernel() [1/2]

template<class InputType>

KernelType const* shark::KernelExpansion< InputType >::kernel ( ) const

inline

Definition at line 117 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::mep_kernel.

Referenced by shark::CSvmDerivative< InputType, CacheType >::CSvmDerivative(), shark::MergeBudgetMaintenanceStrategy< RealVector >::reduceBudget(), shark::KernelExpansion< InputType >::setKernel(), and shark::KernelExpansion< InputType >::setStructure().

◆ kernel() [2/2]

template<class InputType>

KernelType* shark::KernelExpansion< InputType >::kernel ( )

inline

Definition at line 120 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::mep_kernel.

◆ name()

template<class InputType>

std::string shark::KernelExpansion< InputType >::name ( ) const

inlinevirtual

From INameable: return the class name.

Reimplemented from shark::INameable.

Reimplemented in shark::MissingFeaturesKernelExpansion< InputType >.

Definition at line 101 of file KernelExpansion.h.

◆ numberOfParameters()

template<class InputType>

std::size_t shark::KernelExpansion< InputType >::numberOfParameters ( ) const

inlinevirtual

Return the number of parameters.

Reimplemented from shark::IParameterizable< RealVector >.

Definition at line 218 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::hasOffset(), shark::KernelExpansion< InputType >::m_alpha, and shark::KernelExpansion< InputType >::m_b.

Referenced by shark::KernelExpansion< InputType >::setParameterVector().

◆ offset() [1/4]

template<class InputType>

RealVector& shark::KernelExpansion< InputType >::offset ( )

inline

Definition at line 146 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::hasOffset(), shark::KernelExpansion< InputType >::m_b, and SHARK_RUNTIME_CHECK.

Referenced by shark::CSvmDerivative< InputType, CacheType >::write().

◆ offset() [2/4]

template<class InputType>

RealVector const& shark::KernelExpansion< InputType >::offset ( ) const

inline

Definition at line 150 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::hasOffset(), shark::KernelExpansion< InputType >::m_b, and SHARK_RUNTIME_CHECK.

◆ offset() [3/4]

template<class InputType>

double& shark::KernelExpansion< InputType >::offset ( std::size_t cls )

inline

Definition at line 154 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::hasOffset(), shark::KernelExpansion< InputType >::m_b, and SHARK_RUNTIME_CHECK.

◆ offset() [4/4]

template<class InputType>

double const& shark::KernelExpansion< InputType >::offset ( std::size_t cls ) const

inline

Definition at line 158 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::hasOffset(), shark::KernelExpansion< InputType >::m_b, and SHARK_RUNTIME_CHECK.

◆ outputShape()

template<class InputType>

Shape shark::KernelExpansion< InputType >::outputShape ( ) const

inlinevirtual

dimensionality of the output RealVector

Implements shark::AbstractModel< InputType, RealVector >.

Definition at line 105 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha.

Referenced by shark::CSvmDerivative< InputType, CacheType >::CSvmDerivative(), and shark::MissingFeaturesKernelExpansion< InputType >::eval().

◆ parameterVector()

template<class InputType>

RealVector shark::KernelExpansion< InputType >::parameterVector ( ) const

inlinevirtual

Return the parameter vector.

Reimplemented from shark::IParameterizable< RealVector >.

Definition at line 201 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::hasOffset().

◆ read()

template<class InputType>

void shark::KernelExpansion< InputType >::read ( InArchive & archive )

inlinevirtual

From ISerializable, reads a model from an archive.

Reimplemented from shark::AbstractModel< InputType, RealVector >.

Definition at line 268 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha, shark::KernelExpansion< InputType >::m_b, shark::KernelExpansion< InputType >::m_basis, shark::KernelExpansion< InputType >::mep_kernel, and SHARK_ASSERT.

◆ setKernel()

template<class InputType>

void shark::KernelExpansion< InputType >::setKernel ( KernelType * kernel )

inline

Definition at line 123 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::kernel(), and shark::KernelExpansion< InputType >::mep_kernel.

◆ setParameterVector()

template<class InputType>

void shark::KernelExpansion< InputType >::setParameterVector ( RealVector const & newParameters )

inlinevirtual

Set the parameter vector.

Reimplemented from shark::IParameterizable< RealVector >.

Definition at line 210 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha, shark::KernelExpansion< InputType >::numberOfParameters(), and SHARK_RUNTIME_CHECK.

◆ setStructure()

template<class InputType>

void shark::KernelExpansion< InputType >::setStructure	(	KernelType *	kernel,
		Data< InputType > const &	basis,
		bool	offset,
		std::size_t	outputs = `1`
	)

inline

Definition at line 90 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::basis(), shark::KernelExpansion< InputType >::kernel(), shark::KernelExpansion< InputType >::m_alpha, shark::KernelExpansion< InputType >::m_b, shark::KernelExpansion< InputType >::m_basis, shark::KernelExpansion< InputType >::mep_kernel, shark::Data< Type >::numberOfElements(), and SHARK_ASSERT.

Referenced by shark::KernelExpansion< InputType >::KernelExpansion(), shark::Perceptron< InputType >::train(), shark::MissingFeatureSvmTrainer< InputType, CacheType >::train(), shark::RegularizationNetworkTrainer< InputType >::train(), shark::EpsilonSvmTrainer< InputType, CacheType >::train(), shark::KernelSGDTrainer< InputType, CacheType >::train(), shark::OneClassSvmTrainer< InputType, CacheType >::train(), and shark::KernelBudgetedSGDTrainer< InputType, CacheType >::train().

◆ sparsify()

template<class InputType>

void shark::KernelExpansion< InputType >::sparsify ( )

inline

The sparsify method removes non-support-vectors from its set of basis vectors and the coefficient matrix.

Definition at line 178 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_basis, and shark::Data< Type >::numberOfElements().

◆ write()

template<class InputType>

void shark::KernelExpansion< InputType >::write ( OutArchive & archive ) const

inlinevirtual

From ISerializable, writes a model to an archive.

Reimplemented from shark::AbstractModel< InputType, RealVector >.

Definition at line 278 of file KernelExpansion.h.

References shark::KernelExpansion< InputType >::m_alpha, shark::KernelExpansion< InputType >::m_b, shark::KernelExpansion< InputType >::m_basis, shark::KernelExpansion< InputType >::mep_kernel, and SHARK_ASSERT.

Member Data Documentation

◆ m_alpha

template<class InputType>

RealMatrix shark::KernelExpansion< InputType >::m_alpha

protected

kernel coefficients

Definition at line 299 of file KernelExpansion.h.

Referenced by shark::KernelExpansion< InputType >::alpha(), shark::MissingFeaturesKernelExpansion< InputType >::eval(), shark::KernelExpansion< InputType >::eval(), shark::KernelExpansion< InputType >::numberOfParameters(), shark::KernelExpansion< InputType >::outputShape(), shark::KernelExpansion< InputType >::read(), shark::KernelExpansion< InputType >::setParameterVector(), shark::KernelExpansion< InputType >::setStructure(), and shark::KernelExpansion< InputType >::write().

◆ m_b

template<class InputType>

RealVector shark::KernelExpansion< InputType >::m_b

protected

offset or bias term

Definition at line 302 of file KernelExpansion.h.

Referenced by shark::KernelExpansion< InputType >::hasOffset(), shark::KernelExpansion< InputType >::numberOfParameters(), shark::KernelExpansion< InputType >::offset(), shark::KernelExpansion< InputType >::read(), shark::KernelExpansion< InputType >::setStructure(), and shark::KernelExpansion< InputType >::write().

◆ m_basis

template<class InputType>

Data<InputType> shark::KernelExpansion< InputType >::m_basis

protected

"support" basis vectors

Definition at line 296 of file KernelExpansion.h.

Referenced by shark::KernelExpansion< InputType >::basis(), shark::MissingFeaturesKernelExpansion< InputType >::computeNorm(), shark::MissingFeaturesKernelExpansion< InputType >::eval(), shark::KernelExpansion< InputType >::read(), shark::KernelExpansion< InputType >::setStructure(), shark::KernelExpansion< InputType >::sparsify(), and shark::KernelExpansion< InputType >::write().

◆ mep_kernel

template<class InputType>

KernelType* shark::KernelExpansion< InputType >::mep_kernel

protected

kernel function used in the expansion

Definition at line 293 of file KernelExpansion.h.

Referenced by shark::MissingFeaturesKernelExpansion< InputType >::computeNorm(), shark::MissingFeaturesKernelExpansion< InputType >::eval(), shark::KernelExpansion< InputType >::eval(), shark::KernelExpansion< InputType >::kernel(), shark::KernelExpansion< InputType >::read(), shark::KernelExpansion< InputType >::setKernel(), shark::KernelExpansion< InputType >::setStructure(), and shark::KernelExpansion< InputType >::write().

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

include/shark/Models/Kernels/KernelExpansion.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class InputType> class shark::KernelExpansion< InputType >

Member Typedef Documentation

◆ BatchInputType

◆ BatchOutputType

◆ KernelType

Constructor & Destructor Documentation

◆ KernelExpansion() [1/3]

◆ KernelExpansion() [2/3]

◆ KernelExpansion() [3/3]

Member Function Documentation

◆ alpha() [1/4]

◆ alpha() [2/4]

◆ alpha() [3/4]

◆ alpha() [4/4]

◆ basis() [1/2]

◆ basis() [2/2]

◆ createState()

◆ eval() [1/2]

◆ eval() [2/2]

◆ hasOffset()

◆ inputShape()

◆ kernel() [1/2]

◆ kernel() [2/2]

◆ name()

◆ numberOfParameters()

◆ offset() [1/4]

◆ offset() [2/4]

◆ offset() [3/4]

◆ offset() [4/4]

◆ outputShape()

◆ parameterVector()

◆ read()

◆ setKernel()

◆ setParameterVector()

◆ setStructure()

◆ sparsify()

◆ write()

Member Data Documentation

◆ m_alpha

◆ m_b

◆ m_basis

◆ mep_kernel

template<class InputType>
class shark::KernelExpansion< InputType >