qminer
Version:
A C++ based data analytics platform for processing large-scale real-time streams containing structured and unstructured data
379 lines (375 loc) • 16.2 kB
HTML
<html>
<head>
<meta name="generator" content="JSDoc 3">
<meta charset="utf-8">
<title>Class: RecommenderSys</title>
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
<link href="css/baseline.css" rel="stylesheet">
</head>
<body onload="prettyPrint()">
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content">
<a href="index.html" class="jsdoc-navbar-package-name">QMiner JavaScript API v9.4.0</a>
</div>
</div>
</nav>
<div id="jsdoc-body-container">
<div id="jsdoc-content">
<div id="jsdoc-content-container">
<div id="jsdoc-main" role="main">
<header class="page-header">
<div class="symbol-detail-labels"><span class="label label-kind">class</span> <span class="label label-static">static</span></div>
<h1><small><a href="module-analytics.html">analytics</a>.<wbr></small><span class="symbol-name">RecommenderSys</span></h1>
<p class="source-link">Source: <a href="analyticsdoc.js.html#source-line-2795">analyticsdoc.<wbr>js:2795</a></p>
<div class="symbol-classdesc">
<p>The recommender system algorithm using Weighted Non-negative Matrix Factorization to predict the
unknown values. If <code>A</code> is a matrix with unknown values it calculates the matrices <code>U</code> and <code>V</code> such that <code>U*V</code> approximates <code>A</code>.</p>
</div>
<dl class="dl-compact">
</dl>
</header>
<section id="summary">
<div class="summary-callout">
<h2 class="summary-callout-heading">Methods</h2>
<div class="summary-content">
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-analytics.RecommenderSys.html#fit">fit(A)</a></dt>
<dd>
</dd>
<dt><a href="module-analytics.RecommenderSys.html#getModel">getModel()</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-analytics.RecommenderSys.html#getParams">getParams()</a></dt>
<dd>
</dd>
<dt><a href="module-analytics.RecommenderSys.html#save">save(fout)</a></dt>
<dd>
</dd>
</dl>
</div>
<div class="summary-column">
<dl class="dl-summary-callout">
<dt><a href="module-analytics.RecommenderSys.html#setParams">setParams(params)</a></dt>
<dd>
</dd>
</dl>
</div>
</div>
</div>
</section>
<section>
<h2 id="RecommenderSys">new <span class="symbol-name">RecommenderSys</span><span class="signature"><span class="signature-params">([arg])</span></span></h2>
<p>Recommender System</p>
<section>
<h3>
Example
</h3>
<div>
<pre class="prettyprint"><code>// import analytics and la modules
var analytics = require('qminer').analytics;
var la = require('qminer').la;
// create a Recommender System object
var recSys = new analytics.RecommenderSys({ tol: 1e-3, iter: 10000, k: 2, verbose: false });
// create the matrix to be fitted
var X = new la.Matrix([[1, 2, 1], [1, 1, 3]]);
// create the model
recSys.fit(X);</code></pre>
</div>
</section>
<section>
<h3>Parameter</h3>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>arg</p>
</td>
<td>
<p>(<a href="module-analytics.html#~RecSysParam">module:analytics~RecSysParam</a> or <a href="module-fs.FIn.html">module:fs.FIn</a>)</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>Construction arguments. There are two ways of constructing:
<br>1. Using the <a href="module-analytics.html#~RecSysParam">module:analytics~RecSysParam</a> object,
<br>2. using the file input stream <a href="module-fs.FIn.html">module:fs.FIn</a>.
</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
</dl>
</section>
<section>
<h2>Methods</h2>
<section>
<h3 id="fit"><span class="symbol-name">fit</span><span class="signature"><span class="signature-params">(A)</span> → <span class="signature-returns"> <a href="module-analytics.RecommenderSys.html">module:analytics.RecommenderSys</a></span></span></h3>
<p>Fits the input matrix to the recommender model.</p>
<section>
<h4>
Examples
</h4>
<div>
<p> Asynhronous function </p>
<pre class="prettyprint"><code>// import modules
var analytics = require('qminer').analytics;
var la = require('qminer').la;
// create a new Recommender System object
var recSys = new analytics.RecommenderSys({ iter: 1000, k: 2 });
// create a matrix to be fitted
var X = new la.Matrix([[1, 5, 0], [1, 0, 3]]);
// create the model with the matrix X
recSys.fitAsync(X, function (err) {
if (err) { console.log(err); }
// successful calculation
});</code></pre>
</div>
<div>
<p> Synhronous function </p>
<pre class="prettyprint"><code>// import modules
var analytics = require('qminer').analytics;
var la = require('qminer').la;
// create a new Recommender System object
var recSys = new analytics.RecommenderSys({ iter: 1000, k: 2 });
// create a matrix to be fitted
var X = new la.Matrix([[1, 5, 0], [1, 0, 3]]);
// create the model with the matrix X
recSys.fit(X);</code></pre>
</div>
</section>
<section>
<h4>Parameter</h4>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>A</p>
</td>
<td>
<p>(<a href="module-la.Matrix.html">module:la.Matrix</a> or <a href="module-la.SparseMatrix.html">module:la.SparseMatrix</a>)</p>
</td>
<td>
<p> </p>
</td>
<td>
<p>Matrix with the ratings, where it A_ij element is the rating that the i-th person
gave to the j-th item. If A_ij = 0, the data doesn't exist.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-analytics.RecommenderSys.html">module:analytics.RecommenderSys</a></code>B Self. The model has been fitted.</p>
</dd>
</dl>
<h3 id="getModel"><span class="symbol-name">getModel</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> Object</span></span></h3>
<p>Gets the model.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import modules
//var analytics = require('qminer').analytics;
//var la = require('qminer').la;
// create a new Recommender System object
//var recSys = new analytics.RecommenderSys({ iter: 1000, k: 3 });
// create a matrix to be fitted
//var X = new la.Matrix([[1, 5, 0], [1, 0, 3]]);
// create the model with the matrix X
//recSys.fit(X);
// get the model
//var model = recSys.getModel();</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code>Object</code>B An object <code>recSysModel</code> containing the properties:
<br>1. <code>recSysModel.U</code> - The matrix <code>U</code> from the weighted NMF. Type <a href="module-la.Matrix.html">module:la.Matrix</a>.
<br>2. <code>recSysModel.V</code> - The matrix <code>V</code> from the weighted NMF. Type <a href="module-la.Matrix.html">module:la.Matrix</a>.
</p>
</dd>
</dl>
<h3 id="getParams"><span class="symbol-name">getParams</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> <a href="module-analytics.html#~RecSysParam">module:analytics~RecSysParam</a></span></span></h3>
<p>Returns the parameters.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import analytics module
var analytics = require('qminer').analytics;
// create a new KMeans object
var recSys = new analytics.RecommenderSys({ iter: 1000, k: 5 });
// get the parameters
var json = recSys.getParams();</code></pre>
</div>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-analytics.html#~RecSysParam">module:analytics~RecSysParam</a></code>B The construction parameters.</p>
</dd>
</dl>
<h3 id="save"><span class="symbol-name">save</span><span class="signature"><span class="signature-params">(fout)</span> → <span class="signature-returns"> <a href="module-fs.FOut.html">module:fs.FOut</a></span></span></h3>
<p>Saves RecommenderSys internal state into (binary) file.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import modules
var analytics = require('qminer').analytics;
var fs = require('qminer').fs;
// create a new Recommender System object
var recSys = new analytics.RecommenderSys();
// change the parameters of the Recommender System object
recSys.setParams({ iter: 1000, k: 5 });
// create the file output stream
var fout = new fs.openWrite('recsys.bin');
// save the RecommenderSys instance
recSys.save(fout);
fout.close();
// load the RecommenderSys instance
var fin = fs.openRead('recsys.bin');
var recSys2 = new analytics.RecommenderSys(fin);</code></pre>
</div>
</section>
<section>
<h4>Parameter</h4>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>fout</p>
</td>
<td>
<p><a href="module-fs.FOut.html">module:fs.FOut</a></p>
</td>
<td>
<p> </p>
</td>
<td>
<p>The output stream.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-fs.FOut.html">module:fs.FOut</a></code>B The output stream <code>fout</code>.</p>
</dd>
</dl>
<h3 id="setParams"><span class="symbol-name">setParams</span><span class="signature"><span class="signature-params">(params)</span> → <span class="signature-returns"> <a href="module-analytics.RecommenderSys.html">module:analytics.RecommenderSys</a></span></span></h3>
<p>Sets the parameters.</p>
<section>
<h4>
Example
</h4>
<div>
<pre class="prettyprint"><code>// import analytics module
var analytics = require('qminer').analytics;
// create a new Recommender System object
var recSys = new analytics.RecommenderSys();
// change the parameters of the Recommender System object
recSys.setParams({ iter: 1000, k: 5 });</code></pre>
</div>
</section>
<section>
<h4>Parameter</h4>
<table class="jsdoc-details-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>params</p>
</td>
<td>
<p><a href="module-analytics.html#~RecSysParam">module:analytics~RecSysParam</a></p>
</td>
<td>
<p> </p>
</td>
<td>
<p>The construction parameters.</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd>
<p><code><a href="module-analytics.RecommenderSys.html">module:analytics.RecommenderSys</a></code>B Self. The parameters has been updated.</p>
</dd>
</dl>
</section>
</section>
</div>
</div>
<nav id="jsdoc-toc-nav" role="navigation"></nav>
</div>
</div>
<footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container">
<p>
</p>
</div>
</footer>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tree.jquery.js"></script>
<script src="scripts/prettify.js"></script>
<script src="scripts/jsdoc-toc.js"></script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/scrollanchor.js"></script>
</body>
</html>