MyMediaLite
3.07
|
Interface for recommenders that take a binary relation over users into account. 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. | |
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. | |
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 | |
int | NumUsers [get] |
IBooleanMatrix | UserRelation [get, set] |
Interface for recommenders that take a binary relation over users into account.
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 Ensemble, ExternalItemRecommender, ExternalRatingPredictor, BiPolarSlopeOne, Recommender, SlopeOne, Constant, 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, BPRSLIM, MatrixFactorization, BiasedMatrixFactorization, CoClustering, LeastSquareSLIM, SVDPlusPlus, BPRLinear, UserItemBaseline, FactorWiseMatrixFactorization, SigmoidCombinedAsymmetricFactorModel, SigmoidSVDPlusPlus, BiPolarSlopeOne, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, KNN, KNN, MostPopular, NaiveBayes, SlopeOne, SLIM, ItemAttributeSVM, MostPopularByAttributes, MF, EntityAverage, Recommender, Ensemble, WeightedEnsemble, GlobalAverage, ExternalItemRecommender, ExternalRatingPredictor, 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, LeastSquareSLIM, MatrixFactorization, TimeAwareBaseline, BPRMF_ItemMapping, BPRLinear, BPRMF_UserMapping, FactorWiseMatrixFactorization, GSVDPlusPlus, UserItemBaseline, CoClustering, NaiveBayes, SVDPlusPlus, ItemAttributeSVM, SLIM, SigmoidCombinedAsymmetricFactorModel, MF, MostPopularByAttributes, SigmoidSVDPlusPlus, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, Ensemble, MostPopular, BiPolarSlopeOne, ExternalItemRecommender, ExternalRatingPredictor, ItemKNN, ItemKNN, UserKNN, SlopeOne, WeightedEnsemble, Constant, UserKNN, GlobalAverage, UserAverage, ItemAverage, Recommender, Random, Random, and Zero.
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.
void SaveModel | ( | string | filename | ) | [inherited] |
Save the model parameters to a file.
filename | the name of the file to write to |
Implemented in BPRMF, BPRSLIM, MatrixFactorization, BiasedMatrixFactorization, CoClustering, LeastSquareSLIM, SVDPlusPlus, BPRLinear, UserItemBaseline, FactorWiseMatrixFactorization, BiPolarSlopeOne, SigmoidCombinedAsymmetricFactorModel, NaiveBayes, SigmoidItemAsymmetricFactorModel, SigmoidUserAsymmetricFactorModel, KNN, SlopeOne, KNN, MostPopular, SLIM, Recommender, ItemAttributeSVM, MostPopularByAttributes, MF, EntityAverage, Ensemble, WeightedEnsemble, GlobalAverage, ExternalItemRecommender, ExternalRatingPredictor, Constant, Random, 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, BPRSLIM, BPRMF_Mapping, SVDPlusPlus, MatrixFactorization, SigmoidCombinedAsymmetricFactorModel, CoClustering, SigmoidItemAsymmetricFactorModel, LeastSquareSLIM, TimeAwareBaseline, SigmoidUserAsymmetricFactorModel, LatentFeatureLogLinearModel, FactorWiseMatrixFactorization, UserItemBaseline, BPRLinear, SigmoidSVDPlusPlus, SocialMF, BPRMF_ItemMapping, BPRMF_UserMapping, KNN, NaiveBayes, KNN, MostPopular, TimeAwareBaselineWithFrequencies, WRMF, BPRMF_ItemMapping_Optimal, CLiMF, SoftMarginRankingMF, BPRMF_ItemMappingSVR, ItemAttributeSVM, Recommender, BPRMF_UserMapping_Optimal, BPRMF_ItemMappingKNN, ExternalItemRecommender, ExternalRatingPredictor, WeightedBPRMF, MultiCoreBPRMF, and Constant.
IBooleanMatrix UserRelation [get, set] |
The binary user relation
Implemented in SocialMF.