| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>FMClassifier — PySpark 3.3.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/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="FMClassificationModel" href="pyspark.ml.classification.FMClassificationModel.html" /> |
| <link rel="prev" title="OneVsRestModel" href="pyspark.ml.classification.OneVsRestModel.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/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</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="fmclassifier"> |
| <h1>FMClassifier<a class="headerlink" href="#fmclassifier" title="Permalink to this headline">¶</a></h1> |
| <dl class="py class"> |
| <dt id="pyspark.ml.classification.FMClassifier"> |
| <em class="property">class </em><code class="sig-prename descclassname">pyspark.ml.classification.</code><code class="sig-name descname">FMClassifier</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">probabilityCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'probability'</span></em>, <em class="sig-param"><span class="n">rawPredictionCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'rawPrediction'</span></em>, <em class="sig-param"><span class="n">factorSize</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">8</span></em>, <em class="sig-param"><span class="n">fitIntercept</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">fitLinear</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">regParam</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">0.0</span></em>, <em class="sig-param"><span class="n">miniBatchFraction</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">1.0</span></em>, <em class="sig-param"><span class="n">initStd</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">0.01</span></em>, <em class="sig-param"><span class="n">maxIter</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">100</span></em>, <em class="sig-param"><span class="n">stepSize</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">1.0</span></em>, <em class="sig-param"><span class="n">tol</span><span class="p">:</span> <span class="n">float</span> <span class="o">=</span> <span class="default_value">1e-06</span></em>, <em class="sig-param"><span class="n">solver</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">'adamW'</span></em>, <em class="sig-param"><span class="n">thresholds</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>List<span class="p">[</span>float<span class="p">]</span><span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">seed</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>int<span class="p">]</span></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#FMClassifier"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Factorization Machines learning algorithm for classification.</p> |
| <p>Solver supports:</p> |
| <ul class="simple"> |
| <li><p>gd (normal mini-batch gradient descent)</p></li> |
| <li><p>adamW (default)</p></li> |
| </ul> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.0.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="kn">from</span> <span class="nn">pyspark.ml.classification</span> <span class="kn">import</span> <span class="n">FMClassifier</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">fm</span> <span class="o">=</span> <span class="n">FMClassifier</span><span class="p">(</span><span class="n">factorSize</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">fm</span><span class="o">.</span><span class="n">setSeed</span><span class="p">(</span><span class="mi">11</span><span class="p">)</span> |
| <span class="go">FMClassifier...</span> |
| <span class="gp">>>> </span><span class="n">model</span> <span class="o">=</span> <span class="n">fm</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">getMaxIter</span><span class="p">()</span> |
| <span class="go">100</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="gp">... </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="gp">... </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">0.5</span><span class="p">),),</span> |
| <span class="gp">... </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="n">Vectors</span><span class="o">.</span><span class="n">dense</span><span class="p">(</span><span class="mf">2.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">predictRaw</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="go">DenseVector([22.13..., -22.13...])</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">predictProbability</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="go">DenseVector([1.0, 0.0])</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">select</span><span class="p">(</span><span class="s2">"features"</span><span class="p">,</span> <span class="s2">"probability"</span><span class="p">)</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| <span class="go">+--------+------------------------------------------+</span> |
| <span class="go">|features|probability |</span> |
| <span class="go">+--------+------------------------------------------+</span> |
| <span class="go">|[-1.0] |[0.9999999997574736,2.425264676902229E-10]|</span> |
| <span class="go">|[0.5] |[0.47627851732981163,0.5237214826701884] |</span> |
| <span class="go">|[1.0] |[5.491554426243495E-4,0.9994508445573757] |</span> |
| <span class="go">|[2.0] |[2.005766663870645E-10,0.9999999997994233]|</span> |
| <span class="go">+--------+------------------------------------------+</span> |
| <span class="go">...</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">intercept</span> |
| <span class="go">-7.316665276826291</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">linear</span> |
| <span class="go">DenseVector([14.8232])</span> |
| <span class="gp">>>> </span><span class="n">model</span><span class="o">.</span><span class="n">factors</span> |
| <span class="go">DenseMatrix(1, 2, [0.0163, -0.0051], 1)</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">"/fm_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">FMClassificationModel</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">model2</span><span class="o">.</span><span class="n">intercept</span> |
| <span class="go">-7.316665276826291</span> |
| <span class="gp">>>> </span><span class="n">model2</span><span class="o">.</span><span class="n">linear</span> |
| <span class="go">DenseVector([14.8232])</span> |
| <span class="gp">>>> </span><span class="n">model2</span><span class="o">.</span><span class="n">factors</span> |
| <span class="go">DenseMatrix(1, 2, [0.0163, -0.0051], 1)</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.classification.FMClassifier.clear" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.copy" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.explainParam" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.explainParams" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.extractParamMap" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.fit" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.fitMultiple" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.getFactorSize" title="pyspark.ml.classification.FMClassifier.getFactorSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFactorSize</span></code></a>()</p></td> |
| <td><p>Gets the value of factorSize or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getFeaturesCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.getFitIntercept" title="pyspark.ml.classification.FMClassifier.getFitIntercept"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFitIntercept</span></code></a>()</p></td> |
| <td><p>Gets the value of fitIntercept or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getFitLinear" title="pyspark.ml.classification.FMClassifier.getFitLinear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFitLinear</span></code></a>()</p></td> |
| <td><p>Gets the value of fitLinear or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getInitStd" title="pyspark.ml.classification.FMClassifier.getInitStd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getInitStd</span></code></a>()</p></td> |
| <td><p>Gets the value of initStd or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getLabelCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.getMaxIter" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.getMiniBatchFraction" title="pyspark.ml.classification.FMClassifier.getMiniBatchFraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getMiniBatchFraction</span></code></a>()</p></td> |
| <td><p>Gets the value of miniBatchFraction or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getOrDefault" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.getParam" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.getPredictionCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.getProbabilityCol" title="pyspark.ml.classification.FMClassifier.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-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getRawPredictionCol" title="pyspark.ml.classification.FMClassifier.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getRegParam" title="pyspark.ml.classification.FMClassifier.getRegParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getRegParam</span></code></a>()</p></td> |
| <td><p>Gets the value of regParam or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.getSeed" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.getSolver" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.getStepSize" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.getThresholds" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.getTol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.getWeightCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.hasDefault" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.hasParam" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.isDefined" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.isSet" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.load" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.read" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.save" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.set" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setFactorSize" title="pyspark.ml.classification.FMClassifier.setFactorSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFactorSize</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.factorSize" title="pyspark.ml.classification.FMClassifier.factorSize"><code class="xref py py-attr docutils literal notranslate"><span class="pre">factorSize</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setFeaturesCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.featuresCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.setFitIntercept" title="pyspark.ml.classification.FMClassifier.setFitIntercept"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFitIntercept</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.fitIntercept" title="pyspark.ml.classification.FMClassifier.fitIntercept"><code class="xref py py-attr docutils literal notranslate"><span class="pre">fitIntercept</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setFitLinear" title="pyspark.ml.classification.FMClassifier.setFitLinear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFitLinear</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.fitLinear" title="pyspark.ml.classification.FMClassifier.fitLinear"><code class="xref py py-attr docutils literal notranslate"><span class="pre">fitLinear</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setInitStd" title="pyspark.ml.classification.FMClassifier.setInitStd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setInitStd</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.initStd" title="pyspark.ml.classification.FMClassifier.initStd"><code class="xref py py-attr docutils literal notranslate"><span class="pre">initStd</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setLabelCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.labelCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.setMaxIter" title="pyspark.ml.classification.FMClassifier.setMaxIter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMaxIter</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.maxIter" title="pyspark.ml.classification.FMClassifier.maxIter"><code class="xref py py-attr docutils literal notranslate"><span class="pre">maxIter</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setMiniBatchFraction" title="pyspark.ml.classification.FMClassifier.setMiniBatchFraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setMiniBatchFraction</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.miniBatchFraction" title="pyspark.ml.classification.FMClassifier.miniBatchFraction"><code class="xref py py-attr docutils literal notranslate"><span class="pre">miniBatchFraction</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setParams" title="pyspark.ml.classification.FMClassifier.setParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParams</span></code></a>(self, \*[, featuresCol, labelCol, …])</p></td> |
| <td><p>Sets Params for FMClassifier.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setPredictionCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.predictionCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setProbabilityCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.probabilityCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setRawPredictionCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.rawPredictionCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setRegParam" title="pyspark.ml.classification.FMClassifier.setRegParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setRegParam</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.regParam" title="pyspark.ml.classification.FMClassifier.regParam"><code class="xref py py-attr docutils literal notranslate"><span class="pre">regParam</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setSeed" title="pyspark.ml.classification.FMClassifier.setSeed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSeed</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.seed" title="pyspark.ml.classification.FMClassifier.seed"><code class="xref py py-attr docutils literal notranslate"><span class="pre">seed</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setSolver" title="pyspark.ml.classification.FMClassifier.setSolver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSolver</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.solver" title="pyspark.ml.classification.FMClassifier.solver"><code class="xref py py-attr docutils literal notranslate"><span class="pre">solver</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setStepSize" title="pyspark.ml.classification.FMClassifier.setStepSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setStepSize</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.stepSize" title="pyspark.ml.classification.FMClassifier.stepSize"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stepSize</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.setThresholds" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.thresholds" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setTol" title="pyspark.ml.classification.FMClassifier.setTol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setTol</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.tol" title="pyspark.ml.classification.FMClassifier.tol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tol</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.write" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.factorSize" title="pyspark.ml.classification.FMClassifier.factorSize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">factorSize</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.featuresCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.fitIntercept" title="pyspark.ml.classification.FMClassifier.fitIntercept"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fitIntercept</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.fitLinear" title="pyspark.ml.classification.FMClassifier.fitLinear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fitLinear</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.initStd" title="pyspark.ml.classification.FMClassifier.initStd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initStd</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.labelCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.maxIter" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.miniBatchFraction" title="pyspark.ml.classification.FMClassifier.miniBatchFraction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">miniBatchFraction</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.params" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.predictionCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.probabilityCol" title="pyspark.ml.classification.FMClassifier.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-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.rawPredictionCol" title="pyspark.ml.classification.FMClassifier.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-odd"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.regParam" title="pyspark.ml.classification.FMClassifier.regParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">regParam</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.classification.FMClassifier.seed" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.solver" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.stepSize" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.thresholds" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.tol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.weightCol" title="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.getFactorSize"> |
| <code class="sig-name descname">getFactorSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → int<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.getFactorSize" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of factorSize or its default value.</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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.getFitIntercept"> |
| <code class="sig-name descname">getFitIntercept</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.getFitIntercept" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of fitIntercept or its default value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.classification.FMClassifier.getFitLinear"> |
| <code class="sig-name descname">getFitLinear</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.getFitLinear" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of fitLinear or its default value.</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.FMClassifier.getInitStd"> |
| <code class="sig-name descname">getInitStd</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → float<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.getInitStd" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of initStd or its default value.</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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.getMaxIter"> |
| <code class="sig-name descname">getMaxIter</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → int<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.getMiniBatchFraction"> |
| <code class="sig-name descname">getMiniBatchFraction</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → float<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.getMiniBatchFraction" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of miniBatchFraction or its default value.</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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.getProbabilityCol"> |
| <code class="sig-name descname">getProbabilityCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.getRawPredictionCol"> |
| <code class="sig-name descname">getRawPredictionCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.getRegParam"> |
| <code class="sig-name descname">getRegParam</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → float<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.getRegParam" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of regParam or its default value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.classification.FMClassifier.getSeed"> |
| <code class="sig-name descname">getSeed</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → int<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.getSolver"> |
| <code class="sig-name descname">getSolver</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.getStepSize"> |
| <code class="sig-name descname">getStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → float<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.getThresholds"> |
| <code class="sig-name descname">getThresholds</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → List<span class="p">[</span>float<span class="p">]</span><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.getTol"> |
| <code class="sig-name descname">getTol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → float<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.setFactorSize"> |
| <code class="sig-name descname">setFactorSize</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.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setFactorSize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setFactorSize" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.factorSize" title="pyspark.ml.classification.FMClassifier.factorSize"><code class="xref py py-attr docutils literal notranslate"><span class="pre">factorSize</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.FMClassifier.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> → P<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setFeaturesCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.featuresCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setFitIntercept"> |
| <code class="sig-name descname">setFitIntercept</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.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setFitIntercept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setFitIntercept" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.fitIntercept" title="pyspark.ml.classification.FMClassifier.fitIntercept"><code class="xref py py-attr docutils literal notranslate"><span class="pre">fitIntercept</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.FMClassifier.setFitLinear"> |
| <code class="sig-name descname">setFitLinear</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.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setFitLinear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setFitLinear" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.fitLinear" title="pyspark.ml.classification.FMClassifier.fitLinear"><code class="xref py py-attr docutils literal notranslate"><span class="pre">fitLinear</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.FMClassifier.setInitStd"> |
| <code class="sig-name descname">setInitStd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setInitStd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setInitStd" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.initStd" title="pyspark.ml.classification.FMClassifier.initStd"><code class="xref py py-attr docutils literal notranslate"><span class="pre">initStd</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.FMClassifier.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> → P<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setLabelCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.labelCol" title="pyspark.ml.classification.FMClassifier.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 3.0.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.classification.FMClassifier.setMaxIter"> |
| <code class="sig-name descname">setMaxIter</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.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setMaxIter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setMaxIter" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.maxIter" title="pyspark.ml.classification.FMClassifier.maxIter"><code class="xref py py-attr docutils literal notranslate"><span class="pre">maxIter</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.FMClassifier.setMiniBatchFraction"> |
| <code class="sig-name descname">setMiniBatchFraction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setMiniBatchFraction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setMiniBatchFraction" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.miniBatchFraction" title="pyspark.ml.classification.FMClassifier.miniBatchFraction"><code class="xref py py-attr docutils literal notranslate"><span class="pre">miniBatchFraction</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.FMClassifier.setParams"> |
| <code class="sig-name descname">setParams</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">\*</em>, <em class="sig-param">featuresCol="features"</em>, <em class="sig-param">labelCol="label"</em>, <em class="sig-param">predictionCol="prediction"</em>, <em class="sig-param">probabilityCol="probability"</em>, <em class="sig-param">rawPredictionCol="rawPrediction"</em>, <em class="sig-param">factorSize=8</em>, <em class="sig-param">fitIntercept=True</em>, <em class="sig-param">fitLinear=True</em>, <em class="sig-param">regParam=0.0</em>, <em class="sig-param">miniBatchFraction=1.0</em>, <em class="sig-param">initStd=0.01</em>, <em class="sig-param">maxIter=100</em>, <em class="sig-param">stepSize=1.0</em>, <em class="sig-param">tol=1e-6</em>, <em class="sig-param">solver="adamW"</em>, <em class="sig-param">thresholds=None</em>, <em class="sig-param">seed=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setParams" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets Params for FMClassifier.</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.FMClassifier.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> → P<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setPredictionCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.predictionCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setProbabilityCol"> |
| <code class="sig-name descname">setProbabilityCol</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> → P<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setProbabilityCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.probabilityCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setRawPredictionCol"> |
| <code class="sig-name descname">setRawPredictionCol</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> → P<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setRawPredictionCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.rawPredictionCol" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setRegParam"> |
| <code class="sig-name descname">setRegParam</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setRegParam"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setRegParam" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.regParam" title="pyspark.ml.classification.FMClassifier.regParam"><code class="xref py py-attr docutils literal notranslate"><span class="pre">regParam</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.FMClassifier.setSeed"> |
| <code class="sig-name descname">setSeed</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.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setSeed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setSeed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.seed" title="pyspark.ml.classification.FMClassifier.seed"><code class="xref py py-attr docutils literal notranslate"><span class="pre">seed</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.FMClassifier.setSolver"> |
| <code class="sig-name descname">setSolver</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.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setSolver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setSolver" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.solver" title="pyspark.ml.classification.FMClassifier.solver"><code class="xref py py-attr docutils literal notranslate"><span class="pre">solver</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.FMClassifier.setStepSize"> |
| <code class="sig-name descname">setStepSize</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setStepSize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setStepSize" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.stepSize" title="pyspark.ml.classification.FMClassifier.stepSize"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stepSize</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.FMClassifier.setThresholds"> |
| <code class="sig-name descname">setThresholds</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">List<span class="p">[</span>float<span class="p">]</span></span></em><span class="sig-paren">)</span> → P<a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setThresholds" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.thresholds" title="pyspark.ml.classification.FMClassifier.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.FMClassifier.setTol"> |
| <code class="sig-name descname">setTol</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">float</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.classification.FMClassifier" title="pyspark.ml.classification.FMClassifier">pyspark.ml.classification.FMClassifier</a><a class="reference internal" href="../../_modules/pyspark/ml/classification.html#FMClassifier.setTol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.setTol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.classification.FMClassifier.tol" title="pyspark.ml.classification.FMClassifier.tol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">tol</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.FMClassifier.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.classification.FMClassifier.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.FMClassifier.factorSize"> |
| <code class="sig-name descname">factorSize</code><em class="property"> = Param(parent='undefined', name='factorSize', doc='Dimensionality of the factor vectors, which are used to get pairwise interactions between variables')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.factorSize" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.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.FMClassifier.featuresCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.fitIntercept"> |
| <code class="sig-name descname">fitIntercept</code><em class="property"> = Param(parent='undefined', name='fitIntercept', doc='whether to fit an intercept term.')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.fitIntercept" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.fitLinear"> |
| <code class="sig-name descname">fitLinear</code><em class="property"> = Param(parent='undefined', name='fitLinear', doc='whether to fit linear term (aka 1-way term)')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.fitLinear" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.initStd"> |
| <code class="sig-name descname">initStd</code><em class="property"> = Param(parent='undefined', name='initStd', doc='standard deviation of initial coefficients')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.initStd" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.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.FMClassifier.labelCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.maxIter"> |
| <code class="sig-name descname">maxIter</code><em class="property"> = Param(parent='undefined', name='maxIter', doc='max number of iterations (>= 0).')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.maxIter" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.miniBatchFraction"> |
| <code class="sig-name descname">miniBatchFraction</code><em class="property"> = Param(parent='undefined', name='miniBatchFraction', doc='fraction of the input data set that should be used for one iteration of gradient descent')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.miniBatchFraction" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.params"> |
| <code class="sig-name descname">params</code><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.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.FMClassifier.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.FMClassifier.predictionCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.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.FMClassifier.probabilityCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.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.FMClassifier.rawPredictionCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.regParam"> |
| <code class="sig-name descname">regParam</code><em class="property"> = Param(parent='undefined', name='regParam', doc='regularization parameter (>= 0).')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.regParam" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.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.FMClassifier.seed" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.solver"> |
| <code class="sig-name descname">solver</code><em class="property"> = Param(parent='undefined', name='solver', doc='The solver algorithm for optimization. Supported options: gd, adamW. (Default adamW)')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.solver" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.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 (>= 0).')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.stepSize" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.thresholds"> |
| <code class="sig-name descname">thresholds</code><em class="property"> = Param(parent='undefined', name='thresholds', doc="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 > 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.")</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.thresholds" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.tol"> |
| <code class="sig-name descname">tol</code><em class="property"> = Param(parent='undefined', name='tol', doc='the convergence tolerance for iterative algorithms (>= 0).')</em><a class="headerlink" href="#pyspark.ml.classification.FMClassifier.tol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.classification.FMClassifier.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.classification.FMClassifier.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.classification.OneVsRestModel.html" title="previous page">OneVsRestModel</a> |
| <a class='right-next' id="next-link" href="pyspark.ml.classification.FMClassificationModel.html" title="next page">FMClassificationModel</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> |
