Extensions Class Reference

Class that contains static methods for item prediction. More...

List of all members.

Static Public Member Functions

static IList< int > PredictItems (this IRecommender recommender, int user_id, IList< int > candidate_items)
 Predict items for a given user.
static IList< int > PredictItems (this IRecommender recommender, int user_id, int max_item_id)
 predict items for a specific users
static void WritePredictions (this IRecommender recommender, int user_id, ICollection< int > candidate_items, ICollection< int > ignore_items, int num_predictions, TextWriter writer, IEntityMapping user_mapping, IEntityMapping item_mapping)
 Write item predictions (scores) to a TextWriter object.
static void WritePredictions (this IRecommender recommender, IPosOnlyFeedback train, ICollection< int > candidate_items, int num_predictions, TextWriter writer, IList< int > users=null, IEntityMapping user_mapping=null, IEntityMapping item_mapping=null)
 Write item predictions (scores) to a TextWriter object.
static void WritePredictions (this IRecommender recommender, IPosOnlyFeedback train, ICollection< int > candidate_items, int num_predictions, string filename, IList< int > users=null, IEntityMapping user_mapping=null, IEntityMapping item_mapping=null)
 Write item predictions (scores) to a file.

Detailed Description

Class that contains static methods for item prediction.


Member Function Documentation

static IList<int> PredictItems ( this IRecommender  recommender,
int  user_id,
IList< int >  candidate_items 
) [inline, static]

Predict items for a given user.

Parameters:
recommender the recommender to use
user_id the numerical ID of the user
candidate_items a collection of numerical IDs of candidate items
Returns:
an ordered list of items, the most likely item first
static IList<int> PredictItems ( this IRecommender  recommender,
int  user_id,
int  max_item_id 
) [inline, static]

predict items for a specific users

Parameters:
recommender the IRecommender object to use for the predictions
user_id the user ID
max_item_id the maximum item ID
Returns:
a list sorted list of item IDs
static void WritePredictions ( this IRecommender  recommender,
int  user_id,
ICollection< int >  candidate_items,
ICollection< int >  ignore_items,
int  num_predictions,
TextWriter  writer,
IEntityMapping  user_mapping,
IEntityMapping  item_mapping 
) [inline, static]

Write item predictions (scores) to a TextWriter object.

Parameters:
recommender the IRecommender to use for making the predictions
user_id the ID of the user to make recommendations for
candidate_items the list of candidate items
ignore_items a list of items for which no predictions should be made
num_predictions the number of items to return per user, -1 if there should be no limit
writer the TextWriter to write to
user_mapping an IEntityMapping object for the user IDs
item_mapping an IEntityMapping object for the item IDs
static void WritePredictions ( this IRecommender  recommender,
IPosOnlyFeedback  train,
ICollection< int >  candidate_items,
int  num_predictions,
TextWriter  writer,
IList< int >  users = null,
IEntityMapping  user_mapping = null,
IEntityMapping  item_mapping = null 
) [inline, static]

Write item predictions (scores) to a TextWriter object.

Parameters:
recommender the IRecommender to use for making the predictions
train a user-wise IPosOnlyFeedback containing the items already observed
candidate_items the list of candidate items
num_predictions the number of items to return per user, -1 if there should be no limit
writer the TextWriter to write to
users a list of users to make recommendations for; if null, all users in train will be provided with recommendations
user_mapping an IEntityMapping object for the user IDs
item_mapping an IEntityMapping object for the item IDs
static void WritePredictions ( this IRecommender  recommender,
IPosOnlyFeedback  train,
ICollection< int >  candidate_items,
int  num_predictions,
string  filename,
IList< int >  users = null,
IEntityMapping  user_mapping = null,
IEntityMapping  item_mapping = null 
) [inline, static]

Write item predictions (scores) to a file.

Parameters:
recommender the IRecommender to use for making the predictions
train a user-wise IPosOnlyFeedback containing the items already observed
candidate_items the list of candidate items
num_predictions the number of items to return per user, -1 if there should be no limit
filename the name of the file to write to
users a list of users to make recommendations for
user_mapping an IEntityMapping object for the user IDs
item_mapping an IEntityMapping object for the item IDs

The documentation for this class was generated from the following file:
Generated on Mon Nov 28 19:18:46 2011 for MyMediaLite by  doxygen 1.6.3