xmm::Configuration< ModelType > Class Template Reference

Model configuration. More...

#include <xmmModelConfiguration.hpp>

Inheritance diagram for xmm::Configuration< ModelType >:

Collaboration diagram for xmm::Configuration< ModelType >:

Public Member Functions
	Configuration ()
	Default Constructor. More...
	Configuration (Configuration const &src)
	Copy Constructor. More...
	Configuration (Json::Value const &root)
	Constructor from Json Structure. More...
Configuration &	operator= (Configuration const &src)
	Assignment. More...
ClassParameters< ModelType > &	operator[] (std::string label)
	access the parameters of a given class by label More...
void	reset ()
	Reset the parameters of all classes to default. More...
void	reset (std::string label)
	Reset the parameters of a given classes to default. More...
virtual Json::Value	toJson () const
	Write the object to a JSON Structure. More...
virtual void	fromJson (Json::Value const &root)
	Read the object from a JSON Structure. More...
Python File I/O
void	writeFile (char *fileName) const
	write method for python wrapping ('write' keyword forbidden, name has to be different) More...
void	readFile (char *fileName)
	read method for python wrapping ('read' keyword forbidden, name has to be different) More...
std::string	__str__ () const
	"print" method for python => returns the results of write method More...

Public Attributes
MultithreadingMode	multithreading
	Multithreading Training Mode. More...
MultiClassRegressionEstimator	multiClass_regression_estimator
	Regression mode for multiple class (prediction from likeliest class vs interpolation) More...
bool	changed
	specifies if parameters have changed (model is invalid) More...

Protected Attributes
std::map< std::string, ClassParameters< ModelType > >	class_parameters_
	Parameters for each class. More...

Friends
template<typename SingleClassModel , typename ModelType_ >
class	Model

Detailed Description

template<typename ModelType>
class xmm::Configuration< ModelType >

Model configuration.

The object contains both default parameters and class-specific parameters

Constructor & Destructor Documentation

template<typename ModelType>

xmm::Configuration< ModelType >::Configuration ( )

inline

Default Constructor.

template<typename ModelType>

xmm::Configuration< ModelType >::Configuration ( Configuration< ModelType > const &  src )

inline

Copy Constructor.

Parameters

src	Source Object

template<typename ModelType>

xmm::Configuration< ModelType >::Configuration ( Json::Value const &  root )

inlineexplicit

Constructor from Json Structure.

Parameters

root	Json Value

Member Function Documentation

std::string xmm::Writable::__str__ ( ) const

inlineinherited

"print" method for python => returns the results of write method

Warning

only defined if SWIGPYTHON is defined

template<typename ModelType>

virtual void xmm::Configuration< ModelType >::fromJson ( Json::Value const &  root )

inlinevirtual

Read the object from a JSON Structure.

Parameters

root	JSON value containing the object's information

Exceptions

JsonException

if the JSON value has a wrong format

Implements xmm::Writable.

template<typename ModelType>

Configuration& xmm::Configuration< ModelType >::operator= ( Configuration< ModelType > const &  src )

inline

Assignment.

Parameters

src	Source Object

template<typename ModelType>

ClassParameters<ModelType>& xmm::Configuration< ModelType >::operator[] ( std::string  label )

inline

access the parameters of a given class by label

If the parameters have not been edited for this class yet, they are set to the default parameters.

Parameters

label

class label

Returns

a reference to the parameters of the given class

void xmm::Writable::readFile ( char *  fileName )

inlineinherited

read method for python wrapping ('read' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

template<typename ModelType>

void xmm::Configuration< ModelType >::reset ( )

inline

Reset the parameters of all classes to default.

template<typename ModelType>

void xmm::Configuration< ModelType >::reset ( std::string  label )

inline

Reset the parameters of a given classes to default.

Parameters

label

class label

template<typename ModelType>

virtual Json::Value xmm::Configuration< ModelType >::toJson ( ) const

inlinevirtual

Write the object to a JSON Structure.

Returns

Json value containing the object's information

Implements xmm::Writable.

void xmm::Writable::writeFile ( char *  fileName ) const

inlineinherited

write method for python wrapping ('write' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

Friends And Related Function Documentation

template<typename ModelType>

template<typename SingleClassModel , typename ModelType_ >

friend class Model

friend

Member Data Documentation

template<typename ModelType>

bool xmm::ClassParameters< ModelType >::changed

inherited

specifies if parameters have changed (model is invalid)

template<typename ModelType>

std::map<std::string, ClassParameters<ModelType> > xmm::Configuration< ModelType >::class_parameters_

protected

Parameters for each class.

template<typename ModelType>

MultiClassRegressionEstimator xmm::Configuration< ModelType >::multiClass_regression_estimator

Regression mode for multiple class (prediction from likeliest class vs interpolation)

template<typename ModelType>

MultithreadingMode xmm::Configuration< ModelType >::multithreading

Multithreading Training Mode.

---

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

• xmmModelConfiguration.hpp