Weighted kNN recommender based on user attributes. More...
Public Member Functions | |
override void | AddRatings (IRatings ratings) |
Add new ratings and perform incremental training. | |
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 | |
IList< int > | GetMostSimilarUsers (int user_id, uint n=10) |
get the most similar users | |
float | GetUserSimilarity (int user_id1, int user_id2) |
get the similarity between two users | |
override void | LoadModel (string filename) |
Get the model parameters from a file. | |
override float | Predict (int user_id, int item_id) |
Predict the rating of a given user for a given item. | |
virtual void | RemoveItem (int item_id) |
Remove an item from the recommender model, and delete all ratings of this item. | |
override void | RemoveRatings (IDataSet ratings) |
Remove existing ratings and perform "incremental" training. | |
virtual void | RemoveUser (int user_id) |
Remove a user from the recommender model, and delete all their ratings. | |
override void | SaveModel (string filename) |
Save the model parameters to a file. | |
IList< Pair< int, float > > | ScoreItems (IList< Pair< int, float >> rated_items, IList< int > candidate_items) |
Rate a list of items given a list of ratings that represent a new user. | |
override string | ToString () |
Return a string representation of the recommender. | |
override void | Train () |
Learn the model parameters of the recommender from the training data. | |
override void | UpdateRatings (IRatings ratings) |
Update existing ratings and perform incremental training. | |
Protected Member Functions | |
virtual void | AddItem (int item_id) |
override void | AddUser (int user_id) |
override IList< float > | FoldIn (IList< Pair< int, float >> rated_items) |
Fold in one user, identified by their ratings. | |
override void | RetrainUser (int user_id) |
Retrain model for a given user. | |
Protected Attributes | |
UserItemBaseline | baseline_predictor = new UserItemBaseline() { RegU = 10, RegI = 5 } |
underlying baseline predictor | |
CorrelationMatrix | correlation |
Correlation matrix over some kind of entity. | |
SparseBooleanMatrix | data_user |
boolean matrix indicating which user rated which item | |
float | max_rating |
Maximum rating value. | |
float | min_rating |
Minimum rating value. | |
IRatings | ratings |
rating data | |
Properties | |
uint | K [get, set] |
Number of neighbors to take into account for predictions. | |
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. | |
int | NumUserAttributes [get, set] |
override IRatings | Ratings [set] |
The rating data. | |
float | RegI [get, set] |
regularization constant for the item bias of the underlying baseline predictor | |
float | RegU [get, set] |
regularization constant for the user bias of the underlying baseline predictor | |
bool | UpdateItems [get, set] |
true if items shall be updated when doing incremental updates | |
bool | UpdateUsers [get, set] |
true if users shall be updated when doing incremental updates | |
SparseBooleanMatrix | UserAttributes [get, set] |
Weighted kNN recommender based on user attributes.
This recommender does NOT support incremental updates.
override void AddRatings | ( | IRatings | ratings | ) | [inline, virtual, inherited] |
Add new ratings and perform incremental training.
ratings | the ratings |
Reimplemented from IncrementalRatingPredictor.
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, Constant, GlobalAverage, ItemAverage, Random, SlopeOne, and UserAverage.
Object Clone | ( | ) | [inline, inherited] |
create a shallow copy of the object
override IList<float> FoldIn | ( | IList< Pair< int, float >> | rated_items | ) | [inline, protected, virtual] |
Fold in one user, identified by their ratings.
rated_items | the ratings to take into account |
Implements UserKNN.
IList<int> GetMostSimilarUsers | ( | int | user_id, | |
uint | n = 10 | |||
) | [inline, inherited] |
get the most similar users
user_id | the ID of the user | |
n | the number of similar users to return |
Implements IUserSimilarityProvider.
float GetUserSimilarity | ( | int | user_id1, | |
int | user_id2 | |||
) | [inline, inherited] |
get the similarity between two users
user_id1 | the ID of the first user | |
user_id2 | the ID of the second user |
Implements IUserSimilarityProvider.
override void LoadModel | ( | string | filename | ) | [inline, virtual, inherited] |
Get the model parameters from a file.
filename | the name of the file to read from |
Reimplemented from RatingPredictor.
Reimplemented in ItemKNN.
override float Predict | ( | int | user_id, | |
int | item_id | |||
) | [inline, inherited] |
Predict the rating of a given user for a given item.
If the user or the item are not known to the recommender, a suitable average rating is returned. To avoid this behavior for unknown entities, use CanPredict() to check before.
user_id | the user ID | |
item_id | the item ID |
Implements IRecommender.
virtual void RemoveItem | ( | int | item_id | ) | [inline, virtual, inherited] |
Remove an item from the recommender model, and delete all ratings of this item.
It is up to the recommender implementor whether there should be model updates after this action, both options are valid.
item_id | the ID of the user to be removed |
Implements IIncrementalRatingPredictor.
Reimplemented in BiasedMatrixFactorization, ItemAverage, and MatrixFactorization.
override void RemoveRatings | ( | IDataSet | ratings | ) | [inline, virtual, inherited] |
Remove existing ratings and perform "incremental" training.
ratings | the user and item IDs of the ratings to be removed |
Reimplemented from IncrementalRatingPredictor.
virtual void RemoveUser | ( | int | user_id | ) | [inline, virtual, inherited] |
Remove a user from the recommender model, and delete all their ratings.
It is up to the recommender implementor whether there should be model updates after this action, both options are valid.
user_id | the ID of the user to be removed |
Implements IIncrementalRatingPredictor.
Reimplemented in BiasedMatrixFactorization, MatrixFactorization, and UserAverage.
override void RetrainUser | ( | int | user_id | ) | [inline, protected, virtual] |
override void SaveModel | ( | string | filename | ) | [inline, virtual, inherited] |
Save the model parameters to a file.
filename | the name of the file to write to |
Reimplemented from RatingPredictor.
IList<Pair<int, float> > ScoreItems | ( | IList< Pair< int, float >> | rated_items, | |
IList< int > | candidate_items | |||
) | [inline, inherited] |
Rate a list of items given a list of ratings that represent a new user.
rated_items | the ratings (item IDs and rating values) representing the new user | |
candidate_items | the items to be rated |
Implements IFoldInRatingPredictor.
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.
Implements IRecommender.
override void UpdateRatings | ( | IRatings | ratings | ) | [inline, virtual, inherited] |
Update existing ratings and perform incremental training.
ratings | the ratings |
Reimplemented from IncrementalRatingPredictor.
UserItemBaseline baseline_predictor = new UserItemBaseline() { RegU = 10, RegI = 5 } [protected, inherited] |
underlying baseline predictor
CorrelationMatrix correlation [protected, inherited] |
Correlation matrix over some kind of entity.
SparseBooleanMatrix data_user [protected, inherited] |
boolean matrix indicating which user rated which item
float max_rating [protected, inherited] |
Maximum rating value.
float min_rating [protected, inherited] |
Minimum rating value.
uint K [get, set, inherited] |
Number of neighbors to take into account for predictions.
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.
int NumUserAttributes [get, set] |
Number of binary user attributes
Implements IUserAttributeAwareRecommender.
float RegI [get, set, inherited] |
regularization constant for the item bias of the underlying baseline predictor
float RegU [get, set, inherited] |
regularization constant for the user bias of the underlying baseline predictor
bool UpdateItems [get, set, inherited] |
true if items shall be updated when doing incremental updates
Default should true. Set to false if you do not want any updates to the item model parameters when doing incremental updates.
Implements IIncrementalRatingPredictor.
bool UpdateUsers [get, set, inherited] |
true if users shall be updated when doing incremental updates
Default should be true. Set to false if you do not want any updates to the user model parameters when doing incremental updates.
Implements IIncrementalRatingPredictor.
SparseBooleanMatrix UserAttributes [get, set] |
The binary user attributes
Implements IUserAttributeAwareRecommender.