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

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

Inheritance diagram for IItemRelationAwareRecommender:
IRecommender

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

IBooleanMatrix ItemRelation [get, set]
 
int NumItems [get, set]
 

Detailed Description

Interface for recommenders that take a binary relation over items 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_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
string ToString ( )
inherited
void Train ( )
inherited

Property Documentation

IBooleanMatrix ItemRelation
getset

The binary item relation

int NumItems
getset

Number of items


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