MyMediaLite  3.08
Public Member Functions | Protected Attributes | Properties
TimeAwareRatingPredictor Class Reference

Abstract class for time-aware rating predictors. More...

Inheritance diagram for TimeAwareRatingPredictor:
RatingPredictor ITimeAwareRatingPredictor Recommender IRatingPredictor IRatingPredictor IRecommender IRecommender IRecommender TimeAwareBaseline TimeAwareBaselineWithFrequencies

List of all members.

Public Member Functions

virtual 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
virtual void LoadModel (string file)
 Get the model parameters from a file.
abstract float Predict (int user_id, int item_id)
 Predict rating or score for a given user-item combination.
abstract float Predict (int user_id, int item_id, DateTime time)
 predict rating at a certain point in time
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)
virtual void SaveModel (string file)
 Save the model parameters to a file.
override string ToString ()
 Return a string representation of the recommender.
abstract void Train ()
 Learn the model parameters of the recommender from the training data.

Protected Attributes

float max_rating
 Maximum rating value.
float min_rating
 Minimum rating value.
IRatings ratings
 rating data
ITimedRatings timed_ratings
 rating data, including time information

Properties

int MaxItemID [get, set]
 Maximum item ID.
virtual float MaxRating [get, set]
 Maximum rating value.
int MaxUserID [get, set]
 Maximum user ID.
virtual float MinRating [get, set]
 Minimum rating value.
override IRatings Ratings [get, set]
 The rating data.
virtual ITimedRatings TimedRatings [get, set]
 the rating data, including time information

Detailed Description

Abstract class for time-aware rating predictors.

Exceptions:
ArgumentExceptionIs thrown when an argument passed to a method is invalid.

Member Function Documentation

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

Implements IRecommender.

Reimplemented in ExternalItemRecommender, ExternalRatingPredictor, BiPolarSlopeOne, SlopeOne, Constant, GlobalAverage, UserAverage, ItemAverage, and Random.

Object Clone ( ) [inline, inherited]

create a shallow copy of the object

virtual void LoadModel ( string  filename) [inline, virtual, inherited]
abstract float Predict ( int  user_id,
int  item_id 
) [pure virtual, inherited]
abstract float Predict ( int  user_id,
int  item_id,
DateTime  time 
) [pure virtual]

predict rating at a certain point in time

Parameters:
user_idthe user ID
item_idthe item ID
timethe time of the rating event

Implements ITimeAwareRatingPredictor.

Implemented in TimeAwareBaseline, and TimeAwareBaselineWithFrequencies.

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.

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

Member Data Documentation

float max_rating [protected, inherited]

Maximum rating value.

float min_rating [protected, inherited]

Minimum rating value.

IRatings ratings [protected, inherited]

rating data

rating data, including time information


Property Documentation

int MaxItemID [get, set, inherited]

Maximum item ID.

virtual float MaxRating [get, set, inherited]

Maximum rating value.

Implements IRatingPredictor.

int MaxUserID [get, set, inherited]

Maximum user ID.

virtual float MinRating [get, set, inherited]

Minimum rating value.

Implements IRatingPredictor.

override IRatings Ratings [get, set]

The rating data.

Reimplemented from RatingPredictor.

virtual ITimedRatings TimedRatings [get, set]

the rating data, including time information

Implements ITimeAwareRatingPredictor.


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