| <!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 (1.8.0_312) on Mon Jul 11 16:23:57 UTC 2022 --> |
| <title>RandomForestRegressionModel (Spark 3.2.2 JavaDoc)</title> |
| <meta name="date" content="2022-07-11"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RandomForestRegressionModel (Spark 3.2.2 JavaDoc)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":9,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/regression/PMMLLinearRegressionModelWriter.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressor.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/spark/ml/regression/RandomForestRegressionModel.html" target="_top">Frames</a></li> |
| <li><a href="RandomForestRegressionModel.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.regression</div> |
| <h2 title="Class RandomForestRegressionModel" class="title">Class RandomForestRegressionModel</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">org.apache.spark.ml.PipelineStage</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Transformer</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Model</a><M></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/PredictionModel.html" title="class in org.apache.spark.ml">org.apache.spark.ml.PredictionModel</a><FeaturesType,M></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/regression/RegressionModel.html" title="class in org.apache.spark.ml.regression">org.apache.spark.ml.regression.RegressionModel</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.spark.ml.regression.RandomForestRegressionModel</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, org.apache.spark.internal.Logging, <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html" title="interface in org.apache.spark.ml.param.shared">HasCheckpointInterval</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html" title="interface in org.apache.spark.ml.param.shared">HasFeaturesCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html" title="interface in org.apache.spark.ml.param.shared">HasLabelCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html" title="interface in org.apache.spark.ml.param.shared">HasPredictionCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html" title="interface in org.apache.spark.ml.param.shared">HasSeed</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html" title="interface in org.apache.spark.ml.param.shared">HasWeightCol</a>, <a href="../../../../../org/apache/spark/ml/PredictorParams.html" title="interface in org.apache.spark.ml">PredictorParams</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a>, <a href="../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html" title="interface in org.apache.spark.ml.tree">HasVarianceImpurity</a>, <a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html" title="interface in org.apache.spark.ml.tree">RandomForestParams</a>, <a href="../../../../../org/apache/spark/ml/tree/RandomForestRegressorParams.html" title="interface in org.apache.spark.ml.tree">RandomForestRegressorParams</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleModel</a><<a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleParams</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleRegressorParams.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleRegressorParams</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeRegressorParams.html" title="interface in org.apache.spark.ml.tree">TreeRegressorParams</a>, <a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a>, <a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RandomForestRegressionModel</span> |
| extends <a href="../../../../../org/apache/spark/ml/regression/RegressionModel.html" title="class in org.apache.spark.ml.regression">RegressionModel</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>> |
| implements <a href="../../../../../org/apache/spark/ml/tree/RandomForestRegressorParams.html" title="interface in org.apache.spark.ml.tree">RandomForestRegressorParams</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleModel</a><<a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>>, <a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a>, scala.Serializable</pre> |
| <div class="block"><a href="http://en.wikipedia.org/wiki/Random_forest">Random Forest</a> model for regression. |
| It supports both continuous and categorical features. |
| <p> |
| param: _trees Decision trees in the ensemble. |
| param: numFeatures Number of features used by this model</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.spark.ml.regression.RandomForestRegressionModel">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#bootstrap--">bootstrap</a></span>()</code> |
| <div class="block">Whether bootstrap samples are used when building trees.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#cacheNodeIds--">cacheNodeIds</a></span>()</code> |
| <div class="block">If false, the algorithm will pass trees to executors to match instances with nodes.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#checkpointInterval--">checkpointInterval</a></span>()</code> |
| <div class="block">Param for set checkpoint interval (&gt;= 1) or disable checkpoint (-1).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></span>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> extra)</code> |
| <div class="block">Creates a copy of this instance with the same UID and some extra params.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#featureImportances--">featureImportances</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#featureSubsetStrategy--">featureSubsetStrategy</a></span>()</code> |
| <div class="block">The number of features to consider for splits at each tree node.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#impurity--">impurity</a></span>()</code> |
| <div class="block">Criterion used for information gain calculation (case-insensitive).</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#leafCol--">leafCol</a></span>()</code> |
| <div class="block">Leaf indices column name.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#load-java.lang.String-">load</a></span>(String path)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#maxBins--">maxBins</a></span>()</code> |
| <div class="block">Maximum number of bins used for discretizing continuous features and for choosing how to split |
| on features at each node.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#maxDepth--">maxDepth</a></span>()</code> |
| <div class="block">Maximum depth of the tree (nonnegative).</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#maxMemoryInMB--">maxMemoryInMB</a></span>()</code> |
| <div class="block">Maximum memory in MB allocated to histogram aggregation.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#minInfoGain--">minInfoGain</a></span>()</code> |
| <div class="block">Minimum information gain for a split to be considered at a tree node.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#minInstancesPerNode--">minInstancesPerNode</a></span>()</code> |
| <div class="block">Minimum number of instances each child must have after split.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#minWeightFractionPerNode--">minWeightFractionPerNode</a></span>()</code> |
| <div class="block">Minimum fraction of the weighted sample count that each child must have after split.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#numFeatures--">numFeatures</a></span>()</code> |
| <div class="block">Returns the number of features the model was trained on.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#numTrees--">numTrees</a></span>()</code> |
| <div class="block">Number of trees to train (at least 1).</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#predict-org.apache.spark.ml.linalg.Vector-">predict</a></span>(<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a> features)</code> |
| <div class="block">Predict label for the given features.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a><<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#read--">read</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param">LongParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#seed--">seed</a></span>()</code> |
| <div class="block">Param for random seed.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#subsamplingRate--">subsamplingRate</a></span>()</code> |
| <div class="block">Fraction of the training data used for learning each decision tree, in range (0, 1].</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#toString--">toString</a></span>()</code> |
| <div class="block">Summary of the model</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#totalNumNodes--">totalNumNodes</a></span>()</code> |
| <div class="block">Total number of nodes, summed over all trees in the ensemble.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a><<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#transform-org.apache.spark.sql.Dataset-">transform</a></span>(<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a><?> dataset)</code> |
| <div class="block">Transforms dataset by reading from <code>featuresCol</code>, calling <code>predict</code>, and storing |
| the predictions as a new column <code>predictionCol</code>.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#transformSchema-org.apache.spark.sql.types.StructType-">transformSchema</a></span>(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> schema)</code> |
| <div class="block">Check transform validity and derive the output schema from the input schema.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#trees--">trees</a></span>()</code> |
| <div class="block">Trees in this ensemble.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#treeWeights--">treeWeights</a></span>()</code> |
| <div class="block">Weights for each tree, zippable with <code>trees</code></div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#uid--">uid</a></span>()</code> |
| <div class="block">An immutable unique ID for the object and its derivatives.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#weightCol--">weightCol</a></span>()</code> |
| <div class="block">Param for weight column name.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/util/MLWriter.html" title="class in org.apache.spark.ml.util">MLWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html#write--">write</a></span>()</code> |
| <div class="block">Returns an <code>MLWriter</code> instance for this ML instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.PredictionModel"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/PredictionModel.html" title="class in org.apache.spark.ml">PredictionModel</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#featuresCol--">featuresCol</a>, <a href="../../../../../org/apache/spark/ml/PredictionModel.html#labelCol--">labelCol</a>, <a href="../../../../../org/apache/spark/ml/PredictionModel.html#predictionCol--">predictionCol</a>, <a href="../../../../../org/apache/spark/ml/PredictionModel.html#setFeaturesCol-java.lang.String-">setFeaturesCol</a>, <a href="../../../../../org/apache/spark/ml/PredictionModel.html#setPredictionCol-java.lang.String-">setPredictionCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.Model"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/Model.html#hasParent--">hasParent</a>, <a href="../../../../../org/apache/spark/ml/Model.html#parent--">parent</a>, <a href="../../../../../org/apache/spark/ml/Model.html#setParent-org.apache.spark.ml.Estimator-">setParent</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.Transformer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">Transformer</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-">transform</a>, <a href="../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-">transform</a>, <a href="../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-">transform</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.PipelineStage"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/PipelineStage.html#params--">params</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class Object</h3> |
| <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.tree.RandomForestParams"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.tree.<a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html" title="interface in org.apache.spark.ml.tree">RandomForestParams</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html#getBootstrap--">getBootstrap</a>, <a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html#getNumTrees--">getNumTrees</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.tree.TreeEnsembleRegressorParams"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.tree.<a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleRegressorParams.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleRegressorParams</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleRegressorParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-">validateAndTransformSchema</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.tree.TreeEnsembleParams"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.tree.<a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleParams</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#getFeatureSubsetStrategy--">getFeatureSubsetStrategy</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#getOldStrategy-scala.collection.immutable.Map-int-scala.Enumeration.Value-org.apache.spark.mllib.tree.impurity.Impurity-">getOldStrategy</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#getSubsamplingRate--">getSubsamplingRate</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.tree.DecisionTreeParams"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.tree.<a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getCacheNodeIds--">getCacheNodeIds</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getLeafCol--">getLeafCol</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMaxBins--">getMaxBins</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMaxDepth--">getMaxDepth</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMaxMemoryInMB--">getMaxMemoryInMB</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMinInfoGain--">getMinInfoGain</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMinInstancesPerNode--">getMinInstancesPerNode</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMinWeightFractionPerNode--">getMinWeightFractionPerNode</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getOldStrategy-scala.collection.immutable.Map-int-scala.Enumeration.Value-org.apache.spark.mllib.tree.impurity.Impurity-double-">getOldStrategy</a>, <a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#setLeafCol-java.lang.String-">setLeafCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.PredictorParams"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/PredictorParams.html" title="interface in org.apache.spark.ml">PredictorParams</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/PredictorParams.html#extractInstances-org.apache.spark.sql.Dataset-">extractInstances</a>, <a href="../../../../../org/apache/spark/ml/PredictorParams.html#extractInstances-org.apache.spark.sql.Dataset-scala.Function1-">extractInstances</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasLabelCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html" title="interface in org.apache.spark.ml.param.shared">HasLabelCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#getLabelCol--">getLabelCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#labelCol--">labelCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasFeaturesCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html" title="interface in org.apache.spark.ml.param.shared">HasFeaturesCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#featuresCol--">featuresCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#getFeaturesCol--">getFeaturesCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasPredictionCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html" title="interface in org.apache.spark.ml.param.shared">HasPredictionCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#getPredictionCol--">getPredictionCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#predictionCol--">predictionCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.Params"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-">clear</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-">copyValues</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-">defaultCopy</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--">defaultParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-">explainParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParams--">explainParams</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-">get</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-">getDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-">getOrDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-">getParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-">hasDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-">hasParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-">isDefined</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-">isSet</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#paramMap--">paramMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#params--">params</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-">shouldOwn</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasCheckpointInterval"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html" title="interface in org.apache.spark.ml.param.shared">HasCheckpointInterval</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html#getCheckpointInterval--">getCheckpointInterval</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasSeed"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html" title="interface in org.apache.spark.ml.param.shared">HasSeed</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html#getSeed--">getSeed</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasWeightCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html" title="interface in org.apache.spark.ml.param.shared">HasWeightCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#getWeightCol--">getWeightCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.tree.HasVarianceImpurity"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.tree.<a href="../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html" title="interface in org.apache.spark.ml.tree">HasVarianceImpurity</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html#getImpurity--">getImpurity</a>, <a href="../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html#getOldImpurity--">getOldImpurity</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.tree.TreeEnsembleModel"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.tree.<a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleModel</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#getLeafField-java.lang.String-">getLeafField</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#javaTreeWeights--">javaTreeWeights</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#predictLeaf-org.apache.spark.ml.linalg.Vector-">predictLeaf</a>, <a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#toDebugString--">toDebugString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.util.MLWritable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.util.<a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html#save-java.lang.String-">save</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.internal.Logging"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.internal.Logging</h3> |
| <code>$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="read--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public static <a href="../../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a><<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>> read()</pre> |
| </li> |
| </ul> |
| <a name="load-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public static <a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a> load(String path)</pre> |
| </li> |
| </ul> |
| <a name="totalNumNodes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>totalNumNodes</h4> |
| <pre>public int totalNumNodes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#totalNumNodes--">TreeEnsembleModel</a></code></span></div> |
| <div class="block">Total number of nodes, summed over all trees in the ensemble.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#totalNumNodes--">totalNumNodes</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleModel</a><<a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="impurity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>impurity</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> impurity()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html#impurity--">HasVarianceImpurity</a></code></span></div> |
| <div class="block">Criterion used for information gain calculation (case-insensitive). |
| This impurity type is used in DecisionTreeRegressor, RandomForestRegressor, GBTRegressor |
| and GBTClassifier (since GBTClassificationModel is internally composed of |
| DecisionTreeRegressionModels). |
| Supported: "variance". |
| (default = variance)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html#impurity--">impurity</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html" title="interface in org.apache.spark.ml.tree">HasVarianceImpurity</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="numTrees--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>numTrees</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> numTrees()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html#numTrees--">RandomForestParams</a></code></span></div> |
| <div class="block">Number of trees to train (at least 1). |
| If 1, then no bootstrapping is used. If greater than 1, then bootstrapping is done. |
| TODO: Change to always do bootstrapping (simpler). SPARK-7130 |
| (default = 20) |
| <p> |
| Note: The reason that we cannot add this to both GBT and RF (i.e. in TreeEnsembleParams) |
| is the param <code>maxIter</code> controls how many trees a GBT has. The semantics in the algorithms |
| are a bit different.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html#numTrees--">numTrees</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html" title="interface in org.apache.spark.ml.tree">RandomForestParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="bootstrap--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bootstrap</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a> bootstrap()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html#bootstrap--">RandomForestParams</a></code></span></div> |
| <div class="block">Whether bootstrap samples are used when building trees.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html#bootstrap--">bootstrap</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/RandomForestParams.html" title="interface in org.apache.spark.ml.tree">RandomForestParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="subsamplingRate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subsamplingRate</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> subsamplingRate()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#subsamplingRate--">TreeEnsembleParams</a></code></span></div> |
| <div class="block">Fraction of the training data used for learning each decision tree, in range (0, 1]. |
| (default = 1.0)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#subsamplingRate--">subsamplingRate</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="featureSubsetStrategy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>featureSubsetStrategy</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> featureSubsetStrategy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#featureSubsetStrategy--">TreeEnsembleParams</a></code></span></div> |
| <div class="block">The number of features to consider for splits at each tree node. |
| Supported options: |
| - "auto": Choose automatically for task: |
| If numTrees == 1, set to "all." |
| If numTrees greater than 1 (forest), set to "sqrt" for classification and |
| to "onethird" for regression. |
| - "all": use all features |
| - "onethird": use 1/3 of the features |
| - "sqrt": use sqrt(number of features) |
| - "log2": use log2(number of features) |
| - "n": when n is in the range (0, 1.0], use n * number of features. When n |
| is in the range (1, number of features), use n features. |
| (default = "auto") |
| <p> |
| These various settings are based on the following references: |
| - log2: tested in Breiman (2001) |
| - sqrt: recommended by Breiman manual for random forests |
| - The defaults of sqrt (classification) and onethird (regression) match the R randomForest |
| package.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#featureSubsetStrategy--">featureSubsetStrategy</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://www.stat.berkeley.edu/~breiman/randomforest2001.pdf">Breiman (2001)</a>, |
| <a href="http://www.stat.berkeley.edu/~breiman/Using_random_forests_V3.1.pdf"> |
| Breiman manual for random forests</a> |
| <p></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="leafCol--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>leafCol</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> leafCol()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#leafCol--">DecisionTreeParams</a></code></span></div> |
| <div class="block">Leaf indices column name. |
| Predicted leaf index of each instance in each tree by preorder. |
| (default = "")</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#leafCol--">leafCol</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxDepth</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> maxDepth()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxDepth--">DecisionTreeParams</a></code></span></div> |
| <div class="block">Maximum depth of the tree (nonnegative). |
| E.g., depth 0 means 1 leaf node; depth 1 means 1 internal node + 2 leaf nodes. |
| (default = 5)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxDepth--">maxDepth</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxBins--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxBins</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> maxBins()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxBins--">DecisionTreeParams</a></code></span></div> |
| <div class="block">Maximum number of bins used for discretizing continuous features and for choosing how to split |
| on features at each node. More bins give higher granularity. |
| Must be at least 2 and at least number of categories in any categorical feature. |
| (default = 32)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxBins--">maxBins</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minInstancesPerNode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minInstancesPerNode</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> minInstancesPerNode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minInstancesPerNode--">DecisionTreeParams</a></code></span></div> |
| <div class="block">Minimum number of instances each child must have after split. |
| If a split causes the left or right child to have fewer than minInstancesPerNode, |
| the split will be discarded as invalid. |
| Must be at least 1. |
| (default = 1)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minInstancesPerNode--">minInstancesPerNode</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minWeightFractionPerNode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minWeightFractionPerNode</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> minWeightFractionPerNode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minWeightFractionPerNode--">DecisionTreeParams</a></code></span></div> |
| <div class="block">Minimum fraction of the weighted sample count that each child must have after split. |
| If a split causes the fraction of the total weight in the left or right child to be less than |
| minWeightFractionPerNode, the split will be discarded as invalid. |
| Should be in the interval [0.0, 0.5). |
| (default = 0.0)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minWeightFractionPerNode--">minWeightFractionPerNode</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minInfoGain--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minInfoGain</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> minInfoGain()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minInfoGain--">DecisionTreeParams</a></code></span></div> |
| <div class="block">Minimum information gain for a split to be considered at a tree node. |
| Should be at least 0.0. |
| (default = 0.0)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minInfoGain--">minInfoGain</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxMemoryInMB--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxMemoryInMB</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> maxMemoryInMB()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxMemoryInMB--">DecisionTreeParams</a></code></span></div> |
| <div class="block">Maximum memory in MB allocated to histogram aggregation. If too small, then 1 node will be |
| split per iteration, and its aggregates may exceed this size. |
| (default = 256 MB)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxMemoryInMB--">maxMemoryInMB</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cacheNodeIds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cacheNodeIds</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a> cacheNodeIds()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#cacheNodeIds--">DecisionTreeParams</a></code></span></div> |
| <div class="block">If false, the algorithm will pass trees to executors to match instances with nodes. |
| If true, the algorithm will cache node IDs for each instance. |
| Caching can speed up training of deeper trees. Users can set how often should the |
| cache be checkpointed or disable it by setting checkpointInterval. |
| (default = false)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#cacheNodeIds--">cacheNodeIds</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html" title="interface in org.apache.spark.ml.tree">DecisionTreeParams</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="weightCol--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>weightCol</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> weightCol()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#weightCol--">HasWeightCol</a></code></span></div> |
| <div class="block">Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#weightCol--">weightCol</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html" title="interface in org.apache.spark.ml.param.shared">HasWeightCol</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="seed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>seed</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/LongParam.html" title="class in org.apache.spark.ml.param">LongParam</a> seed()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--">HasSeed</a></code></span></div> |
| <div class="block">Param for random seed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--">seed</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasSeed.html" title="interface in org.apache.spark.ml.param.shared">HasSeed</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkpointInterval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkpointInterval</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> checkpointInterval()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html#checkpointInterval--">HasCheckpointInterval</a></code></span></div> |
| <div class="block">Param for set checkpoint interval (&gt;= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations. Note: this setting will be ignored if the checkpoint directory is not set in the SparkContext.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html#checkpointInterval--">checkpointInterval</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html" title="interface in org.apache.spark.ml.param.shared">HasCheckpointInterval</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="uid--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>uid</h4> |
| <pre>public String uid()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid--">Identifiable</a></code></span></div> |
| <div class="block">An immutable unique ID for the object and its derivatives.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid--">uid</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="numFeatures--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>numFeatures</h4> |
| <pre>public int numFeatures()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#numFeatures--">PredictionModel</a></code></span></div> |
| <div class="block">Returns the number of features the model was trained on. If unknown, returns -1</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#numFeatures--">numFeatures</a></code> in class <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html" title="class in org.apache.spark.ml">PredictionModel</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="trees--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trees</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>[] trees()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#trees--">TreeEnsembleModel</a></code></span></div> |
| <div class="block">Trees in this ensemble. Warning: These have null parent Estimators.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#trees--">trees</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleModel</a><<a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="treeWeights--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>treeWeights</h4> |
| <pre>public double[] treeWeights()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#treeWeights--">TreeEnsembleModel</a></code></span></div> |
| <div class="block">Weights for each tree, zippable with <code>trees</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#treeWeights--">treeWeights</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleModel</a><<a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transformSchema-org.apache.spark.sql.types.StructType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transformSchema</h4> |
| <pre>public <a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> transformSchema(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> schema)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/spark/ml/PipelineStage.html#transformSchema-org.apache.spark.sql.types.StructType-">PipelineStage</a></code></span></div> |
| <div class="block">Check transform validity and derive the output schema from the input schema. |
| <p> |
| We check validity for interactions between parameters during <code>transformSchema</code> and |
| raise an exception if any parameter value is invalid. Parameter value checks which |
| do not depend on other parameters are handled by <code>Param.validate()</code>. |
| <p> |
| Typical implementation should first conduct verification on schema change and parameter |
| validity, including complex parameter interaction checks.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#transformSchema-org.apache.spark.sql.types.StructType-">transformSchema</a></code> in class <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html" title="class in org.apache.spark.ml">PredictionModel</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transform-org.apache.spark.sql.Dataset-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transform</h4> |
| <pre>public <a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a><<a href="../../../../../org/apache/spark/sql/Row.html" title="interface in org.apache.spark.sql">Row</a>> transform(<a href="../../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a><?> dataset)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#transform-org.apache.spark.sql.Dataset-">PredictionModel</a></code></span></div> |
| <div class="block">Transforms dataset by reading from <code>featuresCol</code>, calling <code>predict</code>, and storing |
| the predictions as a new column <code>predictionCol</code>. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#transform-org.apache.spark.sql.Dataset-">transform</a></code> in class <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html" title="class in org.apache.spark.ml">PredictionModel</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataset</code> - input dataset</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>transformed dataset with <code>predictionCol</code> of type <code>Double</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="predict-org.apache.spark.ml.linalg.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>predict</h4> |
| <pre>public double predict(<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a> features)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#predict-FeaturesType-">PredictionModel</a></code></span></div> |
| <div class="block">Predict label for the given features. |
| This method is used to implement <code>transform()</code> and output <code>predictionCol</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/PredictionModel.html#predict-FeaturesType-">predict</a></code> in class <code><a href="../../../../../org/apache/spark/ml/PredictionModel.html" title="class in org.apache.spark.ml">PredictionModel</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>features</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy-org.apache.spark.ml.param.ParamMap-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a> copy(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> extra)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-">Params</a></code></span></div> |
| <div class="block">Creates a copy of this instance with the same UID and some extra params. |
| Subclasses should implement this method and set the return type properly. |
| See <code>defaultCopy()</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/Model.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></code> in class <code><a href="../../../../../org/apache/spark/ml/Model.html" title="class in org.apache.spark.ml">Model</a><<a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressionModel.html" title="class in org.apache.spark.ml.regression">RandomForestRegressionModel</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>extra</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public String toString()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#toString--">TreeEnsembleModel</a></code></span></div> |
| <div class="block">Summary of the model</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html#toString--">toString</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/tree/TreeEnsembleModel.html" title="interface in org.apache.spark.ml.tree">TreeEnsembleModel</a><<a href="../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html" title="class in org.apache.spark.ml.regression">DecisionTreeRegressionModel</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#toString--">toString</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="featureImportances--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>featureImportances</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a> featureImportances()</pre> |
| </li> |
| </ul> |
| <a name="write--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/util/MLWriter.html" title="class in org.apache.spark.ml.util">MLWriter</a> write()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html#write--">MLWritable</a></code></span></div> |
| <div class="block">Returns an <code>MLWriter</code> instance for this ML instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html#write--">write</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></code></dd> |
| <dt><span class="returnLabel">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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/regression/PMMLLinearRegressionModelWriter.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/spark/ml/regression/RandomForestRegressor.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/spark/ml/regression/RandomForestRegressionModel.html" target="_top">Frames</a></li> |
| <li><a href="RandomForestRegressionModel.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
