MyMediaLite  3.08
Public Member Functions | Properties
ExternalItemRecommender Class Reference

Uses externally computed predictions. More...

Inheritance diagram for ExternalItemRecommender:
ItemRecommender INeedsMappings Recommender IRecommender

List of all members.

Public Member Functions

override 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
 ExternalItemRecommender ()
 Default constructor.
override void LoadModel (string filename)
 Get the model parameters from a file.
override 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)
override void SaveModel (string filename)
 Save the model parameters to a file.
override string ToString ()
 Return a string representation of the recommender.
override void Train ()
 Learn the model parameters of the recommender from the training data.

Properties

virtual IPosOnlyFeedback Feedback [get, set]
 the feedback data to be used for training
IMapping ItemMapping [get, set]
 the item mapping
int MaxItemID [get, set]
 Maximum item ID.
int MaxUserID [get, set]
 Maximum user ID.
string PredictionFile [get, set]
 the file with the stored ratings
IMapping UserMapping [get, set]
 the user mapping

Detailed Description

Uses externally computed predictions.

This recommender is for loading predictions made by external (non-MyMediaLite) recommenders, so that we can use MyMediaLite's evaluation framework to evaluate their accuracy.

This recommender does NOT support incremental updates.


Constructor & Destructor Documentation

Default constructor.


Member Function Documentation

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

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

Reimplemented from Recommender.

Object Clone ( ) [inline, inherited]

create a shallow copy of the object

override void LoadModel ( string  filename) [inline, virtual]

Get the model parameters from a file.

Parameters:
filenamethe name of the file to read from

Reimplemented from Recommender.

override float Predict ( int  user_id,
int  item_id 
) [inline, virtual]

Predict rating or score for a given user-item combination.

Parameters:
user_idthe user ID
item_idthe item ID
Returns:
the predicted score/rating for the given user-item combination

Implements Recommender.

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.

override void SaveModel ( string  filename) [inline, virtual]

Save the model parameters to a file.

Parameters:
filenamethe name of the file to write to

Reimplemented from Recommender.

override string ToString ( ) [inline]

Return a string representation of the recommender.

The ToString() method of recommenders should list the class name and all hyperparameters, separated by space characters.

Reimplemented from Recommender.


Property Documentation

virtual IPosOnlyFeedback Feedback [get, set, inherited]

the feedback data to be used for training

IMapping ItemMapping [get, set]

the item mapping

Implements INeedsMappings.

int MaxItemID [get, set, inherited]

Maximum item ID.

int MaxUserID [get, set, inherited]

Maximum user ID.

string PredictionFile [get, set]

the file with the stored ratings

IMapping UserMapping [get, set]

the user mapping

Implements INeedsMappings.


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