MyMediaLite  3.11
Public Member Functions | Properties | List of all members
IFoldInRatingPredictor Interface Reference

Rating predictor that allows folding in new users More...

Inheritance diagram for IFoldInRatingPredictor:
IRatingPredictor IRecommender ItemKNN MatrixFactorization UserAverage UserKNN ItemAttributeKNN BiasedMatrixFactorization SVDPlusPlus UserAttributeKNN SigmoidCombinedAsymmetricFactorModel SigmoidItemAsymmetricFactorModel SigmoidUserAsymmetricFactorModel SocialMF GSVDPlusPlus SigmoidSVDPlusPlus

Public Member Functions

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 More...
 
void LoadModel (string filename)
 Get the model parameters from a file More...
 
float Predict (int user_id, int item_id)
 Predict rating or score for a given user-item combination More...
 
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 More...
 
void SaveModel (string filename)
 Save the model parameters to a file More...
 
IList< Tuple< int, float > > ScoreItems (IList< Tuple< int, float >> rated_items, IList< int > candidate_items)
 Rate a list of items given a list of ratings that represent a new user More...
 
string ToString ()
 Return a string representation of the recommender More...
 
void Train ()
 Learn the model parameters of the recommender from the training data More...
 

Properties

float MaxRating [get, set]
 Gets or sets the maximum rating. More...
 
float MinRating [get, set]
 Gets or sets the minimum rating. More...
 
IRatings Ratings [get, set]
 the ratings to learn from More...
 

Detailed Description

Rating predictor that allows folding in new users

The process of folding in is computing a predictive model for a new user based on their ratings and the existing recommender, without modifying the parameters of the existing recommender.

Literature:

Member Function Documentation

bool CanPredict ( int  user_id,
int  item_id 
)
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

Implemented in Ensemble, ExternalItemRecommender, ExternalRatingPredictor, BiPolarSlopeOne, Recommender, SlopeOne, Constant, GlobalAverage, UserAverage, ItemAverage, and Random.

void LoadModel ( string  filename)
inherited
float Predict ( int  user_id,
int  item_id 
)
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.

void SaveModel ( string  filename)
inherited
IList<Tuple<int, float> > ScoreItems ( IList< Tuple< int, float >>  rated_items,
IList< int >  candidate_items 
)

Rate a list of items given a list of ratings that represent a new user

Returns
a list of int and float pairs, representing item IDs and predicted ratings
Parameters
rated_itemsthe ratings (item IDs and rating values) representing the new user
candidate_itemsthe items to be rated

Implemented in MatrixFactorization, UserKNN, ItemKNN, and UserAverage.

string ToString ( )
inherited
void Train ( )
inherited

Property Documentation

float MaxRating
getsetinherited

Gets or sets the maximum rating.

The maximally possible rating

float MinRating
getsetinherited

Gets or sets the minimum rating.

The minimally possible rating

IRatings Ratings
getsetinherited

the ratings to learn from


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