summaryrefslogtreecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/mllib/regression/IsotonicRegression.html
blob: b066c851115badde3be8a46e80284c2240567d6e (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
<!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>IsotonicRegression</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="IsotonicRegression";
    }
//-->
</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/regression/GeneralizedLinearModel.html" title="class in org.apache.spark.mllib.regression"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.mllib.regression"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/regression/IsotonicRegression.html" target="_top">Frames</a></li>
<li><a href="IsotonicRegression.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.regression</div>
<h2 title="Class IsotonicRegression" class="title">Class IsotonicRegression</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.mllib.regression.IsotonicRegression</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">IsotonicRegression</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">:: Experimental ::
 <p>
 Isotonic regression.
 Currently implemented using parallelized pool adjacent violators algorithm.
 Only univariate (single feature) algorithm supported.
 <p>
 Sequential PAV implementation based on:
 Tibshirani, Ryan J., Holger Hoefling, and Robert Tibshirani.
   "Nearly-isotonic regression." Technometrics 53.1 (2011): 54-61.
   Available from <code>http://www.stat.cmu.edu/~ryantibs/papers/neariso.pdf</code>
 <p>
 Sequential PAV parallelization based on:
 Kearsley, Anthony J., Richard A. Tapia, and Michael W. Trosset.
   "An approach to parallelizing isotonic regression."
   Applied Mathematics and Parallel Computing. Physica-Verlag HD, 1996. 141-147.
   Available from <code>http://softlib.rice.edu/pub/CRPC-TRs/reports/CRPC-TR96640.pdf</code>
 <p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://en.wikipedia.org/wiki/Isotonic_regression Isotonic regression (Wikipedia)"/>, 
<a href="../../../../../serialized-form.html#org.apache.spark.mllib.regression.IsotonicRegression">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/regression/IsotonicRegression.html#IsotonicRegression()">IsotonicRegression</a></strong>()</code>
<div class="block">Constructs IsotonicRegression instance with default parameter isotonic = true.</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><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.mllib.regression">IsotonicRegressionModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegression.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;scala.Tuple3&lt;java.lang.Double,java.lang.Double,java.lang.Double&gt;&gt;&nbsp;input)</code>
<div class="block">Run pool adjacent violators algorithm to obtain isotonic regression model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.mllib.regression">IsotonicRegressionModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegression.html#run(org.apache.spark.rdd.RDD)">run</a></strong>(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple3&lt;java.lang.Object,java.lang.Object,java.lang.Object&gt;&gt;&nbsp;input)</code>
<div class="block">Run IsotonicRegression algorithm to obtain isotonic regression model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegression.html" title="class in org.apache.spark.mllib.regression">IsotonicRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegression.html#setIsotonic(boolean)">setIsotonic</a></strong>(boolean&nbsp;isotonic)</code>
<div class="block">Sets the isotonic parameter.</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>
</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="IsotonicRegression()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IsotonicRegression</h4>
<pre>public&nbsp;IsotonicRegression()</pre>
<div class="block">Constructs IsotonicRegression instance with default parameter isotonic = true.
 <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="setIsotonic(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsotonic</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegression.html" title="class in org.apache.spark.mllib.regression">IsotonicRegression</a>&nbsp;setIsotonic(boolean&nbsp;isotonic)</pre>
<div class="block">Sets the isotonic parameter.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isotonic</code> - Isotonic (increasing) or antitonic (decreasing) sequence.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This instance of IsotonicRegression.</dd></dl>
</li>
</ul>
<a name="run(org.apache.spark.rdd.RDD)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.mllib.regression">IsotonicRegressionModel</a>&nbsp;run(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple3&lt;java.lang.Object,java.lang.Object,java.lang.Object&gt;&gt;&nbsp;input)</pre>
<div class="block">Run IsotonicRegression algorithm to obtain isotonic regression model.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - RDD of tuples (label, feature, weight) where label is dependent variable
              for which we calculate isotonic regression, feature is independent variable
              and weight represents number of measures with default 1.
              If multiple labels share the same feature value then they are ordered before
              the algorithm is executed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Isotonic regression model.</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;<a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.mllib.regression">IsotonicRegressionModel</a>&nbsp;run(<a href="../../../../../org/apache/spark/api/java/JavaRDD.html" title="class in org.apache.spark.api.java">JavaRDD</a>&lt;scala.Tuple3&lt;java.lang.Double,java.lang.Double,java.lang.Double&gt;&gt;&nbsp;input)</pre>
<div class="block">Run pool adjacent violators algorithm to obtain isotonic regression model.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - JavaRDD of tuples (label, feature, weight) where label is dependent variable
              for which we calculate isotonic regression, feature is independent variable
              and weight represents number of measures with default 1.
              If multiple labels share the same feature value then they are ordered before
              the algorithm is executed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Isotonic regression model.</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/regression/GeneralizedLinearModel.html" title="class in org.apache.spark.mllib.regression"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/regression/IsotonicRegressionModel.html" title="class in org.apache.spark.mllib.regression"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/regression/IsotonicRegression.html" target="_top">Frames</a></li>
<li><a href="IsotonicRegression.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>