One-versus-one Classifier. More...
#include <shark/Models/OneVersusOneClassifier.h>
Public Types | |
typedef base_type::BatchInputType | BatchInputType |
typedef base_type::BatchOutputType | BatchOutputType |
![]() | |
enum | Feature |
typedef InputType | InputType |
Defines the input type of the model. More... | |
typedef unsigned int | 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 | |
OneVersusOneClassifier () | |
Constructor. More... | |
std::string | name () const |
From INameable: return the class name. 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... | |
unsigned int | numberOfClasses () const |
return number of classes More... | |
binary_classifier_type const & | binary (unsigned int class_one, unsigned int class_zero) const |
Obtain binary classifier. More... | |
void | addClass (std::vector< binary_classifier_type *> const &binmodels) |
Add binary classifiers for one more class to the model. More... | |
boost::shared_ptr< State > | createState () const |
Creates an internal state of the model. More... | |
void | eval (BatchInputType const &patterns, BatchOutputType &output, State &state) const |
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... | |
![]() | |
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 (BatchInputType const &patterns, BatchOutputType &outputs) const |
Standard interface for evaluating the response of the model to a batch of patterns. 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 &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 ¶meterDerivative, BatchInputType &inputDerivative) const |
calculates weighted input and parameter derivative at the same time More... | |
![]() | |
virtual | ~IParameterizable () |
![]() | |
virtual | ~INameable () |
![]() | |
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 | |
unsigned int | m_classes |
number of classes to be distinguished More... | |
std::vector< binary_classifier_type * > | m_binary |
list of binary classifiers More... | |
![]() | |
Features | m_features |
One-versus-one Classifier.
Definition at line 62 of file OneVersusOneClassifier.h.
typedef base_type::BatchInputType shark::OneVersusOneClassifier< InputType >::BatchInputType |
Definition at line 68 of file OneVersusOneClassifier.h.
typedef base_type::BatchOutputType shark::OneVersusOneClassifier< InputType >::BatchOutputType |
Definition at line 69 of file OneVersusOneClassifier.h.
|
inline |
Constructor.
Definition at line 72 of file OneVersusOneClassifier.h.
|
inline |
Add binary classifiers for one more class to the model.
The parameter binmodels holds a vector of n binary classifiers, where n is the current number of classes. The i-th model is this list is supposed to output a value of 1 for class n and a value of 0 for class i when faced with the binary classification problem of separating class i from class n. Afterwards the model can predict the n+1 classes {0, ..., n}.
Definition at line 146 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary, shark::OneVersusOneClassifier< InputType >::m_classes, and SHARK_CHECK.
Referenced by main().
|
inline |
Obtain binary classifier.
Definition at line 130 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary, shark::OneVersusOneClassifier< InputType >::m_classes, and SHARK_ASSERT.
|
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, unsigned int >.
Definition at line 153 of file OneVersusOneClassifier.h.
References shark::AbstractModel< InputType, unsigned int >::eval().
|
inlinevirtual |
One-versus-one prediction: evaluate all binary classifiers, collect their votes, and return the class with most votes.
Implements shark::AbstractModel< InputType, unsigned int >.
Definition at line 160 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary, shark::OneVersusOneClassifier< InputType >::m_classes, and shark::size().
|
inlinevirtual |
From INameable: return the class name.
Reimplemented from shark::INameable.
Definition at line 77 of file OneVersusOneClassifier.h.
|
inline |
return number of classes
Definition at line 119 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_classes.
|
inlinevirtual |
return the size of the parameter vector
Reimplemented from shark::IParameterizable.
Definition at line 110 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary.
Referenced by shark::OneVersusOneClassifier< InputType >::parameterVector().
|
inlinevirtual |
get internal parameters of the model
Reimplemented from shark::IParameterizable.
Definition at line 82 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary, and shark::OneVersusOneClassifier< InputType >::numberOfParameters().
|
inlinevirtual |
from ISerializable, reads a model from an archive
Reimplemented from shark::AbstractModel< InputType, unsigned int >.
Definition at line 199 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary, and shark::OneVersusOneClassifier< InputType >::m_classes.
|
inlinevirtual |
set internal parameters of the model
Reimplemented from shark::IParameterizable.
Definition at line 97 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary, and SHARK_CHECK.
|
inlinevirtual |
from ISerializable, writes a model to an archive
Reimplemented from shark::AbstractModel< InputType, unsigned int >.
Definition at line 206 of file OneVersusOneClassifier.h.
References shark::OneVersusOneClassifier< InputType >::m_binary, and shark::OneVersusOneClassifier< InputType >::m_classes.
|
protected |
list of binary classifiers
Definition at line 215 of file OneVersusOneClassifier.h.
Referenced by shark::OneVersusOneClassifier< InputType >::addClass(), shark::OneVersusOneClassifier< InputType >::binary(), shark::OneVersusOneClassifier< InputType >::eval(), shark::OneVersusOneClassifier< InputType >::numberOfParameters(), shark::OneVersusOneClassifier< InputType >::parameterVector(), shark::OneVersusOneClassifier< InputType >::read(), shark::OneVersusOneClassifier< InputType >::setParameterVector(), and shark::OneVersusOneClassifier< InputType >::write().
|
protected |
number of classes to be distinguished
Definition at line 214 of file OneVersusOneClassifier.h.
Referenced by shark::OneVersusOneClassifier< InputType >::addClass(), shark::OneVersusOneClassifier< InputType >::binary(), shark::OneVersusOneClassifier< InputType >::eval(), shark::OneVersusOneClassifier< InputType >::numberOfClasses(), shark::OneVersusOneClassifier< InputType >::read(), and shark::OneVersusOneClassifier< InputType >::write().