iCub::learningmachine::TrainModule Class Reference

A module for training. More...

#include <TrainModule.h>

Inheritance diagram for iCub::learningmachine::TrainModule:

Public Member Functions
	TrainModule (std::string pp="/lm/train")
	Constructor.
virtual	~TrainModule ()
	Destructor (empty).
virtual bool	configure (yarp::os::ResourceFinder &opt)
virtual bool	interruptModule ()
virtual bool	respond (const yarp::os::Bottle &cmd, yarp::os::Bottle &reply)
Public Member Functions inherited from iCub::learningmachine::PredictModule
	PredictModule (std::string pp="/lm/predict")
	Constructor.
virtual	~PredictModule ()
	Destructor (empty).
virtual bool	close ()
	Close the module.
virtual IMachineLearner &	getMachine ()
	Retrieve the machine that is wrapped in the portable machine wrapper.
virtual MachinePortable &	getMachinePortable ()
	Retrieve the machine portable.
Public Member Functions inherited from iCub::learningmachine::IMachineLearnerModule
	IMachineLearnerModule (std::string pp)
	Constructor.
virtual	~IMachineLearnerModule ()
	Destructor (empty).
virtual bool	updateModule ()
	Default empty update loop with 1 second delay.

Additional Inherited Members
Protected Member Functions inherited from iCub::learningmachine::PredictModule
	PredictModule (const PredictModule &other)
	Copy constructor (private and unimplemented on purpose).
PredictModule &	operator= (const PredictModule &other)
	Assignment operator (private and unimplemented on purpose).
Protected Member Functions inherited from iCub::learningmachine::IMachineLearnerModule
	IMachineLearnerModule (const IMachineLearnerModule &other)
	Copy Constructor (private and unimplemented on purpose).
IMachineLearnerModule &	operator= (const IMachineLearnerModule &other)
	Assignment operator (private and unimplemented on purpose).
void	registerPort (yarp::os::Contactable &port, std::string name)
	Register a port with a given name.
virtual void	loadCommandFile (std::string fname, yarp::os::Bottle *out=(yarp::os::Bottle *) 0)
	Reads bottles from a file and sends these one by one to the respond method.
virtual yarp::os::ResourceFinder &	getResourceFinder ()
	Returns a reference to the cached ResourceFinder.
std::string	findFile (std::string fname)
	Finds the full path to a specified filename using the ResourceFinder.
virtual void	setResourceFinder (yarp::os::ResourceFinder *rf)
	Mutator for the locally stored ResourceFinder.
Protected Attributes inherited from iCub::learningmachine::PredictModule
yarp::os::BufferedPort< yarp::sig::Vector >	predict_inout
	Buffered port for the incoming samples and corresponding replies.
MachinePortable	machinePortable
	A concrete wrapper around a learning machine.
PredictProcessor	predictProcessor
	The processor handling prediction requests.
yarp::os::Port	model_in
	Incoming port for the models from the train module.
Protected Attributes inherited from iCub::learningmachine::IMachineLearnerModule
yarp::os::Port	cmd_in
	An input port for commands.
std::string	portPrefix
	A prefix path for the ports that will be registered.
DispatcherManager	dmanager
	An instance of the DispatchManager to configure event listeners.
yarp::os::ResourceFinder *	rf
	A pointer to the ResourceFinder.

Detailed Description

A module for training.

The module can contain any iCub::learningmachine::IMachineLearner This module is inspired by the original Learner module by Francesco Orabona and Paul Fitzpatrick.

See also

iCub::learningmachine::IMachineLearner

iCub::learningmachine::IMachineLearnerModule

iCub::learningmachine::PredictModule

iCub::learningmachine::Learner

Author

Arjan Gijsberts, Francesco Orabona, Paul Fitzpatrick

Definition at line 90 of file TrainModule.h.

Constructor & Destructor Documentation

TrainModule()

iCub::learningmachine::TrainModule::TrainModule ( std::string  pp = "/lm/train" )

inline

Constructor.

Parameters

pp	the default prefix used for the ports.
support	an instance of the Support class.

Definition at line 144 of file TrainModule.h.

~TrainModule()

virtual iCub::learningmachine::TrainModule::~TrainModule ( )

inlinevirtual

Destructor (empty).

Definition at line 150 of file TrainModule.h.

Member Function Documentation

configure()

bool iCub::learningmachine::TrainModule::configure ( yarp::os::ResourceFinder &  opt )

virtual

Reimplemented from iCub::learningmachine::PredictModule.

Definition at line 101 of file TrainModule.cpp.

interruptModule()

bool iCub::learningmachine::TrainModule::interruptModule ( )

virtual

Reimplemented from iCub::learningmachine::PredictModule.

Definition at line 95 of file TrainModule.cpp.

respond()

bool iCub::learningmachine::TrainModule::respond ( const yarp::os::Bottle &  cmd, yarp::os::Bottle &  reply  )

virtual

Reimplemented from iCub::learningmachine::PredictModule.

Definition at line 174 of file TrainModule.cpp.

---

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

• icub-main/src/modules/learningMachine/include/iCub/learningMachine/TrainModule.h
• icub-main/src/modules/learningMachine/src/TrainModule.cpp