MyMediaLite  3.01
Static Public Member Functions
Model Class Reference

Class containing static routines for reading and writing recommender models. More...

List of all members.

Static Public Member Functions

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 recommender_type, string version)
 Get a writer object to save the model parameters of a recommender.
static void Load (IRecommender recommender, string filename)
 Load the model parameters of a recommender from a file.
static IRecommender Load (string filename)
 Load a recommender from a file, including object creation.
static void Save (IRecommender recommender, string filename)
 Save the model parameters of a recommender to a file.
static void Save (IRecommender recommender, string filename, int iteration)
 Save the model parameters of a recommender (in a given iteration of the training) to a file.

Detailed Description

Class containing static routines for reading and writing recommender models.


Member Function Documentation

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

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

Parameters:
filenamethe filename of the model file
recommender_typethe expected recommender type
Returns:
a StreamReader
static StreamWriter GetWriter ( string  filename,
Type  recommender_type,
string  version 
) [inline, static]

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

Parameters:
filenamethe filename of the model file
recommender_typethe recommender type
versionthe version string (for backwards compatibility)
Returns:
a StreamWriter
static void Load ( IRecommender  recommender,
string  filename 
) [inline, static]

Load the model parameters of a recommender from a file.

Parameters:
recommenderthe IRecommender to load
filenamethe filename template
static IRecommender Load ( string  filename) [inline, static]

Load a recommender from a file, including object creation.

Parameters:
filenamethe name of the model file
Returns:
the recommender loaded from the file
static void Save ( IRecommender  recommender,
string  filename 
) [inline, static]

Save the model parameters of a recommender to a file.

Does not save if filename is an empty string.

Parameters:
recommenderthe recommender to store
filenamethe filename (may include relative paths)
static void Save ( IRecommender  recommender,
string  filename,
int  iteration 
) [inline, static]

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

Does not save if filename is an empty string.

Parameters:
recommenderthe IRecommender to save
filenamethe filename template
iterationthe iteration (will be appended to the filename)

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