Google Git
Sign in
apache / spark-website / 2c562896505588421cce257d111c8ba3805528c2 / . / site / docs / 3.4.3 / api / java / org / apache / spark / ml / Pipeline.html
blob: 7ebf918c5d9288e86e2b1205a551459c323b91a1 [file] [log] [blame]
<!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_402) on Mon Apr 15 02:01:49 UTC 2024 -->
<title>Pipeline (Spark 3.4.3 JavaDoc)</title>
<meta name="date" content="2024-04-15">
<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="Pipeline (Spark 3.4.3 JavaDoc)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/Model.html" title="class in org.apache.spark.ml"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/spark/ml/Pipeline.SharedReadWrite$.html" title="class in org.apache.spark.ml"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/ml/Pipeline.html" target="_top">Frames</a></li>
<li><a href="Pipeline.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.ml</div>
<h2 title="Class Pipeline" class="title">Class Pipeline</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/Estimator.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Estimator</a>&lt;<a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml">PipelineModel</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ml.Pipeline</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/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">Pipeline</span>
extends <a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a>&lt;<a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml">PipelineModel</a>&gt;
implements <a href="../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></pre>
<div class="block">A simple pipeline, which acts as an estimator. A Pipeline consists of a sequence of stages, each
of which is either an <a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml"><code>Estimator</code></a> or a <a href="../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml"><code>Transformer</code></a>. When <code>Pipeline.fit</code> is called, the
stages are executed in order. If a stage is an <a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml"><code>Estimator</code></a>, its <code>Estimator.fit</code> method will
be called on the input dataset to fit a model. Then the model, which is a transformer, will be
used to transform the dataset as the input to the next stage. If a stage is a <a href="../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml"><code>Transformer</code></a>,
its <code>Transformer.transform</code> method will be called to produce the dataset for the next stage.
The fitted model from a <a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml"><code>Pipeline</code></a> is a <a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml"><code>PipelineModel</code></a>, which consists of fitted models and
transformers, corresponding to the pipeline stages. If there are no stages, the pipeline acts as
an identity transformer.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.spark.ml.Pipeline">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.SharedReadWrite$.html" title="class in org.apache.spark.ml">Pipeline.SharedReadWrite$</a></span></code>
<div class="block">Methods for <code>MLReader</code> and <code>MLWriter</code> shared between <a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml"><code>Pipeline</code></a> and <a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml"><code>PipelineModel</code></a></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.spark.internal.Logging">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.spark.internal.Logging</h3>
<code>org.apache.spark.internal.Logging.SparkShellLoggingFilter</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#Pipeline--">Pipeline</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#Pipeline-java.lang.String-">Pipeline</a></span>(String&nbsp;uid)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.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>&nbsp;extra)</code>
<div class="block">Creates a copy of this instance with the same UID and some extra params.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml">PipelineModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#fit-org.apache.spark.sql.Dataset-">fit</a></span>(<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;dataset)</code>
<div class="block">Fits the pipeline to the input dataset with additional parameters.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#getStages--">getStages</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#load-java.lang.String-">load</a></span>(String&nbsp;path)</code>&nbsp;</td>
</tr>
<tr id="i4" 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>&lt;<a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#read--">read</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#setStages-org.apache.spark.ml.PipelineStage:A-">setStages</a></span>(<a href="../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a>[]&nbsp;value)</code>&nbsp;</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>&lt;<a href="../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a>[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#stages--">stages</a></span>()</code>
<div class="block">param for pipeline stages</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<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/Pipeline.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>&nbsp;schema)</code>
<div class="block">Check transform validity and derive the output schema from the input schema.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/spark/ml/Pipeline.html#uid--">uid</a></span>()</code>
<div class="block">An immutable unique ID for the object and its derivatives.</div>
</td>
</tr>
<tr id="i9" 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/Pipeline.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.Estimator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.ml.<a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a></h3>
<code><a href="../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-">fit</a>, <a href="../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-">fit</a>, <a href="../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-">fit</a>, <a href="../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-scala.collection.Seq-">fit</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&nbsp;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&nbsp;Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.util.MLWritable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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.ml.param.Params">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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#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#onParamChange-org.apache.spark.ml.param.Param-">onParamChange</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.util.Identifiable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.util.<a href="../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></h3>
<code><a href="../../../../org/apache/spark/ml/util/Identifiable.html#toString--">toString</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&nbsp;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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Pipeline-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Pipeline</h4>
<pre>public&nbsp;Pipeline(String&nbsp;uid)</pre>
</li>
</ul>
<a name="Pipeline--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Pipeline</h4>
<pre>public&nbsp;Pipeline()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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&nbsp;<a href="../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a>&lt;<a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a>&gt;&nbsp;read()</pre>
</li>
</ul>
<a name="load-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a>&nbsp;load(String&nbsp;path)</pre>
</li>
</ul>
<a name="uid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uid</h4>
<pre>public&nbsp;String&nbsp;uid()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="stages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stages</h4>
<pre>public&nbsp;<a href="../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;<a href="../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a>[]&gt;&nbsp;stages()</pre>
<div class="block">param for pipeline stages</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="setStages-org.apache.spark.ml.PipelineStage:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStages</h4>
<pre>public&nbsp;<a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a>&nbsp;setStages(<a href="../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a>[]&nbsp;value)</pre>
</li>
</ul>
<a name="getStages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStages</h4>
<pre>public&nbsp;<a href="../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a>[]&nbsp;getStages()</pre>
</li>
</ul>
<a name="fit-org.apache.spark.sql.Dataset-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fit</h4>
<pre>public&nbsp;<a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml">PipelineModel</a>&nbsp;fit(<a href="../../../../org/apache/spark/sql/Dataset.html" title="class in org.apache.spark.sql">Dataset</a>&lt;?&gt;&nbsp;dataset)</pre>
<div class="block">Fits the pipeline to the input dataset with additional parameters. If a stage is an
<a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml"><code>Estimator</code></a>, its <code>Estimator.fit</code> method will be called on the input dataset to fit a model.
Then the model, which is a transformer, will be used to transform the dataset as the input to
the next stage. If a stage is a <a href="../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml"><code>Transformer</code></a>, its <code>Transformer.transform</code> method will be
called to produce the dataset for the next stage. The fitted model from a <a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml"><code>Pipeline</code></a> is an
<a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml"><code>PipelineModel</code></a>, which consists of fitted models and transformers, corresponding to the
pipeline stages. If there are no stages, the output model acts as an identity transformer.
<p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-">fit</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a>&lt;<a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml">PipelineModel</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataset</code> - input dataset</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>fitted pipeline</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&nbsp;<a href="../../../../org/apache/spark/ml/Pipeline.html" title="class in org.apache.spark.ml">Pipeline</a>&nbsp;copy(<a href="../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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/Estimator.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a>&lt;<a href="../../../../org/apache/spark/ml/PipelineModel.html" title="class in org.apache.spark.ml">PipelineModel</a>&gt;</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="transformSchema-org.apache.spark.sql.types.StructType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transformSchema</h4>
<pre>public&nbsp;<a href="../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a>&nbsp;transformSchema(<a href="../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a>&nbsp;schema)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/spark/ml/PipelineStage.html#transformSchema-org.apache.spark.sql.types.StructType-">transformSchema</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</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="write--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;<a href="../../../../org/apache/spark/ml/util/MLWriter.html" title="class in org.apache.spark.ml.util">MLWriter</a>&nbsp;write()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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/Model.html" title="class in org.apache.spark.ml"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/spark/ml/Pipeline.SharedReadWrite$.html" title="class in org.apache.spark.ml"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/ml/Pipeline.html" target="_top">Frames</a></li>
<li><a href="Pipeline.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../lib/api-javadocs.js"></script></body>
</html>