This class implements Collaborative Filtering (CF). More...

Inheritance diagram for CFType< DecompositionPolicy, NormalizationType >:

Public Member Functions
	CFType (const size_t numUsersForSimilarity=5, const size_t rank=0)
	Initialize the CFType object without performing any factorization. More...

template < typename MatType >
	CFType (const MatType &data, const DecompositionPolicy &decomposition=DecompositionPolicy(), const size_t numUsersForSimilarity=5, const size_t rank=0, const size_t maxIterations=1000, const double minResidue=1e-5, const bool mit=false)
	Initialize the CFType object using any decomposition method, immediately factorizing the given data to create a model. More...

const arma::sp_mat &	CleanedData () const
	Get the cleaned data matrix. More...

const DecompositionPolicy &	Decomposition () const
	Gets decomposition object. More...

template < typename NeighborSearchPolicy = EuclideanSearch , typename InterpolationPolicy = AverageInterpolation >
void	GetRecommendations (const size_t numRecs, arma::Mat< size_t > &recommendations)
	Generates the given number of recommendations for all users. More...

template < typename NeighborSearchPolicy = EuclideanSearch , typename InterpolationPolicy = AverageInterpolation >
void	GetRecommendations (const size_t numRecs, arma::Mat< size_t > &recommendations, const arma::Col< size_t > &users)
	Generates the given number of recommendations for the specified users. More...

const NormalizationType &	Normalization () const
	Get the normalization object. More...

void	NumUsersForSimilarity (const size_t num)
	Sets number of users for calculating similarity. More...

size_t	NumUsersForSimilarity () const
	Gets number of users for calculating similarity. More...

template < typename NeighborSearchPolicy = EuclideanSearch , typename InterpolationPolicy = AverageInterpolation >
double	Predict (const size_t user, const size_t item) const
	Predict the rating of an item by a particular user. More...

template < typename NeighborSearchPolicy = EuclideanSearch , typename InterpolationPolicy = AverageInterpolation >
void	Predict (const arma::Mat< size_t > &combinations, arma::vec &predictions) const
	Predict ratings for each user-item combination in the given coordinate list matrix. More...

void	Rank (const size_t rankValue)
	Sets rank parameter for matrix factorization. More...

size_t	Rank () const
	Gets rank parameter for matrix factorization. More...

template < typename Archive >
void	serialize (Archive &ar, const uint32_t)
	Serialize the CFType model to the given archive. More...

void	Train (const arma::mat &data, const DecompositionPolicy &decomposition, const size_t maxIterations=1000, const double minResidue=1e-5, const bool mit=false)
	Train the CFType model (i.e. More...

void	Train (const arma::sp_mat &data, const DecompositionPolicy &decomposition, const size_t maxIterations=1000, const double minResidue=1e-5, const bool mit=false)
	Train the CFType model (i.e. More...

Static Public Member Functions
static void	CleanData (const arma::mat &data, arma::sp_mat &cleanedData)
	Converts the User, Item, Value Matrix to User-Item Table. More...

Detailed Description

template
<
typename
DecompositionPolicy
=
NMFPolicy
,
typename
NormalizationType
=
NoNormalization
>

class mlpack::cf::CFType< DecompositionPolicy, NormalizationType >

This class implements Collaborative Filtering (CF).

This implementation presently supports Alternating Least Squares (ALS) for collaborative filtering.

A simple example of how to run Collaborative Filtering is shown below.

extern arma::mat data; // (user, item, rating) table
extern arma::Col<size_t> users; // users seeking recommendations
arma::Mat<size_t> recommendations; // Recommendations
CFType<> cf(data); // Default options.
// Generate 10 recommendations for all users.
cf.GetRecommendations(10, recommendations);
// Generate 10 recommendations for specified users.
cf.GetRecommendations(10, recommendations, users);

The data matrix is a (user, item, rating) table. Each column in the matrix should have three rows. The first represents the user; the second represents the item; and the third represents the rating. The user and item, while they are in a matrix that holds doubles, should hold integer (or size_t) values. The user and item indices are assumed to start at 0.

Template Parameters

DecompositionPolicy	The policy used to decompose the rating matrix. It also provides methods to compute prediction and neighborhood.
NormalizationType	The type of normalization performed on raw data. Data is normalized before calling Train() method. Predicted rating is denormalized before return.

Definition at line 70 of file cf.hpp.

Constructor & Destructor Documentation

◆ CFType() [1/2]

CFType	(	const size_t	numUsersForSimilarity = `5`,
		const size_t	rank = `0`
	)

Initialize the CFType object without performing any factorization.

Be sure to call Train() before calling GetRecommendations() or any other functions!

◆ CFType() [2/2]

CFType	(	const MatType &	data,
		const DecompositionPolicy &	decomposition = `DecompositionPolicy()`,
		const size_t	numUsersForSimilarity = `5`,
		const size_t	rank = `0`,
		const size_t	maxIterations = `1000`,
		const double	minResidue = `1e-5`,
		const bool	mit = `false`
	)

Initialize the CFType object using any decomposition method, immediately factorizing the given data to create a model.

There are parameters that can be set; default values are provided for each of them. If the rank is left unset (or is set to 0), a simple density-based heuristic will be used to choose a rank.

The provided dataset can be a coordinate list; that is, a 3-row matrix where each column corresponds to a (user, item, rating) entry in the matrix or a sparse matrix representing (user, item) table.

Template Parameters

MatType The type of input matrix, which is expected to be either arma::mat (table of (user, item, rating)) or arma::sp_mat (sparse rating matrix where row is item and column is user).

Parameters

data	Data matrix: dense matrix (coordinate lists) or sparse matrix(cleaned).
decomposition	Instantiated DecompositionPolicy object.
numUsersForSimilarity	Size of the neighborhood.
rank	Rank parameter for matrix factorization.
maxIterations	Maximum number of iterations.
minResidue	Residue required to terminate.
mit	Whether to terminate only when maxIterations is reached.

Member Function Documentation

◆ CleanData()

static void CleanData	(	const arma::mat &	data,
		arma::sp_mat &	cleanedData
	)

static

Converts the User, Item, Value Matrix to User-Item Table.

Referenced by CFType< DecompositionPolicy, NormalizationPolicy >::Normalization().

◆ CleanedData()

const arma::sp_mat& CleanedData ( ) const

inline

Get the cleaned data matrix.

Definition at line 180 of file cf.hpp.

◆ Decomposition()

const DecompositionPolicy& Decomposition ( ) const

inline

Gets decomposition object.

Definition at line 177 of file cf.hpp.

◆ GetRecommendations() [1/2]

void GetRecommendations	(	const size_t	numRecs,
		arma::Mat< size_t > &	recommendations
	)

Generates the given number of recommendations for all users.

Template Parameters

NeighborSearchPolicy	The policy used to search neighbors of query set in referece set.
InterpolationPolicy	The policy used to calculate interpolation weights.

Parameters

numRecs	Number of Recommendations.
recommendations	Matrix to save recommendations into.

Referenced by CFType< DecompositionPolicy, NormalizationPolicy >::Normalization().

◆ GetRecommendations() [2/2]

void GetRecommendations	(	const size_t	numRecs,
		arma::Mat< size_t > &	recommendations,
		const arma::Col< size_t > &	users
	)

Generates the given number of recommendations for the specified users.

Template Parameters

NeighborSearchPolicy	The policy used to search neighbors of query set in referece set.
InterpolationPolicy	The policy used to calculate interpolation weights.

Parameters

numRecs	Number of Recommendations.
recommendations	Matrix to save recommendations.
users	Users for which recommendations are to be generated.

◆ Normalization()

const NormalizationType& Normalization ( ) const

inline

Get the normalization object.

Definition at line 183 of file cf.hpp.

◆ NumUsersForSimilarity() [1/2]

void NumUsersForSimilarity ( const size_t num )

inline

Sets number of users for calculating similarity.

Definition at line 147 of file cf.hpp.

◆ NumUsersForSimilarity() [2/2]

size_t NumUsersForSimilarity ( ) const

inline

Gets number of users for calculating similarity.

Definition at line 159 of file cf.hpp.

◆ Predict() [1/2]

double Predict	(	const size_t	user,
		const size_t	item
	)		const

Predict the rating of an item by a particular user.

Template Parameters

NeighborSearchPolicy	The policy used to search neighbors of query set in referece set.
InterpolationPolicy	The policy used to calculate interpolation weights.

Parameters

user	User to predict for.
item	Item to predict for.

Referenced by CFType< DecompositionPolicy, NormalizationPolicy >::Normalization().

◆ Predict() [2/2]

void Predict	(	const arma::Mat< size_t > &	combinations,
		arma::vec &	predictions
	)		const

Predict ratings for each user-item combination in the given coordinate list matrix.

The matrix 'combinations' should have two rows and number of columns equal to the number of desired predictions. The first element of each column corresponds to the user index, and the second element of each column corresponds to the item index. The output vector 'predictions' will have length equal to combinations.n_cols, and predictions[i] will be equal to the prediction for the user/item combination in combinations.col(i).

Template Parameters

NeighborSearchPolicy	The policy used to search neighbors of query set in referece set.
InterpolationPolicy	The policy used to calculate interpolation weights.

Parameters

combinations	User/item combinations to predict.
predictions	Predicted ratings for each user/item combination.

◆ Rank() [1/2]

void Rank ( const size_t rankValue )

inline

Sets rank parameter for matrix factorization.

Definition at line 165 of file cf.hpp.

◆ Rank() [2/2]

size_t Rank ( ) const

inline

Gets rank parameter for matrix factorization.

Definition at line 171 of file cf.hpp.

◆ serialize()

void serialize	(	Archive &	ar,
		const uint32_t
	)

Serialize the CFType model to the given archive.

Referenced by CFType< DecompositionPolicy, NormalizationPolicy >::Normalization().

◆ Train() [1/2]

void Train	(	const arma::mat &	data,
		const DecompositionPolicy &	decomposition,
		const size_t	maxIterations = `1000`,
		const double	minResidue = `1e-5`,
		const bool	mit = `false`
	)

Train the CFType model (i.e.

factorize the input matrix) using the parameters that have already been set for the model (specifically, the rank parameter), and optionally, using the given DecompositionPolicy.

Parameters

data	Input dataset; dense matrix (coordinate lists).
decomposition	Instantiated DecompositionPolicy object.
maxIterations	Maximum number of iterations.
minResidue	Residue required to terminate.
mit	Whether to terminate only when maxIterations is reached.

◆ Train() [2/2]

void Train	(	const arma::sp_mat &	data,
		const DecompositionPolicy &	decomposition,
		const size_t	maxIterations = `1000`,
		const double	minResidue = `1e-5`,
		const bool	mit = `false`
	)

Train the CFType model (i.e.

factorize the input matrix) using the parameters that have already been set for the model (specifically, the rank parameter), and optionally, using the given DecompositionPolicy.

Parameters

data	Input dataset; sparse matrix (user item table).
decomposition	Instantiated DecompositionPolicy object.
maxIterations	Maximum number of iterations.
minResidue	Residue required to terminate.
mit	Whether to terminate only when maxIterations is reached.

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

/home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/cf/cf.hpp

Public Member Functions

Static Public Member Functions

Detailed Description

template<typenameDecompositionPolicy=NMFPolicy,typenameNormalizationType=NoNormalization> class mlpack::cf::CFType< DecompositionPolicy, NormalizationType >

Constructor & Destructor Documentation

◆ CFType() [1/2]

◆ CFType() [2/2]

Member Function Documentation

◆ CleanData()

◆ CleanedData()

◆ Decomposition()

◆ GetRecommendations() [1/2]

◆ GetRecommendations() [2/2]

◆ Normalization()

◆ NumUsersForSimilarity() [1/2]

◆ NumUsersForSimilarity() [2/2]

◆ Predict() [1/2]

◆ Predict() [2/2]

◆ Rank() [1/2]

◆ Rank() [2/2]

◆ serialize()

◆ Train() [1/2]

◆ Train() [2/2]

template
<
typename
DecompositionPolicy
=
NMFPolicy
,
typename
NormalizationType
=
NoNormalization
>

class mlpack::cf::CFType< DecompositionPolicy, NormalizationType >