summaryrefslogtreecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/mllib/fpm/FPGrowth.html
blob: f690c3f1fac84483c959ddf5afb50a51a6e3a9ef (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
<!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 15:55:12 PDT 2015 -->
<title>FPGrowth</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="FPGrowth";
    }
//-->
</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/fpm/AssociationRules.Rule.html" title="class in org.apache.spark.mllib.fpm"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.FreqItemset.html" title="class in org.apache.spark.mllib.fpm"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/fpm/FPGrowth.html" target="_top">Frames</a></li>
<li><a href="FPGrowth.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><a href="#nested_class_summary">Nested</a>&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.fpm</div>
<h2 title="Class FPGrowth" class="title">Class FPGrowth</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.mllib.fpm.FPGrowth</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></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">FPGrowth</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a>, scala.Serializable</pre>
<div class="block">:: Experimental ::
 <p>
 A parallel FP-growth algorithm to mine frequent itemsets. The algorithm is described in
 <code>Li et al., PFP: Parallel FP-Growth for Query
  Recommendation</code>. PFP distributes computation in such a way that each worker executes an
 independent group of mining tasks. The FP-Growth algorithm is described in
 <code>Han et al., Mining frequent patterns without candidate
  generation</code>.
 <p>
 param:  minSupport the minimal support level of the frequent pattern, any pattern appears
                   more than (minSupport * size-of-the-dataset) times will be output
 param:  numPartitions number of partitions used by parallel FP-growth
 <p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><code>http://en.wikipedia.org/wiki/Association_rule_learning Association rule learning
       (Wikipedia)}
 <p></code>, 
<a href="../../../../../serialized-form.html#org.apache.spark.mllib.fpm.FPGrowth">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.FreqItemset.html" title="class in org.apache.spark.mllib.fpm">FPGrowth.FreqItemset</a>&lt;<a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.FreqItemset.html" title="type parameter in FPGrowth.FreqItemset">Item</a>&gt;</strong></code>
<div class="block">Frequent itemset.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/fpm/FPGrowth.html#FPGrowth()">FPGrowth</a></strong>()</code>
<div class="block">Constructs a default instance with default parameters {minSupport: <code>0.3</code>, numPartitions: same
 as the input data}.</div>
</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>&lt;Item,Basket extends java.lang.Iterable&lt;Item&gt;&gt;&nbsp;<br><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowthModel.html" title="class in org.apache.spark.mllib.fpm">FPGrowthModel</a>&lt;Item&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html#run(org.apache.spark.api.java.JavaRDD)">run</a></strong>(<a href="../../../../../org/apache/spark/api/java/JavaRDD.html" title="class in org.apache.spark.api.java">JavaRDD</a>&lt;Basket&gt;&nbsp;data)</code>
<div class="block">Java-friendly version of <code>run</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;Item&gt;&nbsp;<a href="../../../../../org/apache/spark/mllib/fpm/FPGrowthModel.html" title="class in org.apache.spark.mllib.fpm">FPGrowthModel</a>&lt;Item&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html#run(org.apache.spark.rdd.RDD, scala.reflect.ClassTag)">run</a></strong>(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;java.lang.Object&gt;&nbsp;data,
   scala.reflect.ClassTag&lt;Item&gt;&nbsp;evidence$2)</code>
<div class="block">Computes an FP-Growth model that contains frequent itemsets.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html" title="class in org.apache.spark.mllib.fpm">FPGrowth</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html#setMinSupport(double)">setMinSupport</a></strong>(double&nbsp;minSupport)</code>
<div class="block">Sets the minimal support level (default: <code>0.3</code>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html" title="class in org.apache.spark.mllib.fpm">FPGrowth</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html#setNumPartitions(int)">setNumPartitions</a></strong>(int&nbsp;numPartitions)</code>
<div class="block">Sets the number of partitions used by parallel FP-growth (default: same as input data).</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.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="FPGrowth()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FPGrowth</h4>
<pre>public&nbsp;FPGrowth()</pre>
<div class="block">Constructs a default instance with default parameters {minSupport: <code>0.3</code>, numPartitions: same
 as the input data}.
 <p></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setMinSupport(double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinSupport</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html" title="class in org.apache.spark.mllib.fpm">FPGrowth</a>&nbsp;setMinSupport(double&nbsp;minSupport)</pre>
<div class="block">Sets the minimal support level (default: <code>0.3</code>).
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>minSupport</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setNumPartitions(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumPartitions</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.html" title="class in org.apache.spark.mllib.fpm">FPGrowth</a>&nbsp;setNumPartitions(int&nbsp;numPartitions)</pre>
<div class="block">Sets the number of partitions used by parallel FP-growth (default: same as input data).
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numPartitions</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="run(org.apache.spark.rdd.RDD, scala.reflect.ClassTag)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;&lt;Item&gt;&nbsp;<a href="../../../../../org/apache/spark/mllib/fpm/FPGrowthModel.html" title="class in org.apache.spark.mllib.fpm">FPGrowthModel</a>&lt;Item&gt;&nbsp;run(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;java.lang.Object&gt;&nbsp;data,
                             scala.reflect.ClassTag&lt;Item&gt;&nbsp;evidence$2)</pre>
<div class="block">Computes an FP-Growth model that contains frequent itemsets.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - input data set, each element contains a transaction</dd><dd><code>evidence$2</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <a href="../../../../../org/apache/spark/mllib/fpm/FPGrowthModel.html" title="class in org.apache.spark.mllib.fpm"><code>FPGrowthModel</code></a>
 <p></dd></dl>
</li>
</ul>
<a name="run(org.apache.spark.api.java.JavaRDD)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;&lt;Item,Basket extends java.lang.Iterable&lt;Item&gt;&gt;&nbsp;<a href="../../../../../org/apache/spark/mllib/fpm/FPGrowthModel.html" title="class in org.apache.spark.mllib.fpm">FPGrowthModel</a>&lt;Item&gt;&nbsp;run(<a href="../../../../../org/apache/spark/api/java/JavaRDD.html" title="class in org.apache.spark.api.java">JavaRDD</a>&lt;Basket&gt;&nbsp;data)</pre>
<div class="block">Java-friendly version of <code>run</code>.</div>
</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/fpm/AssociationRules.Rule.html" title="class in org.apache.spark.mllib.fpm"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/fpm/FPGrowth.FreqItemset.html" title="class in org.apache.spark.mllib.fpm"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/fpm/FPGrowth.html" target="_top">Frames</a></li>
<li><a href="FPGrowth.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><a href="#nested_class_summary">Nested</a>&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>