MyMediaLite  3.01
Public Member Functions | Protected Member Functions | Protected Attributes | Properties
MostPopular Class Reference

Most-popular item recommender. More...

Inheritance diagram for MostPopular:
IncrementalItemRecommender ItemRecommender IIncrementalItemRecommender IRecommender IRecommender

List of all members.

Public Member Functions

override void AddFeedback (int user_id, int item_id)
 Add a positive feedback event 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
override void LoadModel (string filename)
 Get the model parameters from a file.
override float Predict (int user_id, int item_id)
 Predict rating or score for a given user-item combination.
override void RemoveFeedback (int user_id, int item_id)
 Remove all feedback events by the given user-item combination.
override void RemoveItem (int item_id)
 Remove all feedback by one item.
override void RemoveUser (int user_id)
 Remove all feedback by one user.
override void SaveModel (string filename)
 Save the model parameters to a file.
override string ToString ()
 Return a string representation of the recommender.
override void Train ()
 Learn the model parameters of the recommender from the training data.

Protected Member Functions

override void AddItem (int item_id)
virtual void AddUser (int user_id)

Protected Attributes

IList< int > view_count
 View count.

Properties

virtual IPosOnlyFeedback Feedback [get, set]
 the feedback data to be used for training
int MaxItemID [get, set]
 Maximum item ID.
int MaxUserID [get, set]
 Maximum user ID.

Detailed Description

Most-popular item recommender.

Items are weighted by how often they have been seen in the past.

This method is not personalized.

This recommender supports incremental updates.


Member Function Documentation

override void AddFeedback ( int  user_id,
int  item_id 
) [inline, virtual]

Add a positive feedback event and perform incremental training.

Parameters:
user_idthe user ID
item_idthe item ID

Reimplemented from IncrementalItemRecommender.

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.

Object Clone ( ) [inline, inherited]

create a shallow copy of the object

override void LoadModel ( string  filename) [inline, virtual]

Get the model parameters from a file.

Parameters:
filenamethe name of the file to read from

Implements ItemRecommender.

override float Predict ( int  user_id,
int  item_id 
) [inline, virtual]

Predict rating or score for a given user-item combination.

Parameters:
user_idthe user ID
item_idthe item ID
Returns:
the predicted score/rating for the given user-item combination

Implements ItemRecommender.

override void RemoveFeedback ( int  user_id,
int  item_id 
) [inline, virtual]

Remove all feedback events by the given user-item combination.

Parameters:
user_idthe user ID
item_idthe item ID

Reimplemented from IncrementalItemRecommender.

override void RemoveItem ( int  item_id) [inline, virtual]

Remove all feedback by one item.

Parameters:
item_idthe item ID

Reimplemented from IncrementalItemRecommender.

override void RemoveUser ( int  user_id) [inline, virtual]

Remove all feedback by one user.

Parameters:
user_idthe user ID

Reimplemented from IncrementalItemRecommender.

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

Save the model parameters to a file.

Parameters:
filenamethe name of the file to write to

Implements ItemRecommender.

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, BPRMF_Mapping, BPRLinear, BPRMF_ItemMapping, BPRMF_UserMapping, WRMF, MultiCoreBPRMF, BPRMF_ItemMapping_Optimal, BPRMF_ItemMappingSVR, SoftMarginRankingMF, ItemAttributeSVM, BPRMF_UserMapping_Optimal, BPRMF_ItemMappingKNN, WeightedBPRMF, ItemKNN, UserKNN, ItemAttributeKNN, UserAttributeKNN, WeightedItemKNN, and WeightedUserKNN.


Member Data Documentation

IList<int> view_count [protected]

View count.


Property Documentation

virtual IPosOnlyFeedback Feedback [get, set, inherited]

the feedback data to be used for training

int MaxItemID [get, set, inherited]

Maximum item ID.

int MaxUserID [get, set, inherited]

Maximum user ID.


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