MyMediaLite
3.04
|
Abstract class for time-aware rating predictors. More...
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 |
Abstract class for time-aware rating predictors.
ArgumentException | Is thrown when an argument passed to a method is invalid. |
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.
user_id | the user ID |
item_id | the item ID |
Implements IRecommender.
Reimplemented in 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] |
Get the model parameters from a file.
filename | the name of the file to read from |
Implements IRecommender.
Reimplemented in BPRMF, MatrixFactorization, BiasedMatrixFactorization, CoClustering, SVDPlusPlus, BPRLinear, UserItemBaseline, FactorWiseMatrixFactorization, SigmoidCombinedAsymmetricFactorModel, SigmoidSVDPlusPlus, BiPolarSlopeOne, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, KNN, MostPopular, NaiveBayes, KNN, SlopeOne, ItemAttributeSVM, MostPopularByAttributes, MF, EntityAverage, GlobalAverage, Constant, Random, Random, and Zero.
abstract float Predict | ( | int | user_id, |
int | item_id | ||
) | [pure virtual, inherited] |
Predict rating or score for a given user-item combination.
user_id | the user ID |
item_id | the item ID |
Implements IRecommender.
Implemented in BPRMF, BiasedMatrixFactorization, LatentFeatureLogLinearModel, MatrixFactorization, TimeAwareBaseline, BPRMF_ItemMapping, BPRLinear, BPRMF_UserMapping, FactorWiseMatrixFactorization, UserItemBaseline, CoClustering, NaiveBayes, SVDPlusPlus, ItemAttributeSVM, SigmoidCombinedAsymmetricFactorModel, MF, MostPopularByAttributes, SigmoidSVDPlusPlus, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, MostPopular, BiPolarSlopeOne, ItemKNN, UserKNN, SlopeOne, ItemKNN, Constant, GlobalAverage, UserKNN, UserAverage, ItemAverage, Random, Random, and Zero.
abstract float Predict | ( | int | user_id, |
int | item_id, | ||
DateTime | time | ||
) | [pure virtual] |
predict rating at a certain point in time
user_id | the user ID |
item_id | the item ID |
time | the 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.
user_id | the user ID |
n | the number of items to recommend, -1 for as many as possible |
ignore_items | collection if items that should not be returned; if null, use empty collection |
candidate_items | the candidate items to choose from; if null, use all items |
Implemented in WeightedEnsemble, and Ensemble.
virtual void SaveModel | ( | string | filename | ) | [inline, virtual, inherited] |
Save the model parameters to a file.
filename | the name of the file to write to |
Implements IRecommender.
Reimplemented in BPRMF, MatrixFactorization, BiasedMatrixFactorization, CoClustering, SVDPlusPlus, BPRLinear, UserItemBaseline, FactorWiseMatrixFactorization, BiPolarSlopeOne, SigmoidCombinedAsymmetricFactorModel, NaiveBayes, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, SlopeOne, KNN, MostPopular, KNN, ItemAttributeSVM, MostPopularByAttributes, MF, EntityAverage, GlobalAverage, Constant, Random, Random, and Zero.
override string ToString | ( | ) | [inline, inherited] |
Return a string representation of the recommender.
The ToString() method of recommenders should list the class name and all hyperparameters, separated by space characters.
Implements IRecommender.
Reimplemented in BPRMF, BiasedMatrixFactorization, BPRMF_Mapping, SVDPlusPlus, MatrixFactorization, CoClustering, SigmoidCombinedAsymmetricFactorModel, SigmoidItemAsymmetricFactorModel, TimeAwareBaseline, SigmoidUserAsymmetricFactorModel, LatentFeatureLogLinearModel, FactorWiseMatrixFactorization, UserItemBaseline, BPRLinear, SigmoidSVDPlusPlus, BPRMF_ItemMapping, SocialMF, BPRMF_UserMapping, NaiveBayes, KNN, KNN, MostPopular, TimeAwareBaselineWithFrequencies, WRMF, MultiCoreBPRMF, BPRMF_ItemMapping_Optimal, CLiMF, SoftMarginRankingMF, BPRMF_ItemMappingSVR, ItemAttributeSVM, BPRMF_UserMapping_Optimal, BPRMF_ItemMappingKNN, WeightedBPRMF, and Constant.
float max_rating [protected, inherited] |
Maximum rating value.
float min_rating [protected, inherited] |
Minimum rating value.
ITimedRatings timed_ratings [protected] |
rating data, including time information
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.
The rating data.
Reimplemented from RatingPredictor.
virtual ITimedRatings TimedRatings [get, set] |
the rating data, including time information
Implements ITimeAwareRatingPredictor.