SoftNearestNeighborClassifier returns a probabilistic classification by looking at the k nearest neighbors. More...

#include <shark/Models/SoftNearestNeighborClassifier.h>

Inheritance diagram for shark::SoftNearestNeighborClassifier< InputType >:

Public Types
enum	DistanceWeights { UNIFORM, ONE_OVER_DISTANCE }
	Type of distance-based weights. More...

typedef AbstractNearestNeighbors< InputType, unsigned int >	NearestNeighbors

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 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 Member Functions
	SoftNearestNeighborClassifier (NearestNeighbors const *algorithm, unsigned int neighbors=3)
	Constructor. More...

	SoftNearestNeighborClassifier (NearestNeighbors const *algorithm, std::size_t numClasses, unsigned int neighbors)
	Constructor. More...

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

unsigned int	neighbors () const
	return the number of neighbors More...

void	setNeighbors (unsigned int neighbors)
	set the number of neighbors More...

DistanceWeights	getDistanceWeightType () const
	query the way distances enter as weights More...

void	setDistanceWeightType (DistanceWeights dw)
	set the way distances enter as weights More...

virtual RealVector	parameterVector () const
	get internal parameters of the model More...

virtual void	setParameterVector (RealVector const &newParameters)
	set internal parameters of the model More...

virtual std::size_t	numberOfParameters () const
	return the size of the parameter vector More...

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

void	eval (BatchInputType const &patterns, BatchOutputType &outputs) const
	soft k-nearest-neighbor prediction 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	hasSecondParameterDerivative () const
	Returns true when the second parameter derivative is implemented. More...

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

bool	hasSecondInputDerivative () const
	Returns true when the second parameter derivative is implemented. More...

bool	isSequential () const

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 &coefficients, State const &state, RealVector &derivative) const
	calculates the weighted sum of derivatives w.r.t the parameters. More...

virtual void	weightedParameterDerivative (BatchInputType const &pattern, BatchOutputType const &coefficients, Batch< RealMatrix >::type const &errorHessian, State const &state, RealVector &derivative, RealMatrix &hessian) const
	calculates the weighted sum of derivatives w.r.t the parameters More...

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

virtual void	weightedInputDerivative (BatchInputType const &pattern, BatchOutputType const &coefficients, typename Batch< RealMatrix >::type const &errorHessian, State const &state, RealMatrix &derivative, Batch< RealMatrix >::type &hessian) const
	calculates the weighted sum of derivatives w.r.t the inputs More...

virtual void	weightedDerivatives (BatchInputType const &patterns, 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
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
NearestNeighbors const *	m_algorithm

std::size_t	m_classes
	number of classes More...

unsigned int	m_neighbors
	number of neighbors to be taken into account More...

DistanceWeights	m_distanceWeights
	type of distance-based weights computation More...

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

Detailed Description

template<class InputType>
class shark::SoftNearestNeighborClassifier< InputType >

SoftNearestNeighborClassifier returns a probabilistic classification by looking at the k nearest neighbors.

For a given number C of classes, which has to be specified a priori, a C-dimensional real-valued vector is returned for each query point. Each component corresponds to a class and contains the fraction of neighbors among the K nearest neighbors that belong to the particular class.

Definition at line 54 of file SoftNearestNeighborClassifier.h.

Member Typedef Documentation

◆ BatchInputType

template<class InputType >

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

Definition at line 59 of file SoftNearestNeighborClassifier.h.

◆ BatchOutputType

template<class InputType >

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

Definition at line 60 of file SoftNearestNeighborClassifier.h.

◆ NearestNeighbors

template<class InputType >

typedef AbstractNearestNeighbors<InputType,unsigned int> shark::SoftNearestNeighborClassifier< InputType >::NearestNeighbors

Definition at line 57 of file SoftNearestNeighborClassifier.h.

Member Enumeration Documentation

◆ DistanceWeights

template<class InputType >

enum shark::SoftNearestNeighborClassifier::DistanceWeights

Type of distance-based weights.

Enumerator
UNIFORM	uniform (= no) distance-based weights
ONE_OVER_DISTANCE	weight each neighbor's label with 1/distance

Definition at line 63 of file SoftNearestNeighborClassifier.h.

Constructor & Destructor Documentation

◆ SoftNearestNeighborClassifier() [1/2]

template<class InputType >

shark::SoftNearestNeighborClassifier< InputType >::SoftNearestNeighborClassifier	(	NearestNeighbors const *	algorithm,
		unsigned int	neighbors = `3`
	)

inline

Constructor.

Parameters

algorithm	the used algorithm for nearest neighbor search
neighbors	number of neighbors

Definition at line 73 of file SoftNearestNeighborClassifier.h.

◆ SoftNearestNeighborClassifier() [2/2]

template<class InputType >

shark::SoftNearestNeighborClassifier< InputType >::SoftNearestNeighborClassifier	(	NearestNeighbors const *	algorithm,
		std::size_t	numClasses,
		unsigned int	neighbors
	)

inline

Constructor.

Parameters

algorithm	the used algorithm for nearest neighbor search
numClasses	number of classes (given explicitly, not derived from the training data)
neighbors	number of neighbors

Definition at line 85 of file SoftNearestNeighborClassifier.h.

Member Function Documentation

◆ createState()

template<class InputType >

boost::shared_ptr<State> shark::SoftNearestNeighborClassifier< 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 >.

Definition at line 133 of file SoftNearestNeighborClassifier.h.

◆ eval() [1/2]

template<class InputType >

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

inlinevirtual

soft k-nearest-neighbor prediction

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

Definition at line 138 of file SoftNearestNeighborClassifier.h.

References shark::batchSize(), shark::AbstractNearestNeighbors< InputType, LabelType >::getNeighbors(), shark::SoftNearestNeighborClassifier< InputType >::m_algorithm, shark::SoftNearestNeighborClassifier< InputType >::m_classes, shark::SoftNearestNeighborClassifier< InputType >::m_distanceWeights, shark::SoftNearestNeighborClassifier< InputType >::m_neighbors, shark::SoftNearestNeighborClassifier< InputType >::neighbors(), remora::row(), shark::SoftNearestNeighborClassifier< InputType >::UNIFORM, and w.

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

◆ eval() [2/2]

template<class InputType >

void shark::SoftNearestNeighborClassifier< 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 >.

Definition at line 165 of file SoftNearestNeighborClassifier.h.

References shark::SoftNearestNeighborClassifier< InputType >::eval(), and shark::AbstractModel< InputType, RealVector >::eval().