Ensemble Class Reference

Abtract class for combining several prediction methods. More...

Inheritance diagram for Ensemble:
IRecommender WeightedEnsemble

List of all members.

Public Member Functions

virtual bool CanPredict (int user_id, int item_id)
 Check whether a useful prediction (i.e. not using a fallback/default answer) can be made for a given user-item combination.
Object Clone ()
 create a shallow copy of the object
abstract void LoadModel (string file)
 Get the model parameters from a file.
abstract float Predict (int user_id, int item_id)
 Predict rating or score for a given user-item combination.
abstract void SaveModel (string file)
 Save the model parameters to a file.
string ToString ()
 Return a string representation of the recommender.
virtual void Train ()
 Learn the model parameters of the recommender from the training data.

Public Attributes

List< IRecommenderrecommenders = new List<IRecommender>()
 list of recommenders

Properties

float MaxRating [get, set]
 The max rating value.
float MinRating [get, set]
 The min rating value.

Detailed Description

Abtract class for combining several prediction methods.


Member Function Documentation

virtual bool CanPredict ( int  user_id,
int  item_id 
) [inline, virtual]

Check whether a useful prediction (i.e. not using a fallback/default answer) can be made for a given user-item combination.

It is up to the recommender implementor to decide when a prediction is useful, and to document it accordingly.

Parameters:
user_id the user ID
item_id the item ID
Returns:
true if a useful prediction can be made, false otherwise

Implements IRecommender.

Object Clone (  )  [inline]

create a shallow copy of the object

abstract void LoadModel ( string  filename  )  [pure virtual]

Get the model parameters from a file.

Parameters:
filename the name of the file to read from

Implements IRecommender.

Implemented in WeightedEnsemble.

abstract float Predict ( int  user_id,
int  item_id 
) [pure virtual]

Predict rating or score for a given user-item combination.

Parameters:
user_id the user ID
item_id the item ID
Returns:
the predicted score/rating for the given user-item combination

Implements IRecommender.

Implemented in WeightedEnsemble.

abstract void SaveModel ( string  filename  )  [pure virtual]

Save the model parameters to a file.

Parameters:
filename the name of the file to write to

Implements IRecommender.

Implemented in WeightedEnsemble.

string ToString (  )  [inherited]

Member Data Documentation

List<IRecommender> recommenders = new List<IRecommender>()

list of recommenders


Property Documentation

float MaxRating [get, set]

The max rating value.

The max rating value

float MinRating [get, set]

The min rating value.

The min rating value


The documentation for this class was generated from the following file:
Generated on Thu Apr 5 01:11:32 2012 for MyMediaLite by  doxygen 1.6.3