summaryrefslogtreecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html
blob: c5fb1f9cce52bc861377326f0f2606a8253fad74 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
<!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 Wed Sep 16 10:26:34 PDT 2015 -->
<title>MatrixFactorizationModel</title>
<meta name="date" content="2015-09-16">
<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="MatrixFactorizationModel";
    }
//-->
</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/mllib/recommendation/ALS.html" title="class in org.apache.spark.mllib.recommendation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html" target="_top">Frames</a></li>
<li><a href="MatrixFactorizationModel.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.mllib.recommendation</div>
<h2 title="Class MatrixFactorizationModel" class="title">Class MatrixFactorizationModel</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.mllib.recommendation.MatrixFactorizationModel</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a>, <a href="../../../../../org/apache/spark/mllib/util/Saveable.html" title="interface in org.apache.spark.mllib.util">Saveable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">MatrixFactorizationModel</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/spark/mllib/util/Saveable.html" title="interface in org.apache.spark.mllib.util">Saveable</a>, scala.Serializable, <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></pre>
<div class="block">Model representing the result of matrix factorization.
 <p>
 Note: If you create the model directly using constructor, please be aware that fast prediction
 requires cached user/product features and their associated partitioners.
 <p>
 param:  rank Rank for the features in this model.
 param:  userFeatures RDD of tuples where each tuple represents the userId and
                     the features computed for this user.
 param:  productFeatures RDD of tuples where each tuple represents the productId
                        and the features computed for this product.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.mllib.recommendation.MatrixFactorizationModel">Serialized Form</a></dd></dl>
</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/mllib/recommendation/MatrixFactorizationModel.html#MatrixFactorizationModel(int, org.apache.spark.rdd.RDD, org.apache.spark.rdd.RDD)">MatrixFactorizationModel</a></strong>(int&nbsp;rank,
                        <a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;&nbsp;userFeatures,
                        <a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;&nbsp;productFeatures)</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>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#formatVersion()">formatVersion</a></strong>()</code>
<div class="block">Current version of model save/load format.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html" title="class in org.apache.spark.mllib.recommendation">MatrixFactorizationModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#load(org.apache.spark.SparkContext, java.lang.String)">load</a></strong>(<a href="../../../../../org/apache/spark/SparkContext.html" title="class in org.apache.spark">SparkContext</a>&nbsp;sc,
    java.lang.String&nbsp;path)</code>
<div class="block">Load a model from the given path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#predict(int, int)">predict</a></strong>(int&nbsp;user,
       int&nbsp;product)</code>
<div class="block">Predict the rating of one user for one product.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/api/java/JavaRDD.html" title="class in org.apache.spark.api.java">JavaRDD</a>&lt;<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#predict(org.apache.spark.api.java.JavaPairRDD)">predict</a></strong>(<a href="../../../../../org/apache/spark/api/java/JavaPairRDD.html" title="class in org.apache.spark.api.java">JavaPairRDD</a>&lt;java.lang.Integer,java.lang.Integer&gt;&nbsp;usersProducts)</code>
<div class="block">Java-friendly version of <code>MatrixFactorizationModel.predict</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#predict(org.apache.spark.rdd.RDD)">predict</a></strong>(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,java.lang.Object&gt;&gt;&nbsp;usersProducts)</code>
<div class="block">Predict the rating of many users for many products.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#productFeatures()">productFeatures</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#rank()">rank</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#recommendProducts(int, int)">recommendProducts</a></strong>(int&nbsp;user,
                 int&nbsp;num)</code>
<div class="block">Recommends products to a user.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#recommendProductsForUsers(int)">recommendProductsForUsers</a></strong>(int&nbsp;num)</code>
<div class="block">Recommends topK products for all users.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#recommendUsers(int, int)">recommendUsers</a></strong>(int&nbsp;product,
              int&nbsp;num)</code>
<div class="block">Recommends users to a product.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#recommendUsersForProducts(int)">recommendUsersForProducts</a></strong>(int&nbsp;num)</code>
<div class="block">Recommends topK users for all products.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#save(org.apache.spark.SparkContext, java.lang.String)">save</a></strong>(<a href="../../../../../org/apache/spark/SparkContext.html" title="class in org.apache.spark">SparkContext</a>&nbsp;sc,
    java.lang.String&nbsp;path)</code>
<div class="block">Save this model to the given path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html#userFeatures()">userFeatures</a></strong>()</code>&nbsp;</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.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="MatrixFactorizationModel(int, org.apache.spark.rdd.RDD, org.apache.spark.rdd.RDD)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MatrixFactorizationModel</h4>
<pre>public&nbsp;MatrixFactorizationModel(int&nbsp;rank,
                        <a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;&nbsp;userFeatures,
                        <a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;&nbsp;productFeatures)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="load(org.apache.spark.SparkContext, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html" title="class in org.apache.spark.mllib.recommendation">MatrixFactorizationModel</a>&nbsp;load(<a href="../../../../../org/apache/spark/SparkContext.html" title="class in org.apache.spark">SparkContext</a>&nbsp;sc,
                            java.lang.String&nbsp;path)</pre>
<div class="block">Load a model from the given path.
 <p>
 The model should have been saved by <code>Saveable.save</code>.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - Spark context used for loading model files.</dd><dd><code>path</code> - Path specifying the directory to which the model was saved.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Model instance</dd></dl>
</li>
</ul>
<a name="rank()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rank</h4>
<pre>public&nbsp;int&nbsp;rank()</pre>
</li>
</ul>
<a name="userFeatures()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userFeatures</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;&nbsp;userFeatures()</pre>
</li>
</ul>
<a name="productFeatures()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>productFeatures</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,double[]&gt;&gt;&nbsp;productFeatures()</pre>
</li>
</ul>
<a name="predict(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>predict</h4>
<pre>public&nbsp;double&nbsp;predict(int&nbsp;user,
             int&nbsp;product)</pre>
<div class="block">Predict the rating of one user for one product.</div>
</li>
</ul>
<a name="predict(org.apache.spark.rdd.RDD)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>predict</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>&gt;&nbsp;predict(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,java.lang.Object&gt;&gt;&nbsp;usersProducts)</pre>
<div class="block">Predict the rating of many users for many products.
 The output RDD has an element per each element in the input RDD (including all duplicates)
 unless a user or product is missing in the training set.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>usersProducts</code> - RDD of (user, product) pairs.</dd>
<dt><span class="strong">Returns:</span></dt><dd>RDD of Ratings.</dd></dl>
</li>
</ul>
<a name="predict(org.apache.spark.api.java.JavaPairRDD)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>predict</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/api/java/JavaRDD.html" title="class in org.apache.spark.api.java">JavaRDD</a>&lt;<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>&gt;&nbsp;predict(<a href="../../../../../org/apache/spark/api/java/JavaPairRDD.html" title="class in org.apache.spark.api.java">JavaPairRDD</a>&lt;java.lang.Integer,java.lang.Integer&gt;&nbsp;usersProducts)</pre>
<div class="block">Java-friendly version of <code>MatrixFactorizationModel.predict</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>usersProducts</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="recommendProducts(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recommendProducts</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]&nbsp;recommendProducts(int&nbsp;user,
                         int&nbsp;num)</pre>
<div class="block">Recommends products to a user.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - the user to recommend products to</dd><dd><code>num</code> - how many products to return. The number returned may be less than this.</dd>
<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation"><code>Rating</code></a> objects, each of which contains the given user ID, a product ID, and a
  "score" in the rating field. Each represents one recommended product, and they are sorted
  by score, decreasing. The first returned is the one predicted to be most strongly
  recommended to the user. The score is an opaque value that indicates how strongly
  recommended the product is.</dd></dl>
</li>
</ul>
<a name="recommendUsers(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recommendUsers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]&nbsp;recommendUsers(int&nbsp;product,
                      int&nbsp;num)</pre>
<div class="block">Recommends users to a product. That is, this returns users who are most likely to be
 interested in a product.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>product</code> - the product to recommend users to</dd><dd><code>num</code> - how many users to return. The number returned may be less than this.</dd>
<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation"><code>Rating</code></a> objects, each of which contains a user ID, the given product ID, and a
  "score" in the rating field. Each represents one recommended user, and they are sorted
  by score, decreasing. The first returned is the one predicted to be most strongly
  recommended to the product. The score is an opaque value that indicates how strongly
  recommended the user is.</dd></dl>
</li>
</ul>
<a name="formatVersion()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatVersion</h4>
<pre>protected&nbsp;java.lang.String&nbsp;formatVersion()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/mllib/util/Saveable.html#formatVersion()">Saveable</a></code></strong></div>
<div class="block">Current version of model save/load format.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/util/Saveable.html#formatVersion()">formatVersion</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/mllib/util/Saveable.html" title="interface in org.apache.spark.mllib.util">Saveable</a></code></dd>
</dl>
</li>
</ul>
<a name="save(org.apache.spark.SparkContext, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>save</h4>
<pre>public&nbsp;void&nbsp;save(<a href="../../../../../org/apache/spark/SparkContext.html" title="class in org.apache.spark">SparkContext</a>&nbsp;sc,
        java.lang.String&nbsp;path)</pre>
<div class="block">Save this model to the given path.
 <p>
 This saves:
  - human-readable (JSON) model metadata to path/metadata/
  - Parquet formatted data to path/data/
 <p>
 The model may be loaded using <code>Loader.load</code>.
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/util/Saveable.html#save(org.apache.spark.SparkContext, java.lang.String)">save</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/mllib/util/Saveable.html" title="interface in org.apache.spark.mllib.util">Saveable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - Spark context used to save model data.</dd><dd><code>path</code> - Path specifying the directory in which to save this model.
              If the directory already exists, this method throws an exception.</dd></dl>
</li>
</ul>
<a name="recommendProductsForUsers(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recommendProductsForUsers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]&gt;&gt;&nbsp;recommendProductsForUsers(int&nbsp;num)</pre>
<div class="block">Recommends topK products for all users.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>num</code> - how many products to return for every user.</dd>
<dt><span class="strong">Returns:</span></dt><dd>[(Int, Array[Rating])] objects, where every tuple contains a userID and an array of
 rating objects which contains the same userId, recommended productID and a "score" in the
 rating field. Semantics of score is same as recommendProducts API</dd></dl>
</li>
</ul>
<a name="recommendUsersForProducts(int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>recommendUsersForProducts</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation">Rating</a>[]&gt;&gt;&nbsp;recommendUsersForProducts(int&nbsp;num)</pre>
<div class="block">Recommends topK users for all products.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>num</code> - how many users to return for every product.</dd>
<dt><span class="strong">Returns:</span></dt><dd>[(Int, Array[Rating])] objects, where every tuple contains a productID and an array
 of rating objects which contains the recommended userId, same productID and a "score" in the
 rating field. Semantics of score is same as recommendUsers API</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/mllib/recommendation/ALS.html" title="class in org.apache.spark.mllib.recommendation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/recommendation/Rating.html" title="class in org.apache.spark.mllib.recommendation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/recommendation/MatrixFactorizationModel.html" target="_top">Frames</a></li>
<li><a href="MatrixFactorizationModel.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></body>
</html>