|
|
<!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:13 PDT 2015 -->
<title>ParamGridBuilder</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="ParamGridBuilder";
}
//-->
</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/tuning/CrossValidatorModel.html" title="class in org.apache.spark.ml.tuning"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/tuning/TrainValidationSplit.html" title="class in org.apache.spark.ml.tuning"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/tuning/ParamGridBuilder.html" target="_top">Frames</a></li>
<li><a href="ParamGridBuilder.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.tuning</div>
<h2 title="Class ParamGridBuilder" class="title">Class ParamGridBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ml.tuning.ParamGridBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ParamGridBuilder</span>
extends java.lang.Object</pre>
<div class="block">:: Experimental ::
Builder for a param grid used in grid search-based model selection.</div>
</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"> </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/tuning/ParamGridBuilder.html#ParamGridBuilder()">ParamGridBuilder</a></strong>()</code> </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"> </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/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#addGrid(org.apache.spark.ml.param.BooleanParam)">addGrid</a></strong>(<a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a> param)</code>
<div class="block">Adds a boolean param with true and false.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#addGrid(org.apache.spark.ml.param.DoubleParam, double[])">addGrid</a></strong>(<a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> param,
double[] values)</code>
<div class="block">Adds a double param with multiple values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#addGrid(org.apache.spark.ml.param.FloatParam, float[])">addGrid</a></strong>(<a href="../../../../../org/apache/spark/ml/param/FloatParam.html" title="class in org.apache.spark.ml.param">FloatParam</a> param,
float[] values)</code>
<div class="block">Adds a float param with multiple values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#addGrid(org.apache.spark.ml.param.IntParam, int[])">addGrid</a></strong>(<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> param,
int[] values)</code>
<div class="block">Adds a int param with multiple values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#addGrid(org.apache.spark.ml.param.LongParam, long[])">addGrid</a></strong>(<a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param">LongParam</a> param,
long[] values)</code>
<div class="block">Adds a long param with multiple values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#addGrid(org.apache.spark.ml.param.Param, scala.collection.Iterable)">addGrid</a></strong>(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param,
scala.collection.Iterable<T> values)</code>
<div class="block">Adds a param with multiple values (overwrites if the input param exists).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#baseOn(org.apache.spark.ml.param.ParamMap)">baseOn</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> paramMap)</code>
<div class="block">Sets the given parameters in this grid to fixed values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#baseOn(org.apache.spark.ml.param.ParamPair...)">baseOn</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>... paramPairs)</code>
<div class="block">Sets the given parameters in this grid to fixed values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#baseOn(scala.collection.Seq)">baseOn</a></strong>(scala.collection.Seq<<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>> paramPairs)</code>
<div class="block">Sets the given parameters in this grid to fixed values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html#build()">build</a></strong>()</code>
<div class="block">Builds and returns all combinations of parameters specified by the param grid.</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 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="ParamGridBuilder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParamGridBuilder</h4>
<pre>public ParamGridBuilder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="baseOn(org.apache.spark.ml.param.ParamPair...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baseOn</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> baseOn(<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>... paramPairs)</pre>
<div class="block">Sets the given parameters in this grid to fixed values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paramPairs</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="baseOn(org.apache.spark.ml.param.ParamMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baseOn</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> baseOn(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> paramMap)</pre>
<div class="block">Sets the given parameters in this grid to fixed values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paramMap</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="baseOn(scala.collection.Seq)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baseOn</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> baseOn(scala.collection.Seq<<a href="../../../../../org/apache/spark/ml/param/ParamPair.html" title="class in org.apache.spark.ml.param">ParamPair</a><?>> paramPairs)</pre>
<div class="block">Sets the given parameters in this grid to fixed values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paramPairs</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="addGrid(org.apache.spark.ml.param.Param, scala.collection.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGrid</h4>
<pre>public <T> <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> addGrid(<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><T> param,
scala.collection.Iterable<T> values)</pre>
<div class="block">Adds a param with multiple values (overwrites if the input param exists).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>values</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="addGrid(org.apache.spark.ml.param.DoubleParam, double[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGrid</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> addGrid(<a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> param,
double[] values)</pre>
<div class="block">Adds a double param with multiple values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>values</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="addGrid(org.apache.spark.ml.param.IntParam, int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGrid</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> addGrid(<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> param,
int[] values)</pre>
<div class="block">Adds a int param with multiple values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>values</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="addGrid(org.apache.spark.ml.param.FloatParam, float[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGrid</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> addGrid(<a href="../../../../../org/apache/spark/ml/param/FloatParam.html" title="class in org.apache.spark.ml.param">FloatParam</a> param,
float[] values)</pre>
<div class="block">Adds a float param with multiple values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>values</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="addGrid(org.apache.spark.ml.param.LongParam, long[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGrid</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> addGrid(<a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param">LongParam</a> param,
long[] values)</pre>
<div class="block">Adds a long param with multiple values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd><dd><code>values</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="addGrid(org.apache.spark.ml.param.BooleanParam)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGrid</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/tuning/ParamGridBuilder.html" title="class in org.apache.spark.ml.tuning">ParamGridBuilder</a> addGrid(<a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a> param)</pre>
<div class="block">Adds a boolean param with true and false.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>[] build()</pre>
<div class="block">Builds and returns all combinations of parameters specified by the param grid.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</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/tuning/CrossValidatorModel.html" title="class in org.apache.spark.ml.tuning"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/tuning/TrainValidationSplit.html" title="class in org.apache.spark.ml.tuning"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/tuning/ParamGridBuilder.html" target="_top">Frames</a></li>
<li><a href="ParamGridBuilder.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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>
|