Recommender Class Reference

Helper class with utility methods for handling recommenders. More...

Public Member Functions
delegate void	takes_string (string s)
	Delegate definition necessary to define ConfigureEngine.
Static Public Member Functions
static T	Configure< T > (T engine, Dictionary< string, string > parameters, takes_string report_error)
	Configure a recommender engine.
static T	Configure< T > (T engine, string parameters, takes_string report_error)
	Configure a recommender engine.
static ItemRecommendation.ItemRecommender	CreateItemRecommender (Type type)
	Create an item recommender engine from a type object.
static ItemRecommendation.ItemRecommender	CreateItemRecommender (string typename)
	Create an item recommender engine from the type name.
static RatingPrediction.RatingPredictor	CreateRatingPredictor (Type type)
	Create a rating prediction engine from a type object.
static RatingPrediction.RatingPredictor	CreateRatingPredictor (string typename)
	Create a rating prediction engine from the type name.
static StreamReader	GetReader (string filename, Type recommender_type)
	Get a reader object to read in model parameters of a recommender.
static StreamWriter	GetWriter (string filename, Type engine_type)
	Get a writer object to save the model parameters of a recommender engine.
static string[]	List (string prefix)
	List all recommender engines in a given namespace.
static void	LoadModel (IRecommender recommender, string filename)
	Load the model parameters of a recommender (in a given iteration of the training) from a file.
static string	Needs (IRecommender recommender)
	Describes the kind of data needed by this engine.
static void	SaveModel (IRecommender recommender, string filename, int iteration)
	Save the model parameters of a recommender (in a given iteration of the training) to a file.
static void	SaveModel (IRecommender recommender, string filename)
	Save the model parameters of a recommender to a file.
static void	SetProperty (IRecommender recommender, string key, string val)
	Sets a property of a MyMediaLite recommender engine.

Detailed Description

Helper class with utility methods for handling recommenders.

Contains methods for storing and loading engine models, and for configuring recommenders.

Member Function Documentation

static T Configure< T >	(	T	engine,
		Dictionary< string, string >	parameters,
		takes_string	report_error
	)			`[static]`

Configure a recommender engine.

Parameters:

	engine	the recommender engine to configure
	parameters	a dictionary containing the parameters as key-value pairs
	report_error	void function that takes a string for error reporting

Returns:: the configured recommender engine

static T Configure< T >	(	T	engine,
		string	parameters,
		takes_string	report_error
	)			`[static]`

Configure a recommender engine.

Parameters:

	engine	the recommender engine to configure
	parameters	a string containing the parameters as key-value pairs
	report_error	void function that takes a string for error reporting

Returns:: the configured recommender engine

static ItemRecommendation.ItemRecommender CreateItemRecommender ( Type type ) [static]

Create an item recommender engine from a type object.

Parameters:

type

the type object

Returns:: an item recommender object of type type

static ItemRecommendation.ItemRecommender CreateItemRecommender ( string typename ) [static]

Create an item recommender engine from the type name.

Parameters:

typename

a string containing the type name

Returns:: an item recommender object of type typename if the engine type is found, null otherwise

static RatingPrediction.RatingPredictor CreateRatingPredictor ( Type type ) [static]

Create a rating prediction engine from a type object.

Parameters:

type

the type object

Returns:: a rating recommender object of type type

static RatingPrediction.RatingPredictor CreateRatingPredictor ( string typename ) [static]

Create a rating prediction engine from the type name.

Parameters:

typename

a string containing the type name

Returns:: a rating recommender object of type typename if the engine type is found, null otherwise

static StreamReader GetReader	(	string	filename,
		Type	recommender_type
	)			`[static]`

Get a reader object to read in model parameters of a recommender.

Parameters:

	filename	the filename of the model file
	recommender_type	the expected recommender type

Returns:: a StreamReader

static StreamWriter GetWriter	(	string	filename,
		Type	engine_type
	)			`[static]`

Get a writer object to save the model parameters of a recommender engine.

Parameters:

	filename	the filename of the model file
	engine_type	the engine type

Returns:: a StreamWriter

static string [] List ( string prefix ) [static]

List all recommender engines in a given namespace.

Parameters:

prefix

a string representing the namespace

Returns:: an array of strings containing the engine descriptions

static void LoadModel	(	IRecommender	recommender,
		string	filename
	)			`[static]`

Load the model parameters of a recommender (in a given iteration of the training) from a file.

Parameters:

	recommender	the IRecommender to save
	filename	the filename template

static string Needs ( IRecommender recommender ) [static]

Describes the kind of data needed by this engine.

Parameters:

recommender

a recommender engine

Returns:: a string containing the additional datafiles needed for training this engine

static void SaveModel	(	IRecommender	recommender,
		string	filename,
		int	iteration
	)			`[static]`

Save the model parameters of a recommender (in a given iteration of the training) to a file.

Parameters:

	recommender	the IRecommender to save
	filename	the filename template
	iteration	the iteration (will be appended to the filename)

static void SaveModel	(	IRecommender	recommender,
		string	filename
	)			`[static]`

Save the model parameters of a recommender to a file.

Does not save if file is an empty string

Parameters:

	recommender	the recommender to store
	filename	the filename (may include relative paths)

static void SetProperty	(	IRecommender	recommender,
		string	key,
		string	val
	)			`[static]`

Sets a property of a MyMediaLite recommender engine.

Parameters:

	recommender	An IRecommender
	key	the name of the property (case insensitive)
	val	the string representation of the value

delegate void takes_string ( string s )

Delegate definition necessary to define ConfigureEngine.

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

Recommender.cs

Recommender Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation