MyMediaLite  3.03
Public Member Functions | Protected Member Functions | Protected Attributes | Properties
IncrementalRatingPredictor Class Reference

Base class for rating predictors that support incremental training. More...

Inheritance diagram for IncrementalRatingPredictor:
RatingPredictor IIncrementalRatingPredictor Recommender IRatingPredictor IRatingPredictor IIncrementalRecommender IRecommender IRecommender IRecommender Constant EntityAverage GlobalAverage KNN MatrixFactorization NaiveBayes Random UserItemBaseline

List of all members.

Public Member Functions

virtual void AddRatings (IRatings new_ratings)
 Add new ratings and perform incremental training.
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
 IncrementalRatingPredictor ()
 Default constructor.
virtual 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.
IList< Tuple< int, float > > Recommend (int user_id, int n=-1, ICollection< int > ignore_items=null, ICollection< int > candidate_items=null)
 Recommend items for a given user.
virtual
System.Collections.Generic.IList
< Tuple< int, float > > 
Recommend (int user_id, int n=-1, System.Collections.Generic.ICollection< int > ignore_items=null, System.Collections.Generic.ICollection< int > candidate_items=null)
virtual void RemoveItem (int item_id)
 Remove all feedback by one item.
virtual void RemoveRatings (IDataSet ratings_to_delete)
 Remove existing ratings and perform "incremental" training.
virtual void RemoveUser (int user_id)
 Remove all feedback by one user.
virtual void SaveModel (string file)
 Save the model parameters to a file.
override string ToString ()
 Return a string representation of the recommender.
abstract void Train ()
 Learn the model parameters of the recommender from the training data.
virtual void UpdateRatings (IRatings new_ratings)
 Update existing ratings and perform incremental training.

Protected Member Functions

virtual void AddItem (int item_id)
virtual void AddUser (int user_id)

Protected Attributes

float max_rating
 Maximum rating value.
float min_rating
 Minimum rating value.
IRatings ratings
 rating data

Properties

int MaxItemID [get, set]
 Maximum item ID.
virtual float MaxRating [get, set]
 Maximum rating value.
int MaxUserID [get, set]
 Maximum user ID.
virtual float MinRating [get, set]
 Minimum rating value.
virtual IRatings Ratings [get, set]
 The rating data.
bool UpdateItems [get, set]
 true if items shall be updated when doing incremental updates
bool UpdateUsers [get, set]
 true if users shall be updated when doing incremental updates

Detailed Description

Base class for rating predictors that support incremental training.


Constructor & Destructor Documentation

Default constructor.


Member Function Documentation

virtual void AddRatings ( IRatings  ratings) [inline, virtual]

Add new ratings and perform incremental training.

Parameters:
ratingsthe ratings

Implements IIncrementalRatingPredictor.

Reimplemented in MatrixFactorization, UserItemBaseline, NaiveBayes, ItemKNN, UserKNN, UserAverage, GlobalAverage, and ItemAverage.

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

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_idthe user ID
item_idthe item ID
Returns:
true if a useful prediction can be made, false otherwise

Implements IRecommender.

Reimplemented in BiPolarSlopeOne, SlopeOne, Constant, GlobalAverage, UserAverage, ItemAverage, and Random.

Object Clone ( ) [inline, inherited]

create a shallow copy of the object

virtual void LoadModel ( string  filename) [inline, virtual, inherited]
abstract float Predict ( int  user_id,
int  item_id 
) [pure virtual, inherited]
IList<Tuple<int, float> > Recommend ( int  user_id,
int  n = -1,
ICollection< int >  ignore_items = null,
ICollection< int >  candidate_items = null 
) [inherited]

Recommend items for a given user.

Parameters:
user_idthe user ID
nthe number of items to recommend, -1 for as many as possible
ignore_itemscollection if items that should not be returned; if null, use empty collection
candidate_itemsthe candidate items to choose from; if null, use all items
Returns:
a sorted list of (item_id, score) tuples

Implemented in WeightedEnsemble, and Ensemble.

virtual void RemoveItem ( int  item_id) [inline, virtual]

Remove all feedback by one item.

Parameters:
item_idthe item ID

Implements IIncrementalRecommender.

Reimplemented in BiasedMatrixFactorization, MatrixFactorization, and ItemAverage.

virtual void RemoveRatings ( IDataSet  ratings) [inline, virtual]

Remove existing ratings and perform "incremental" training.

Parameters:
ratingsthe user and item IDs of the ratings to be removed

Implements IIncrementalRatingPredictor.

Reimplemented in MatrixFactorization, UserItemBaseline, NaiveBayes, ItemKNN, UserKNN, UserAverage, ItemAverage, and GlobalAverage.

virtual void RemoveUser ( int  user_id) [inline, virtual]

Remove all feedback by one user.

Parameters:
user_idthe user ID

Implements IIncrementalRecommender.

Reimplemented in BiasedMatrixFactorization, MatrixFactorization, and UserAverage.

virtual void SaveModel ( string  filename) [inline, virtual, inherited]
override string ToString ( ) [inline, inherited]
virtual void UpdateRatings ( IRatings  ratings) [inline, virtual]

Update existing ratings and perform incremental training.

Parameters:
ratingsthe ratings

Implements IIncrementalRatingPredictor.

Reimplemented in MatrixFactorization, UserItemBaseline, NaiveBayes, ItemKNN, UserKNN, UserAverage, GlobalAverage, and ItemAverage.


Member Data Documentation

float max_rating [protected, inherited]

Maximum rating value.

float min_rating [protected, inherited]

Minimum rating value.

IRatings ratings [protected, inherited]

rating data


Property Documentation

int MaxItemID [get, set, inherited]

Maximum item ID.

virtual float MaxRating [get, set, inherited]

Maximum rating value.

Implements IRatingPredictor.

int MaxUserID [get, set, inherited]

Maximum user ID.

virtual float MinRating [get, set, inherited]

Minimum rating value.

Implements IRatingPredictor.

virtual IRatings Ratings [get, set, inherited]

The rating data.

Implements IRatingPredictor.

Reimplemented in KNN, FactorWiseMatrixFactorization, TimeAwareRatingPredictor, ItemKNN, and UserKNN.

bool UpdateItems [get, set]

true if items shall be updated when doing incremental updates

Set to false if you do not want any updates to the item model parameters when doing incremental updates.

Implements IIncrementalRecommender.

bool UpdateUsers [get, set]

true if users shall be updated when doing incremental updates

Default should be true. Set to false if you do not want any updates to the user model parameters when doing incremental updates.

Implements IIncrementalRecommender.


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