blob: c840e12e7e2aa1d193c04fbf002daa792de6cd7a [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>MultilayerPerceptronClassificationModel &#8212; PySpark 3.2.2 documentation</title>
<link rel="stylesheet" href="../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css">
<link rel="stylesheet"
href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet"
href="../../_static/vendor/open-sans_all/1.44.1/index.css">
<link rel="stylesheet"
href="../../_static/vendor/lato_latin-ext/1.44.1/index.css">
<link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/pyspark.css" />
<link rel="preload" as="script" href="../../_static/js/index.3da636dd464baa7582d2.js">
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script src="../../_static/copybutton.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="MultilayerPerceptronClassificationSummary" href="pyspark.ml.classification.MultilayerPerceptronClassificationSummary.html" />
<link rel="prev" title="MultilayerPerceptronClassifier" href="pyspark.ml.classification.MultilayerPerceptronClassifier.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
<div class="container-xl">
<a class="navbar-brand" href="../../index.html">
<img src="../../_static/spark-logo-reverse.png" class="logo" alt="logo" />
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
<ul id="navbar-main-elements" class="navbar-nav mr-auto">
<li class="nav-item ">
<a class="nav-link" href="../../getting_started/index.html">Getting Started</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../user_guide/index.html">User Guide</a>
</li>
<li class="nav-item active">
<a class="nav-link" href="../index.html">API Reference</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../development/index.html">Development</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../migration_guide/index.html">Migration Guide</a>
</li>
</ul>
<ul class="navbar-nav">
</ul>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<ul class="nav bd-sidenav">
<li class="">
<a href="../pyspark.sql.html">Spark SQL</a>
</li>
<li class="">
<a href="../pyspark.pandas/index.html">Pandas API on Spark</a>
</li>
<li class="">
<a href="../pyspark.ss.html">Structured Streaming</a>
</li>
<li class="active">
<a href="../pyspark.ml.html">MLlib (DataFrame-based)</a>
</li>
<li class="">
<a href="../pyspark.streaming.html">Spark Streaming</a>
</li>
<li class="">
<a href="../pyspark.mllib.html">MLlib (RDD-based)</a>
</li>
<li class="">
<a href="../pyspark.html">Spark Core</a>
</li>
<li class="">
<a href="../pyspark.resource.html">Resource Management</a>
</li>
</ul>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<nav id="bd-toc-nav">
<ul class="nav section-nav flex-column">
</ul>
</nav>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<div class="section" id="multilayerperceptronclassificationmodel">
<h1>MultilayerPerceptronClassificationModel<a class="headerlink" href="#multilayerperceptronclassificationmodel" title="Permalink to this headline"></a></h1>
<dl class="py class">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel">
<em class="property">class </em><code class="sig-prename descclassname">pyspark.ml.classification.</code><code class="sig-name descname">MultilayerPerceptronClassificationModel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">java_model</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#MultilayerPerceptronClassificationModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel" title="Permalink to this definition"></a></dt>
<dd><p>Model fitted by MultilayerPerceptronClassifier.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 1.6.0.</span></p>
</div>
<p class="rubric">Methods</p>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.clear" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.clear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clear</span></code></a>(param)</p></td>
<td><p>Clears a param from the param map if it has been explicitly set.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.copy" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>([extra])</p></td>
<td><p>Creates a copy of this instance with the same uid and some extra params.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.evaluate" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.evaluate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">evaluate</span></code></a>(dataset)</p></td>
<td><p>Evaluates the model on a test dataset.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParam" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">explainParam</span></code></a>(param)</p></td>
<td><p>Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParams" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">explainParams</span></code></a>()</p></td>
<td><p>Returns the documentation of all params with their optionally default values and user-supplied values.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.extractParamMap" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.extractParamMap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extractParamMap</span></code></a>([extra])</p></td>
<td><p>Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values &lt; user-supplied values &lt; extra.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getBlockSize" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getBlockSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getBlockSize</span></code></a>()</p></td>
<td><p>Gets the value of blockSize or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getFeaturesCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getFeaturesCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFeaturesCol</span></code></a>()</p></td>
<td><p>Gets the value of featuresCol or its default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getInitialWeights" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getInitialWeights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getInitialWeights</span></code></a>()</p></td>
<td><p>Gets the value of initialWeights or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLabelCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLabelCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLabelCol</span></code></a>()</p></td>
<td><p>Gets the value of labelCol or its default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLayers" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLayers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getLayers</span></code></a>()</p></td>
<td><p>Gets the value of layers or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getMaxIter" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getMaxIter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMaxIter</span></code></a>()</p></td>
<td><p>Gets the value of maxIter or its default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getOrDefault" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getOrDefault"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getOrDefault</span></code></a>(param)</p></td>
<td><p>Gets the value of a param in the user-supplied param map or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getParam" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getParam</span></code></a>(paramName)</p></td>
<td><p>Gets a param by its name.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getPredictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getPredictionCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getPredictionCol</span></code></a>()</p></td>
<td><p>Gets the value of predictionCol or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getProbabilityCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getProbabilityCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getProbabilityCol</span></code></a>()</p></td>
<td><p>Gets the value of probabilityCol or its default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getRawPredictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getRawPredictionCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getRawPredictionCol</span></code></a>()</p></td>
<td><p>Gets the value of rawPredictionCol or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSeed" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSeed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSeed</span></code></a>()</p></td>
<td><p>Gets the value of seed or its default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSolver" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSolver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSolver</span></code></a>()</p></td>
<td><p>Gets the value of solver or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getStepSize" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getStepSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getStepSize</span></code></a>()</p></td>
<td><p>Gets the value of stepSize or its default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getThresholds" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getThresholds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getThresholds</span></code></a>()</p></td>
<td><p>Gets the value of thresholds or its default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getTol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getTol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getTol</span></code></a>()</p></td>
<td><p>Gets the value of tol or its default value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasDefault" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasDefault"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasDefault</span></code></a>(param)</p></td>
<td><p>Checks whether a param has a default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasParam" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasParam</span></code></a>(paramName)</p></td>
<td><p>Tests whether this instance contains a param with a given (string) name.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.isDefined" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.isDefined"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isDefined</span></code></a>(param)</p></td>
<td><p>Checks whether a param is explicitly set by user or has a default value.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.isSet" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.isSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isSet</span></code></a>(param)</p></td>
<td><p>Checks whether a param is explicitly set by user.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.load" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.load"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load</span></code></a>(path)</p></td>
<td><p>Reads an ML instance from the input path, a shortcut of <cite>read().load(path)</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predict" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">predict</span></code></a>(value)</p></td>
<td><p>Predict label for the given features.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictProbability" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictProbability"><code class="xref py py-obj docutils literal notranslate"><span class="pre">predictProbability</span></code></a>(value)</p></td>
<td><p>Predict the probability of each class given the features.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictRaw" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictRaw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">predictRaw</span></code></a>(value)</p></td>
<td><p>Raw prediction for each possible label.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.read" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.read"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read</span></code></a>()</p></td>
<td><p>Returns an MLReader instance for this class.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.save" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">save</span></code></a>(path)</p></td>
<td><p>Save this ML instance to the given path, a shortcut of ‘write().save(path)’.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.set" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set</span></code></a>(param, value)</p></td>
<td><p>Sets a parameter in the embedded param map.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setFeaturesCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setFeaturesCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFeaturesCol</span></code></a>(value)</p></td>
<td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">featuresCol</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setPredictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setPredictionCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setPredictionCol</span></code></a>(value)</p></td>
<td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">predictionCol</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setProbabilityCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setProbabilityCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setProbabilityCol</span></code></a>(value)</p></td>
<td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">probabilityCol</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setRawPredictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setRawPredictionCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRawPredictionCol</span></code></a>(value)</p></td>
<td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">rawPredictionCol</span></code></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setThresholds" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setThresholds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setThresholds</span></code></a>(value)</p></td>
<td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds"><code class="xref py py-attr docutils literal notranslate"><span class="pre">thresholds</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.summary" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.summary"><code class="xref py py-obj docutils literal notranslate"><span class="pre">summary</span></code></a>()</p></td>
<td><p>Gets summary (accuracy/precision/recall, objective history, total iterations) of model trained on the training set.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.transform" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transform</span></code></a>(dataset[, params])</p></td>
<td><p>Transforms the input dataset with optional parameters.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.write" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.write"><code class="xref py py-obj docutils literal notranslate"><span class="pre">write</span></code></a>()</p></td>
<td><p>Returns an MLWriter instance for this ML instance.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes</p>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.blockSize" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.blockSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">blockSize</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">featuresCol</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasSummary" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasSummary"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hasSummary</span></code></a></p></td>
<td><p>Indicates whether a training summary exists for this model instance.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.initialWeights" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.initialWeights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initialWeights</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.labelCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.labelCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">labelCol</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.layers" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.layers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">layers</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.maxIter" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.maxIter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">maxIter</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.numClasses" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.numClasses"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numClasses</span></code></a></p></td>
<td><p>Number of classes (values which the label can take).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.numFeatures" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.numFeatures"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numFeatures</span></code></a></p></td>
<td><p>Returns the number of features the model was trained on.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.params" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">params</span></code></a></p></td>
<td><p>Returns all params ordered by name.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">predictionCol</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">probabilityCol</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rawPredictionCol</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.seed" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.seed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seed</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.solver" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.solver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">solver</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.stepSize" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.stepSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stepSize</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">thresholds</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.tol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.tol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tol</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.weights" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.weights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">weights</span></code></a></p></td>
<td><p>the weights of layers.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Methods Documentation</p>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.clear">
<code class="sig-name descname">clear</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.clear" title="Permalink to this definition"></a></dt>
<dd><p>Clears a param from the param map if it has been explicitly set.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.copy">
<code class="sig-name descname">copy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">extra</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.copy" title="Permalink to this definition"></a></dt>
<dd><p>Creates a copy of this instance with the same uid and some
extra params. This implementation first calls Params.copy and
then make a copy of the companion Java pipeline component with
extra params. So both the Python wrapper and the Java pipeline
component get copied.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>extra</strong><span class="classifier">dict, optional</span></dt><dd><p>Extra parameters to copy to the new instance</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><code class="xref py py-class docutils literal notranslate"><span class="pre">JavaParams</span></code></dt><dd><p>Copy of this instance</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.evaluate">
<code class="sig-name descname">evaluate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dataset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#MultilayerPerceptronClassificationModel.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.evaluate" title="Permalink to this definition"></a></dt>
<dd><p>Evaluates the model on a test dataset.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.1.0.</span></p>
</div>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>dataset</strong><span class="classifier"><a class="reference internal" href="pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyspark.sql.DataFrame</span></code></a></span></dt><dd><p>Test dataset to evaluate model on.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParam">
<code class="sig-name descname">explainParam</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParam" title="Permalink to this definition"></a></dt>
<dd><p>Explains a single param and returns its name, doc, and optional
default value and user-supplied value in a string.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParams">
<code class="sig-name descname">explainParams</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.explainParams" title="Permalink to this definition"></a></dt>
<dd><p>Returns the documentation of all params with their optionally
default values and user-supplied values.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.extractParamMap">
<code class="sig-name descname">extractParamMap</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">extra</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.extractParamMap" title="Permalink to this definition"></a></dt>
<dd><p>Extracts the embedded default param values and user-supplied
values, and then merges them with extra values from input into
a flat param map, where the latter value is used if there exist
conflicts, i.e., with ordering: default param values &lt;
user-supplied values &lt; extra.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>extra</strong><span class="classifier">dict, optional</span></dt><dd><p>extra param values</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>dict</dt><dd><p>merged param map</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getBlockSize">
<code class="sig-name descname">getBlockSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getBlockSize" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of blockSize or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getFeaturesCol">
<code class="sig-name descname">getFeaturesCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getFeaturesCol" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of featuresCol or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getInitialWeights">
<code class="sig-name descname">getInitialWeights</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getInitialWeights" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of initialWeights or its default value.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLabelCol">
<code class="sig-name descname">getLabelCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLabelCol" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of labelCol or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLayers">
<code class="sig-name descname">getLayers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getLayers" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of layers or its default value.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 1.6.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getMaxIter">
<code class="sig-name descname">getMaxIter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getMaxIter" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of maxIter or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getOrDefault">
<code class="sig-name descname">getOrDefault</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getOrDefault" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of a param in the user-supplied param map or its
default value. Raises an error if neither is set.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getParam">
<code class="sig-name descname">getParam</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">paramName</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getParam" title="Permalink to this definition"></a></dt>
<dd><p>Gets a param by its name.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getPredictionCol">
<code class="sig-name descname">getPredictionCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getPredictionCol" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of predictionCol or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getProbabilityCol">
<code class="sig-name descname">getProbabilityCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getProbabilityCol" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of probabilityCol or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getRawPredictionCol">
<code class="sig-name descname">getRawPredictionCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getRawPredictionCol" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of rawPredictionCol or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSeed">
<code class="sig-name descname">getSeed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSeed" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of seed or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSolver">
<code class="sig-name descname">getSolver</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getSolver" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of solver or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getStepSize">
<code class="sig-name descname">getStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getStepSize" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of stepSize or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getThresholds">
<code class="sig-name descname">getThresholds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getThresholds" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of thresholds or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.getTol">
<code class="sig-name descname">getTol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.getTol" title="Permalink to this definition"></a></dt>
<dd><p>Gets the value of tol or its default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasDefault">
<code class="sig-name descname">hasDefault</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasDefault" title="Permalink to this definition"></a></dt>
<dd><p>Checks whether a param has a default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasParam">
<code class="sig-name descname">hasParam</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">paramName</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasParam" title="Permalink to this definition"></a></dt>
<dd><p>Tests whether this instance contains a param with a given
(string) name.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.isDefined">
<code class="sig-name descname">isDefined</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.isDefined" title="Permalink to this definition"></a></dt>
<dd><p>Checks whether a param is explicitly set by user or has
a default value.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.isSet">
<code class="sig-name descname">isSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.isSet" title="Permalink to this definition"></a></dt>
<dd><p>Checks whether a param is explicitly set by user.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.load">
<em class="property">classmethod </em><code class="sig-name descname">load</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.load" title="Permalink to this definition"></a></dt>
<dd><p>Reads an ML instance from the input path, a shortcut of <cite>read().load(path)</cite>.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predict">
<code class="sig-name descname">predict</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predict" title="Permalink to this definition"></a></dt>
<dd><p>Predict label for the given features.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictProbability">
<code class="sig-name descname">predictProbability</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictProbability" title="Permalink to this definition"></a></dt>
<dd><p>Predict the probability of each class given the features.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictRaw">
<code class="sig-name descname">predictRaw</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictRaw" title="Permalink to this definition"></a></dt>
<dd><p>Raw prediction for each possible label.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.read">
<em class="property">classmethod </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.read" title="Permalink to this definition"></a></dt>
<dd><p>Returns an MLReader instance for this class.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.save">
<code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.save" title="Permalink to this definition"></a></dt>
<dd><p>Save this ML instance to the given path, a shortcut of ‘write().save(path)’.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span></em>, <em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.set" title="Permalink to this definition"></a></dt>
<dd><p>Sets a parameter in the embedded param map.</p>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setFeaturesCol">
<code class="sig-name descname">setFeaturesCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setFeaturesCol" title="Permalink to this definition"></a></dt>
<dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">featuresCol</span></code></a>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setPredictionCol">
<code class="sig-name descname">setPredictionCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setPredictionCol" title="Permalink to this definition"></a></dt>
<dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">predictionCol</span></code></a>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setProbabilityCol">
<code class="sig-name descname">setProbabilityCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setProbabilityCol" title="Permalink to this definition"></a></dt>
<dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">probabilityCol</span></code></a>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setRawPredictionCol">
<code class="sig-name descname">setRawPredictionCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setRawPredictionCol" title="Permalink to this definition"></a></dt>
<dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">rawPredictionCol</span></code></a>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.setThresholds">
<code class="sig-name descname">setThresholds</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.setThresholds" title="Permalink to this definition"></a></dt>
<dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds" title="pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds"><code class="xref py py-attr docutils literal notranslate"><span class="pre">thresholds</span></code></a>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.0.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.summary">
<code class="sig-name descname">summary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#MultilayerPerceptronClassificationModel.summary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.summary" title="Permalink to this definition"></a></dt>
<dd><p>Gets summary (accuracy/precision/recall, objective history, total iterations) of model
trained on the training set. An exception is thrown if <cite>trainingSummary is None</cite>.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.1.0.</span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.transform">
<code class="sig-name descname">transform</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dataset</span></em>, <em class="sig-param"><span class="n">params</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.transform" title="Permalink to this definition"></a></dt>
<dd><p>Transforms the input dataset with optional parameters.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 1.3.0.</span></p>
</div>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>dataset</strong><span class="classifier"><a class="reference internal" href="pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyspark.sql.DataFrame</span></code></a></span></dt><dd><p>input dataset</p>
</dd>
<dt><strong>params</strong><span class="classifier">dict, optional</span></dt><dd><p>an optional param map that overrides embedded params.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><a class="reference internal" href="pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyspark.sql.DataFrame</span></code></a></dt><dd><p>transformed dataset</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.write">
<code class="sig-name descname">write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.write" title="Permalink to this definition"></a></dt>
<dd><p>Returns an MLWriter instance for this ML instance.</p>
</dd></dl>
<p class="rubric">Attributes Documentation</p>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.blockSize">
<code class="sig-name descname">blockSize</code><em class="property"> = Param(parent='undefined', name='blockSize', doc='block size for stacking input data in matrices. Data is stacked within partitions. If block size is more than remaining data in a partition then it is adjusted to the size of this data.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.blockSize" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol">
<code class="sig-name descname">featuresCol</code><em class="property"> = Param(parent='undefined', name='featuresCol', doc='features column name.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.featuresCol" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasSummary">
<code class="sig-name descname">hasSummary</code><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.hasSummary" title="Permalink to this definition"></a></dt>
<dd><p>Indicates whether a training summary exists for this model
instance.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.1.0.</span></p>
</div>
</dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.initialWeights">
<code class="sig-name descname">initialWeights</code><em class="property"> = Param(parent='undefined', name='initialWeights', doc='The initial weights of the model.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.initialWeights" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.labelCol">
<code class="sig-name descname">labelCol</code><em class="property"> = Param(parent='undefined', name='labelCol', doc='label column name.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.labelCol" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.layers">
<code class="sig-name descname">layers</code><em class="property"> = Param(parent='undefined', name='layers', doc='Sizes of layers from input layer to output layer E.g., Array(780, 100, 10) means 780 inputs, one hidden layer with 100 neurons and output layer of 10 neurons.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.layers" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.maxIter">
<code class="sig-name descname">maxIter</code><em class="property"> = Param(parent='undefined', name='maxIter', doc='max number of iterations (&gt;= 0).')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.maxIter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.numClasses">
<code class="sig-name descname">numClasses</code><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.numClasses" title="Permalink to this definition"></a></dt>
<dd><p>Number of classes (values which the label can take).</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.1.0.</span></p>
</div>
</dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.numFeatures">
<code class="sig-name descname">numFeatures</code><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.numFeatures" title="Permalink to this definition"></a></dt>
<dd><p>Returns the number of features the model was trained on. If unknown, returns -1</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.1.0.</span></p>
</div>
</dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.params">
<code class="sig-name descname">params</code><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.params" title="Permalink to this definition"></a></dt>
<dd><p>Returns all params ordered by name. The default implementation
uses <code class="xref py py-func docutils literal notranslate"><span class="pre">dir()</span></code> to get all attributes of type
<code class="xref py py-class docutils literal notranslate"><span class="pre">Param</span></code>.</p>
</dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol">
<code class="sig-name descname">predictionCol</code><em class="property"> = Param(parent='undefined', name='predictionCol', doc='prediction column name.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.predictionCol" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol">
<code class="sig-name descname">probabilityCol</code><em class="property"> = Param(parent='undefined', name='probabilityCol', doc='Column name for predicted class conditional probabilities. Note: Not all models output well-calibrated probability estimates! These probabilities should be treated as confidences, not precise probabilities.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.probabilityCol" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol">
<code class="sig-name descname">rawPredictionCol</code><em class="property"> = Param(parent='undefined', name='rawPredictionCol', doc='raw prediction (a.k.a. confidence) column name.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.rawPredictionCol" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.seed">
<code class="sig-name descname">seed</code><em class="property"> = Param(parent='undefined', name='seed', doc='random seed.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.seed" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.solver">
<code class="sig-name descname">solver</code><em class="property"> = Param(parent='undefined', name='solver', doc='The solver algorithm for optimization. Supported options: l-bfgs, gd.')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.solver" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.stepSize">
<code class="sig-name descname">stepSize</code><em class="property"> = Param(parent='undefined', name='stepSize', doc='Step size to be used for each iteration of optimization (&gt;= 0).')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.stepSize" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds">
<code class="sig-name descname">thresholds</code><em class="property"> = Param(parent='undefined', name='thresholds', doc=&quot;Thresholds in multi-class classification to adjust the probability of predicting each class. Array must have length equal to the number of classes, with values &gt; 0, excepting that at most one value may be 0. The class with largest value p/t is predicted, where p is the original probability of that class and t is the class's threshold.&quot;)</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.thresholds" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.tol">
<code class="sig-name descname">tol</code><em class="property"> = Param(parent='undefined', name='tol', doc='the convergence tolerance for iterative algorithms (&gt;= 0).')</em><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.tol" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyspark.ml.classification.MultilayerPerceptronClassificationModel.weights">
<code class="sig-name descname">weights</code><a class="headerlink" href="#pyspark.ml.classification.MultilayerPerceptronClassificationModel.weights" title="Permalink to this definition"></a></dt>
<dd><p>the weights of layers.</p>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.0.0.</span></p>
</div>
</dd></dl>
</dd></dl>
</div>
</div>
<div class='prev-next-bottom'>
<a class='left-prev' id="prev-link" href="pyspark.ml.classification.MultilayerPerceptronClassifier.html" title="previous page">MultilayerPerceptronClassifier</a>
<a class='right-next' id="next-link" href="pyspark.ml.classification.MultilayerPerceptronClassificationSummary.html" title="next page">MultilayerPerceptronClassificationSummary</a>
</div>
</main>
</div>
</div>
<script src="../../_static/js/index.3da636dd464baa7582d2.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
&copy; Copyright .<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
</p>
</div>
</footer>
</body>
</html>