summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/ml/recommendation/ALSSuite.html
blob: e3e8d3edfca490428fb62fbeb287bff7e3594630 (plain) (tree)





























































































































































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                       
       
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 08 16:00:14 PDT 2015 -->
<title>ALSSuite</title>
<meta name="date" content="2015-09-08">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="ALSSuite";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/spark/ml/recommendation/ALSModel.html" title="class in org.apache.spark.ml.recommendation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/recommendation/ALSSuite.html" target="_top">Frames</a></li>
<li><a href="ALSSuite.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.ml.recommendation</div>
<h2 title="Class ALSSuite" class="title">Class ALSSuite</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.SparkFunSuite</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ml.recommendation.ALSSuite</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a>, <a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html" title="interface in org.apache.spark.mllib.util">MLlibTestSparkContext</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ALSSuite</span>
extends org.apache.spark.SparkFunSuite
implements <a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html" title="interface in org.apache.spark.mllib.util">MLlibTestSparkContext</a>, <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/ml/recommendation/ALSSuite.html#ALSSuite()">ALSSuite</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/recommendation/ALSSuite.html#afterAll()">afterAll</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/recommendation/ALSSuite.html#beforeAll()">beforeAll</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.Tuple2&lt;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;,<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/recommendation/ALSSuite.html#genExplicitTestData(int, int, int, double, long)">genExplicitTestData</a></strong>(int&nbsp;numUsers,
                   int&nbsp;numItems,
                   int&nbsp;rank,
                   double&nbsp;noiseStd,
                   long&nbsp;seed)</code>
<div class="block">Generates an explicit feedback dataset for testing ALS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.Tuple2&lt;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;,<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/recommendation/ALSSuite.html#genImplicitTestData(int, int, int, double, long)">genImplicitTestData</a></strong>(int&nbsp;numUsers,
                   int&nbsp;numItems,
                   int&nbsp;rank,
                   double&nbsp;noiseStd,
                   long&nbsp;seed)</code>
<div class="block">Generates an implicit feedback dataset for testing ALS.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/recommendation/ALSSuite.html#testALS(org.apache.spark.rdd.RDD, org.apache.spark.rdd.RDD, int, int, double, boolean, int, int, double)">testALS</a></strong>(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&nbsp;training,
       <a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&nbsp;test,
       int&nbsp;rank,
       int&nbsp;maxIter,
       double&nbsp;regParam,
       boolean&nbsp;implicitPrefs,
       int&nbsp;numUserBlocks,
       int&nbsp;numItemBlocks,
       double&nbsp;targetRMSE)</code>
<div class="block">Test ALS using the given training/test splits and parameters.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.mllib.util.MLlibTestSparkContext">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.mllib.util.<a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html" title="interface in org.apache.spark.mllib.util">MLlibTestSparkContext</a></h3>
<code><a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html#sc()">sc</a>, <a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html#sqlContext()">sqlContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.Logging">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.<a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></h3>
<code><a href="../../../../../org/apache/spark/Logging.html#initializeIfNecessary()">initializeIfNecessary</a>, <a href="../../../../../org/apache/spark/Logging.html#initializeLogging()">initializeLogging</a>, <a href="../../../../../org/apache/spark/Logging.html#isTraceEnabled()">isTraceEnabled</a>, <a href="../../../../../org/apache/spark/Logging.html#log_()">log_</a>, <a href="../../../../../org/apache/spark/Logging.html#log()">log</a>, <a href="../../../../../org/apache/spark/Logging.html#logDebug(scala.Function0)">logDebug</a>, <a href="../../../../../org/apache/spark/Logging.html#logDebug(scala.Function0, java.lang.Throwable)">logDebug</a>, <a href="../../../../../org/apache/spark/Logging.html#logError(scala.Function0)">logError</a>, <a href="../../../../../org/apache/spark/Logging.html#logError(scala.Function0, java.lang.Throwable)">logError</a>, <a href="../../../../../org/apache/spark/Logging.html#logInfo(scala.Function0)">logInfo</a>, <a href="../../../../../org/apache/spark/Logging.html#logInfo(scala.Function0, java.lang.Throwable)">logInfo</a>, <a href="../../../../../org/apache/spark/Logging.html#logName()">logName</a>, <a href="../../../../../org/apache/spark/Logging.html#logTrace(scala.Function0)">logTrace</a>, <a href="../../../../../org/apache/spark/Logging.html#logTrace(scala.Function0, java.lang.Throwable)">logTrace</a>, <a href="../../../../../org/apache/spark/Logging.html#logWarning(scala.Function0)">logWarning</a>, <a href="../../../../../org/apache/spark/Logging.html#logWarning(scala.Function0, java.lang.Throwable)">logWarning</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="ALSSuite()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ALSSuite</h4>
<pre>public&nbsp;ALSSuite()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="beforeAll()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeAll</h4>
<pre>public&nbsp;void&nbsp;beforeAll()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html#beforeAll()">beforeAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html" title="interface in org.apache.spark.mllib.util">MLlibTestSparkContext</a></code></dd>
</dl>
</li>
</ul>
<a name="afterAll()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterAll</h4>
<pre>public&nbsp;void&nbsp;afterAll()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html#afterAll()">afterAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/mllib/util/MLlibTestSparkContext.html" title="interface in org.apache.spark.mllib.util">MLlibTestSparkContext</a></code></dd>
</dl>
</li>
</ul>
<a name="genExplicitTestData(int, int, int, double, long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>genExplicitTestData</h4>
<pre>public&nbsp;scala.Tuple2&lt;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;,<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&gt;&nbsp;genExplicitTestData(int&nbsp;numUsers,
                                                                                                    int&nbsp;numItems,
                                                                                                    int&nbsp;rank,
                                                                                                    double&nbsp;noiseStd,
                                                                                                    long&nbsp;seed)</pre>
<div class="block">Generates an explicit feedback dataset for testing ALS.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numUsers</code> - number of users</dd><dd><code>numItems</code> - number of items</dd><dd><code>rank</code> - rank</dd><dd><code>noiseStd</code> - the standard deviation of additive Gaussian noise on training data</dd><dd><code>seed</code> - random seed</dd>
<dt><span class="strong">Returns:</span></dt><dd>(training, test)</dd></dl>
</li>
</ul>
<a name="genImplicitTestData(int, int, int, double, long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>genImplicitTestData</h4>
<pre>public&nbsp;scala.Tuple2&lt;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;,<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&gt;&nbsp;genImplicitTestData(int&nbsp;numUsers,
                                                                                                    int&nbsp;numItems,
                                                                                                    int&nbsp;rank,
                                                                                                    double&nbsp;noiseStd,
                                                                                                    long&nbsp;seed)</pre>
<div class="block">Generates an implicit feedback dataset for testing ALS.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numUsers</code> - number of users</dd><dd><code>numItems</code> - number of items</dd><dd><code>rank</code> - rank</dd><dd><code>noiseStd</code> - the standard deviation of additive Gaussian noise on training data</dd><dd><code>seed</code> - random seed</dd>
<dt><span class="strong">Returns:</span></dt><dd>(training, test)</dd></dl>
</li>
</ul>
<a name="testALS(org.apache.spark.rdd.RDD, org.apache.spark.rdd.RDD, int, int, double, boolean, int, int, double)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>testALS</h4>
<pre>public&nbsp;void&nbsp;testALS(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&nbsp;training,
           <a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/ml/recommendation/ALS.Rating.html" title="class in org.apache.spark.ml.recommendation">ALS.Rating</a>&lt;java.lang.Object&gt;&gt;&nbsp;test,
           int&nbsp;rank,
           int&nbsp;maxIter,
           double&nbsp;regParam,
           boolean&nbsp;implicitPrefs,
           int&nbsp;numUserBlocks,
           int&nbsp;numItemBlocks,
           double&nbsp;targetRMSE)</pre>
<div class="block">Test ALS using the given training/test splits and parameters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>training</code> - training dataset</dd><dd><code>test</code> - test dataset</dd><dd><code>rank</code> - rank of the matrix factorization</dd><dd><code>maxIter</code> - max number of iterations</dd><dd><code>regParam</code> - regularization constant</dd><dd><code>implicitPrefs</code> - whether to use implicit preference</dd><dd><code>numUserBlocks</code> - number of user blocks</dd><dd><code>numItemBlocks</code> - number of item blocks</dd><dd><code>targetRMSE</code> - target test RMSE</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/spark/ml/recommendation/ALSModel.html" title="class in org.apache.spark.ml.recommendation"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/recommendation/ALSSuite.html" target="_top">Frames</a></li>
<li><a href="ALSSuite.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>