| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>IsotonicRegression — PySpark 3.4.3 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/copybutton.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/clipboard.min.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="canonical" href="https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.ml.regression.IsotonicRegression.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="IsotonicRegressionModel" href="pyspark.ml.regression.IsotonicRegressionModel.html" /> |
| <link rel="prev" title="GeneralizedLinearRegressionTrainingSummary" href="pyspark.ml.regression.GeneralizedLinearRegressionTrainingSummary.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="../../index.html">Overview</a> |
| </li> |
| |
| <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 Guides</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 Guides</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/index.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/index.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 (Legacy)</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> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.errors.html">Errors</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="isotonicregression"> |
| <h1>IsotonicRegression<a class="headerlink" href="#isotonicregression" title="Permalink to this headline">¶</a></h1> |
| <dl class="py class"> |
| <dt id="pyspark.ml.regression.IsotonicRegression"> |
| <em class="property">class </em><code class="sig-prename descclassname">pyspark.ml.regression.</code><code class="sig-name descname">IsotonicRegression</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">featuresCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'features'</span></em>, <em class="sig-param"><span class="n">labelCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'label'</span></em>, <em class="sig-param"><span class="n">predictionCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'prediction'</span></em>, <em class="sig-param"><span class="n">weightCol</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">isotonic</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">True</span></em>, <em class="sig-param"><span class="n">featureIndex</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Currently implemented using parallelized pool adjacent violators algorithm. |
| Only univariate (single feature) algorithm supported.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 1.6.0.</span></p> |
| </div> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pyspark.ml.linalg</span> <span class="kn">import</span> <span class="n">Vectors</span> |
| <span class="gp">>>> </span><span class="n">df</span> <span class="o">=</span> <span class="n">spark</span><span class="o">.</span><span class="n">createDataFrame</span><span class="p">([</span> |
| <span class="gp">... </span> <span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">Vectors</span><span class="o">.</span><span class="n">dense</span><span class="p">(</span><span class="mf">1.0</span><span class="p">)),</span> |
| <span class="gp">... </span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="n">Vectors</span><span class="o">.</span><span class="n">sparse</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="p">[],</span> <span class="p">[]))],</span> <span class="p">[</span><span class="s2">"label"</span><span class="p">,</span> <span class="s2">"features"</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">ir</span> <span class="o">=</span> <span class="n">IsotonicRegression</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">model</span> <span class="o">=</span> <span class="n">ir</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">df</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">setFeaturesCol</span><span class="p">(</span><span class="s2">"features"</span><span class="p">)</span> |
| <span class="go">IsotonicRegressionModel...</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">numFeatures</span> |
| <span class="go">1</span> |
| <span class="gp">>>> </span><span class="n">test0</span> <span class="o">=</span> <span class="n">spark</span><span class="o">.</span><span class="n">createDataFrame</span><span class="p">([(</span><span class="n">Vectors</span><span class="o">.</span><span class="n">dense</span><span class="p">(</span><span class="o">-</span><span class="mf">1.0</span><span class="p">),)],</span> <span class="p">[</span><span class="s2">"features"</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">test0</span><span class="p">)</span><span class="o">.</span><span class="n">head</span><span class="p">()</span><span class="o">.</span><span class="n">prediction</span> |
| <span class="go">0.0</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">test0</span><span class="o">.</span><span class="n">head</span><span class="p">()</span><span class="o">.</span><span class="n">features</span><span class="p">[</span><span class="n">model</span><span class="o">.</span><span class="n">getFeatureIndex</span><span class="p">()])</span> |
| <span class="go">0.0</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">boundaries</span> |
| <span class="go">DenseVector([0.0, 1.0])</span> |
| <span class="gp">>>> </span><span class="n">ir_path</span> <span class="o">=</span> <span class="n">temp_path</span> <span class="o">+</span> <span class="s2">"/ir"</span> |
| <span class="gp">>>> </span><span class="n">ir</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">ir_path</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">ir2</span> <span class="o">=</span> <span class="n">IsotonicRegression</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">ir_path</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">ir2</span><span class="o">.</span><span class="n">getIsotonic</span><span class="p">()</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">model_path</span> <span class="o">=</span> <span class="n">temp_path</span> <span class="o">+</span> <span class="s2">"/ir_model"</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">model_path</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">model2</span> <span class="o">=</span> <span class="n">IsotonicRegressionModel</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">model_path</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">boundaries</span> <span class="o">==</span> <span class="n">model2</span><span class="o">.</span><span class="n">boundaries</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">predictions</span> <span class="o">==</span> <span class="n">model2</span><span class="o">.</span><span class="n">predictions</span> |
| <span class="go">True</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">test0</span><span class="p">)</span><span class="o">.</span><span class="n">take</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="o">==</span> <span class="n">model2</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">test0</span><span class="p">)</span><span class="o">.</span><span class="n">take</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> |
| <span class="go">True</span> |
| </pre></div> |
| </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.regression.IsotonicRegression.clear" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.copy" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.explainParam" title="pyspark.ml.regression.IsotonicRegression.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-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.explainParams" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.extractParamMap" title="pyspark.ml.regression.IsotonicRegression.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 < user-supplied values < extra.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.fit" title="pyspark.ml.regression.IsotonicRegression.fit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fit</span></code></a>(dataset[, params])</p></td> |
| <td><p>Fits a model to the input dataset with optional parameters.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.fitMultiple" title="pyspark.ml.regression.IsotonicRegression.fitMultiple"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fitMultiple</span></code></a>(dataset, paramMaps)</p></td> |
| <td><p>Fits a model to the input dataset for each param map in <cite>paramMaps</cite>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getFeatureIndex" title="pyspark.ml.regression.IsotonicRegression.getFeatureIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFeatureIndex</span></code></a>()</p></td> |
| <td><p>Gets the value of featureIndex or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getFeaturesCol" title="pyspark.ml.regression.IsotonicRegression.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-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getIsotonic" title="pyspark.ml.regression.IsotonicRegression.getIsotonic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getIsotonic</span></code></a>()</p></td> |
| <td><p>Gets the value of isotonic or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getLabelCol" title="pyspark.ml.regression.IsotonicRegression.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-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getOrDefault" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getParam" title="pyspark.ml.regression.IsotonicRegression.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-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getPredictionCol" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.getWeightCol" title="pyspark.ml.regression.IsotonicRegression.getWeightCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getWeightCol</span></code></a>()</p></td> |
| <td><p>Gets the value of weightCol or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.hasDefault" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.hasParam" title="pyspark.ml.regression.IsotonicRegression.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-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.isDefined" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.isSet" title="pyspark.ml.regression.IsotonicRegression.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-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.load" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.read" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.save" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.set" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.setFeatureIndex" title="pyspark.ml.regression.IsotonicRegression.setFeatureIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFeatureIndex</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.featureIndex" title="pyspark.ml.regression.IsotonicRegression.featureIndex"><code class="xref py py-attr docutils literal notranslate"><span class="pre">featureIndex</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.setFeaturesCol" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.featuresCol" title="pyspark.ml.regression.IsotonicRegression.featuresCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">featuresCol</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.setIsotonic" title="pyspark.ml.regression.IsotonicRegression.setIsotonic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setIsotonic</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.isotonic" title="pyspark.ml.regression.IsotonicRegression.isotonic"><code class="xref py py-attr docutils literal notranslate"><span class="pre">isotonic</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.setLabelCol" title="pyspark.ml.regression.IsotonicRegression.setLabelCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setLabelCol</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.labelCol" title="pyspark.ml.regression.IsotonicRegression.labelCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">labelCol</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.setParams" title="pyspark.ml.regression.IsotonicRegression.setParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParams</span></code></a>(*[, featuresCol, labelCol, …])</p></td> |
| <td><p>setParams(self, *, featuresCol=”features”, labelCol=”label”, predictionCol=”prediction”, weightCol=None, isotonic=True, featureIndex=0): Set the params for IsotonicRegression.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.setPredictionCol" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.predictionCol" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.setWeightCol" title="pyspark.ml.regression.IsotonicRegression.setWeightCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setWeightCol</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.weightCol" title="pyspark.ml.regression.IsotonicRegression.weightCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">weightCol</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.write" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.featureIndex" title="pyspark.ml.regression.IsotonicRegression.featureIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">featureIndex</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.featuresCol" title="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.isotonic" title="pyspark.ml.regression.IsotonicRegression.isotonic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isotonic</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.labelCol" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.params" title="pyspark.ml.regression.IsotonicRegression.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-even"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.predictionCol" title="pyspark.ml.regression.IsotonicRegression.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.weightCol" title="pyspark.ml.regression.IsotonicRegression.weightCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">weightCol</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Methods Documentation</p> |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.clear"> |
| <code class="sig-name descname">clear</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span><span class="p">:</span> <span class="n"><a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a></span></em><span class="sig-paren">)</span> → None<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.copy"> |
| <code class="sig-name descname">copy</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">extra</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>ParamMap<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em><span class="sig-paren">)</span> → JP<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.explainParam"> |
| <code class="sig-name descname">explainParam</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span><a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a><span class="p">]</span></span></em><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.explainParams"> |
| <code class="sig-name descname">explainParams</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.extractParamMap"> |
| <code class="sig-name descname">extractParamMap</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">extra</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>ParamMap<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em><span class="sig-paren">)</span> → ParamMap<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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 < |
| user-supplied values < 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.regression.IsotonicRegression.fit"> |
| <code class="sig-name descname">fit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dataset</span><span class="p">:</span> <span class="n">pyspark.sql.dataframe.DataFrame</span></em>, <em class="sig-param"><span class="n">params</span><span class="p">:</span> <span class="n">Union[ParamMap, List[ParamMap], Tuple[ParamMap], None]</span> <span class="o">=</span> <span class="default_value">None</span></em><span class="sig-paren">)</span> → Union<span class="p">[</span>M<span class="p">, </span>List<span class="p">[</span>M<span class="p">]</span><span class="p">]</span><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.fit" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Fits a model to 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/api/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 or list or tuple, optional</span></dt><dd><p>an optional param map that overrides embedded params. If a list/tuple of |
| param maps is given, this calls fit on each param map and returns a list of |
| models.</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">Transformer</span></code> or a list of <code class="xref py py-class docutils literal notranslate"><span class="pre">Transformer</span></code></dt><dd><p>fitted model(s)</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.fitMultiple"> |
| <code class="sig-name descname">fitMultiple</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dataset</span><span class="p">:</span> <span class="n">pyspark.sql.dataframe.DataFrame</span></em>, <em class="sig-param"><span class="n">paramMaps</span><span class="p">:</span> <span class="n">Sequence<span class="p">[</span>ParamMap<span class="p">]</span></span></em><span class="sig-paren">)</span> → Iterator<span class="p">[</span>Tuple<span class="p">[</span>int<span class="p">, </span>M<span class="p">]</span><span class="p">]</span><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.fitMultiple" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Fits a model to the input dataset for each param map in <cite>paramMaps</cite>.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.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/api/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>paramMaps</strong><span class="classifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">collections.abc.Sequence</span></code></span></dt><dd><p>A Sequence of param maps.</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">_FitMultipleIterator</span></code></dt><dd><p>A thread safe iterable which contains one model for each param map. Each |
| call to <cite>next(modelIterator)</cite> will return <cite>(index, model)</cite> where model was fit |
| using <cite>paramMaps[index]</cite>. <cite>index</cite> values may not be sequential.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.getFeatureIndex"> |
| <code class="sig-name descname">getFeatureIndex</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → int<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.getFeatureIndex" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of featureIndex or its default value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.getFeaturesCol"> |
| <code class="sig-name descname">getFeaturesCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.getIsotonic"> |
| <code class="sig-name descname">getIsotonic</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.getIsotonic" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of isotonic or its default value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.getLabelCol"> |
| <code class="sig-name descname">getLabelCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.getOrDefault"> |
| <code class="sig-name descname">getOrDefault</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span><a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a><span class="p">[</span>T<span class="p">]</span><span class="p">]</span></span></em><span class="sig-paren">)</span> → Union<span class="p">[</span>Any<span class="p">, </span>T<span class="p">]</span><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.getParam"> |
| <code class="sig-name descname">getParam</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">paramName</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.getPredictionCol"> |
| <code class="sig-name descname">getPredictionCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.getWeightCol"> |
| <code class="sig-name descname">getWeightCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.getWeightCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of weightCol or its default value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.hasDefault"> |
| <code class="sig-name descname">hasDefault</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span><a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a><span class="p">[</span>Any<span class="p">]</span><span class="p">]</span></span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.hasParam"> |
| <code class="sig-name descname">hasParam</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">paramName</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.isDefined"> |
| <code class="sig-name descname">isDefined</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span><a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a><span class="p">[</span>Any<span class="p">]</span><span class="p">]</span></span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.isSet"> |
| <code class="sig-name descname">isSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span><a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a><span class="p">[</span>Any<span class="p">]</span><span class="p">]</span></span></em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.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><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → RL<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.read"> |
| <em class="property">classmethod </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → pyspark.ml.util.JavaMLReader<span class="p">[</span>RL<span class="p">]</span><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.save"> |
| <code class="sig-name descname">save</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → None<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.set"> |
| <code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">param</span><span class="p">:</span> <span class="n"><a class="reference internal" href="pyspark.ml.param.Param.html#pyspark.ml.param.Param" title="pyspark.ml.param.Param">pyspark.ml.param.Param</a></span></em>, <em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">Any</span></em><span class="sig-paren">)</span> → None<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.setFeatureIndex"> |
| <code class="sig-name descname">setFeatureIndex</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression" title="pyspark.ml.regression.IsotonicRegression">pyspark.ml.regression.IsotonicRegression</a><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression.setFeatureIndex"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.setFeatureIndex" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.featureIndex" title="pyspark.ml.regression.IsotonicRegression.featureIndex"><code class="xref py py-attr docutils literal notranslate"><span class="pre">featureIndex</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.setFeaturesCol"> |
| <code class="sig-name descname">setFeaturesCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression" title="pyspark.ml.regression.IsotonicRegression">pyspark.ml.regression.IsotonicRegression</a><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression.setFeaturesCol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.setFeaturesCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.featuresCol" title="pyspark.ml.regression.IsotonicRegression.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 1.6.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.setIsotonic"> |
| <code class="sig-name descname">setIsotonic</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">bool</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression" title="pyspark.ml.regression.IsotonicRegression">pyspark.ml.regression.IsotonicRegression</a><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression.setIsotonic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.setIsotonic" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.isotonic" title="pyspark.ml.regression.IsotonicRegression.isotonic"><code class="xref py py-attr docutils literal notranslate"><span class="pre">isotonic</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.setLabelCol"> |
| <code class="sig-name descname">setLabelCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression" title="pyspark.ml.regression.IsotonicRegression">pyspark.ml.regression.IsotonicRegression</a><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression.setLabelCol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.setLabelCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.labelCol" title="pyspark.ml.regression.IsotonicRegression.labelCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">labelCol</span></code></a>.</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.regression.IsotonicRegression.setParams"> |
| <code class="sig-name descname">setParams</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">featuresCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'features'</span></em>, <em class="sig-param"><span class="n">labelCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'label'</span></em>, <em class="sig-param"><span class="n">predictionCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'prediction'</span></em>, <em class="sig-param"><span class="n">weightCol</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">isotonic</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">True</span></em>, <em class="sig-param"><span class="n">featureIndex</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">0</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression" title="pyspark.ml.regression.IsotonicRegression">pyspark.ml.regression.IsotonicRegression</a><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression.setParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.setParams" title="Permalink to this definition">¶</a></dt> |
| <dd><p>setParams(self, *, featuresCol=”features”, labelCol=”label”, predictionCol=”prediction”, weightCol=None, isotonic=True, featureIndex=0): |
| Set the params for IsotonicRegression.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.setPredictionCol"> |
| <code class="sig-name descname">setPredictionCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression" title="pyspark.ml.regression.IsotonicRegression">pyspark.ml.regression.IsotonicRegression</a><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression.setPredictionCol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.setPredictionCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.predictionCol" title="pyspark.ml.regression.IsotonicRegression.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 1.6.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.setWeightCol"> |
| <code class="sig-name descname">setWeightCol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression" title="pyspark.ml.regression.IsotonicRegression">pyspark.ml.regression.IsotonicRegression</a><a class="reference internal" href="../../_modules/pyspark/ml/regression.html#IsotonicRegression.setWeightCol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.setWeightCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.regression.IsotonicRegression.weightCol" title="pyspark.ml.regression.IsotonicRegression.weightCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">weightCol</span></code></a>.</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.regression.IsotonicRegression.write"> |
| <code class="sig-name descname">write</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → pyspark.ml.util.JavaMLWriter<a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.featureIndex"> |
| <code class="sig-name descname">featureIndex</code><em class="property"> = Param(parent='undefined', name='featureIndex', doc='The index of the feature if featuresCol is a vector column, no effect otherwise.')</em><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.featureIndex" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.featuresCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.isotonic"> |
| <code class="sig-name descname">isotonic</code><em class="property"> = Param(parent='undefined', name='isotonic', doc='whether the output sequence should be isotonic/increasing (true) orantitonic/decreasing (false).')</em><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.isotonic" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.labelCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.params"> |
| <code class="sig-name descname">params</code><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.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.regression.IsotonicRegression.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.regression.IsotonicRegression.predictionCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.regression.IsotonicRegression.weightCol"> |
| <code class="sig-name descname">weightCol</code><em class="property"> = Param(parent='undefined', name='weightCol', doc='weight column name. If this is not set or empty, we treat all instance weights as 1.0.')</em><a class="headerlink" href="#pyspark.ml.regression.IsotonicRegression.weightCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="pyspark.ml.regression.GeneralizedLinearRegressionTrainingSummary.html" title="previous page">GeneralizedLinearRegressionTrainingSummary</a> |
| <a class='right-next' id="next-link" href="pyspark.ml.regression.IsotonicRegressionModel.html" title="next page">IsotonicRegressionModel</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> |
| © Copyright .<br/> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/> |
| </p> |
| </div> |
| </footer> |
| </body> |
| </html> |
