IUserRelationAwareRecommender Interface Reference

Interface for recommenders that take a binary relation over users into account. More...

Inheritance diagram for IUserRelationAwareRecommender:
IRecommender SocialMF

List of all members.

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.
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 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.

Properties

int NumUsers [get]
SparseBooleanMatrix UserRelation [get, set]

Detailed Description

Interface for recommenders that take a binary relation over users into account.


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

Implemented in Ensemble, ItemRecommender, BiPolarSlopeOne, Constant, GlobalAverage, ItemAverage, Random, RatingPredictor, SlopeOne, and UserAverage.

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

Property Documentation

int NumUsers [get]

Number of users

Implemented in SocialMF.

SparseBooleanMatrix UserRelation [get, set]

The binary user relation

Implemented in SocialMF.


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