MyMediaLite
3.01
|
Interface for rating predictors. More...
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 | |
float | MaxRating [get, set] |
Gets or sets the maximum rating. | |
float | MinRating [get, set] |
Gets or sets the minimum rating. | |
IRatings | Ratings [get, set] |
the ratings to learn from |
Interface for rating predictors.
Rating prediction is used in systems that let users rate items (e.g. movies, books, songs, etc.) on a certain scale, e.g. from 1 to 5 stars, where 1 star means the user does not like the item at all, and 5 stars mean the user likes the item very much.
Given an (incomplete) set of ratings for several items by several users (and maybe additional information), the task is to predict (some of the) missing ratings.
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.
user_id | the user ID |
item_id | the item ID |
Implemented in RatingPredictor, Ensemble, ItemRecommender, BiPolarSlopeOne, Constant, SlopeOne, GlobalAverage, UserAverage, ItemAverage, and Random.
void LoadModel | ( | string | filename | ) | [inherited] |
Get the model parameters from a file.
filename | the name of the file to read from |
Implemented in BPRMF, MatrixFactorization, BiasedMatrixFactorization, CoClustering, SVDPlusPlus, BPRLinear, FactorWiseMatrixFactorization, UserItemBaseline, SigmoidCombinedAsymmetricFactorModel, SigmoidSVDPlusPlus, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, BiPolarSlopeOne, ItemKNN, SlopeOne, ItemAttributeSVM, MF, MostPopularByAttributes, MostPopular, EntityAverage, KNN, Ensemble, GlobalAverage, ItemRecommender, WeightedEnsemble, RatingPredictor, KNN, Constant, Random, Random, and Zero.
float Predict | ( | int | user_id, |
int | item_id | ||
) | [inherited] |
Predict rating or score for a given user-item combination.
user_id | the user ID |
item_id | the item ID |
Implemented in BPRMF, BiasedMatrixFactorization, LatentFeatureLogLinearModel, TimeAwareBaseline, BPRMF_ItemMapping, MatrixFactorization, BPRLinear, BPRMF_UserMapping, FactorWiseMatrixFactorization, UserItemBaseline, CoClustering, SVDPlusPlus, SigmoidCombinedAsymmetricFactorModel, ItemAttributeSVM, SigmoidSVDPlusPlus, MF, MostPopularByAttributes, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, Ensemble, BiPolarSlopeOne, ItemRecommender, RatingPredictor, SlopeOne, ItemKNN, WeightedEnsemble, MostPopular, Constant, UserKNN, GlobalAverage, UserKNN, ItemKNN, UserAverage, ItemAverage, Random, WeightedItemKNN, Random, WeightedUserKNN, and Zero.
void SaveModel | ( | string | filename | ) | [inherited] |
Save the model parameters to a file.
filename | the name of the file to write to |
Implemented in BPRMF, MatrixFactorization, BiasedMatrixFactorization, CoClustering, SVDPlusPlus, BPRLinear, FactorWiseMatrixFactorization, UserItemBaseline, SigmoidCombinedAsymmetricFactorModel, BiPolarSlopeOne, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, SlopeOne, ItemAttributeSVM, MostPopularByAttributes, MF, EntityAverage, MostPopular, ItemRecommender, Ensemble, KNN, GlobalAverage, RatingPredictor, WeightedEnsemble, Constant, Random, KNN, Random, and Zero.
string ToString | ( | ) | [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.
Implemented in BPRMF, BiasedMatrixFactorization, BPRMF_Mapping, SVDPlusPlus, MatrixFactorization, CoClustering, SigmoidCombinedAsymmetricFactorModel, SigmoidItemAsymmetricFactorModel, TimeAwareBaseline, SigmoidUserAsymmetricFactorModel, LatentFeatureLogLinearModel, FactorWiseMatrixFactorization, SigmoidSVDPlusPlus, BPRLinear, UserItemBaseline, BPRMF_ItemMapping, SocialMF, BPRMF_UserMapping, TimeAwareBaselineWithFrequencies, WRMF, MultiCoreBPRMF, BPRMF_ItemMapping_Optimal, BPRMF_ItemMappingSVR, SoftMarginRankingMF, ItemAttributeSVM, BPRMF_UserMapping_Optimal, BPRMF_ItemMappingKNN, WeightedBPRMF, ItemRecommender, RatingPredictor, ItemKNN, UserKNN, UserAttributeKNN, UserKNNCosine, Constant, UserKNNPearson, ItemAttributeKNN, ItemAttributeKNN, UserAttributeKNN, WeightedItemKNN, ItemKNNPearson, WeightedUserKNN, and ItemKNNCosine.
float MaxRating [get, set] |
float MinRating [get, set] |
the ratings to learn from
Implemented in KNN, FactorWiseMatrixFactorization, RatingPredictor, TimeAwareRatingPredictor, ItemKNN, and UserKNN.