MyMediaLite  3.01
Public Member Functions
IIncrementalItemRecommender Interface Reference

Interface for item recommenders. More...

Inheritance diagram for IIncrementalItemRecommender:
IRecommender IncrementalItemRecommender MF MostPopular BPRMF WRMF BPRMF_Mapping BPRMF_Mapping MultiCoreBPRMF SoftMarginRankingMF WeightedBPRMF BPRMF_ItemMapping BPRMF_UserMapping BPRMF_ItemMapping_Optimal BPRMF_ItemMappingKNN BPRMF_ItemMappingSVR BPRMF_UserMapping_Optimal

List of all members.

Public Member Functions

void AddFeedback (int user_id, int item_id)
 Add a positive feedback event and perform incremental training.
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.
void LoadModel (string filename)
 Get the model parameters from a file.
float Predict (int user_id, int item_id)
 Predict rating or score for a given user-item combination.
void RemoveFeedback (int user_id, int item_id)
 Remove all feedback events by the given user-item combination.
void RemoveItem (int item_id)
 Remove all feedback by one item.
void RemoveUser (int user_id)
 Remove all feedback by one user.
void SaveModel (string filename)
 Save the model parameters to a file.
string ToString ()
 Return a string representation of the recommender.
void Train ()
 Learn the model parameters of the recommender from the training data.

Detailed Description

Interface for item recommenders.

Item prediction or item recommendation is the task of predicting items (movies, books, products, videos, jokes) that a user may like, based on past user behavior (and possibly other information).

See also http://recsyswiki/wiki/Item_prediction


Member Function Documentation

void AddFeedback ( int  user_id,
int  item_id 
)

Add a positive feedback event and perform incremental training.

Parameters:
user_idthe user ID
item_idthe item ID

Implemented in BPRMF, MostPopular, and IncrementalItemRecommender.

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 RatingPredictor, Ensemble, ItemRecommender, BiPolarSlopeOne, Constant, SlopeOne, GlobalAverage, UserAverage, ItemAverage, and Random.

void LoadModel ( string  filename) [inherited]
float Predict ( int  user_id,
int  item_id 
) [inherited]
void RemoveFeedback ( int  user_id,
int  item_id 
)

Remove all feedback events by the given user-item combination.

Parameters:
user_idthe user ID
item_idthe item ID

Implemented in BPRMF, MostPopular, and IncrementalItemRecommender.

void RemoveItem ( int  item_id)

Remove all feedback by one item.

Parameters:
item_idthe item ID

Implemented in BPRMF, IncrementalItemRecommender, and MostPopular.

void RemoveUser ( int  user_id)

Remove all feedback by one user.

Parameters:
user_idthe user ID

Implemented in BPRMF, MostPopular, and IncrementalItemRecommender.

void SaveModel ( string  filename) [inherited]
string ToString ( ) [inherited]

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