| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>CrossValidator — PySpark 3.3.4 documentation</title> |
| |
| <link rel="stylesheet" href="../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css"> |
| |
| |
| <link rel="stylesheet" |
| href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> |
| |
| |
| |
| <link rel="stylesheet" |
| href="../../_static/vendor/open-sans_all/1.44.1/index.css"> |
| <link rel="stylesheet" |
| href="../../_static/vendor/lato_latin-ext/1.44.1/index.css"> |
| |
| |
| <link rel="stylesheet" href="../../_static/basic.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/css/pyspark.css" /> |
| |
| <link rel="preload" as="script" href="../../_static/js/index.3da636dd464baa7582d2.js"> |
| |
| <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/language_data.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> |
| <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script> |
| <link rel="canonical" href="https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.ml.tuning.CrossValidator.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="CrossValidatorModel" href="pyspark.ml.tuning.CrossValidatorModel.html" /> |
| <link rel="prev" title="ParamGridBuilder" href="pyspark.ml.tuning.ParamGridBuilder.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="crossvalidator"> |
| <h1>CrossValidator<a class="headerlink" href="#crossvalidator" title="Permalink to this headline">¶</a></h1> |
| <dl class="py class"> |
| <dt id="pyspark.ml.tuning.CrossValidator"> |
| <em class="property">class </em><code class="sig-prename descclassname">pyspark.ml.tuning.</code><code class="sig-name descname">CrossValidator</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">estimator</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>pyspark.ml.base.Estimator<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">estimatorParamMaps</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>List<span class="p">[</span>ParamMap<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">evaluator</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span><a class="reference internal" href="pyspark.ml.evaluation.Evaluator.html#pyspark.ml.evaluation.Evaluator" title="pyspark.ml.evaluation.Evaluator">pyspark.ml.evaluation.Evaluator</a><span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">numFolds</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">3</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>, <em class="sig-param"><span class="n">parallelism</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">1</span></em>, <em class="sig-param"><span class="n">collectSubModels</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em>, <em class="sig-param"><span class="n">foldCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>K-fold cross validation performs model selection by splitting the dataset into a set of |
| non-overlapping randomly partitioned folds which are used as separate training and test datasets |
| e.g., with k=3 folds, K-fold cross validation will generate 3 (training, test) dataset pairs, |
| each of which uses 2/3 of the data for training and 1/3 for testing. Each fold is used as the |
| test set exactly once.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 1.4.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.classification</span> <span class="kn">import</span> <span class="n">LogisticRegression</span> |
| <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pyspark.ml.evaluation</span> <span class="kn">import</span> <span class="n">BinaryClassificationEvaluator</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.tuning</span> <span class="kn">import</span> <span class="n">CrossValidator</span><span class="p">,</span> <span class="n">ParamGridBuilder</span><span class="p">,</span> <span class="n">CrossValidatorModel</span> |
| <span class="gp">>>> </span><span class="kn">import</span> <span class="nn">tempfile</span> |
| <span class="gp">>>> </span><span class="n">dataset</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="mf">0.0</span><span class="p">]),</span> <span class="mf">0.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.4</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">0.5</span><span class="p">]),</span> <span class="mf">0.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.6</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">1.0</span><span class="p">]),</span> <span class="mf">1.0</span><span class="p">)]</span> <span class="o">*</span> <span class="mi">10</span><span class="p">,</span> |
| <span class="gp">... </span> <span class="p">[</span><span class="s2">"features"</span><span class="p">,</span> <span class="s2">"label"</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">lr</span> <span class="o">=</span> <span class="n">LogisticRegression</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">grid</span> <span class="o">=</span> <span class="n">ParamGridBuilder</span><span class="p">()</span><span class="o">.</span><span class="n">addGrid</span><span class="p">(</span><span class="n">lr</span><span class="o">.</span><span class="n">maxIter</span><span class="p">,</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span><span class="o">.</span><span class="n">build</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">evaluator</span> <span class="o">=</span> <span class="n">BinaryClassificationEvaluator</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">cv</span> <span class="o">=</span> <span class="n">CrossValidator</span><span class="p">(</span><span class="n">estimator</span><span class="o">=</span><span class="n">lr</span><span class="p">,</span> <span class="n">estimatorParamMaps</span><span class="o">=</span><span class="n">grid</span><span class="p">,</span> <span class="n">evaluator</span><span class="o">=</span><span class="n">evaluator</span><span class="p">,</span> |
| <span class="gp">... </span> <span class="n">parallelism</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">cvModel</span> <span class="o">=</span> <span class="n">cv</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">dataset</span><span class="p">)</span> |
| <span class="gp">>>> </span><span class="n">cvModel</span><span class="o">.</span><span class="n">getNumFolds</span><span class="p">()</span> |
| <span class="go">3</span> |
| <span class="gp">>>> </span><span class="n">cvModel</span><span class="o">.</span><span class="n">avgMetrics</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="go">0.5</span> |
| <span class="gp">>>> </span><span class="n">path</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">mkdtemp</span><span class="p">()</span> |
| <span class="gp">>>> </span><span class="n">model_path</span> <span class="o">=</span> <span class="n">path</span> <span class="o">+</span> <span class="s2">"/model"</span> |
| <span class="gp">>>> </span><span class="n">cvModel</span><span class="o">.</span><span class="n">write</span><span class="p">()</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">cvModelRead</span> <span class="o">=</span> <span class="n">CrossValidatorModel</span><span class="o">.</span><span class="n">read</span><span class="p">()</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">cvModelRead</span><span class="o">.</span><span class="n">avgMetrics</span> |
| <span class="go">[0.5, ...</span> |
| <span class="gp">>>> </span><span class="n">evaluator</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">cvModel</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">dataset</span><span class="p">))</span> |
| <span class="go">0.8333...</span> |
| <span class="gp">>>> </span><span class="n">evaluator</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">cvModelRead</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">dataset</span><span class="p">))</span> |
| <span class="go">0.8333...</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.tuning.CrossValidator.clear" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.copy" title="pyspark.ml.tuning.CrossValidator.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 a randomly generated uid and some extra params.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.explainParam" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.explainParams" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.extractParamMap" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.fit" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.fitMultiple" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.getCollectSubModels" title="pyspark.ml.tuning.CrossValidator.getCollectSubModels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getCollectSubModels</span></code></a>()</p></td> |
| <td><p>Gets the value of collectSubModels or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getEstimator" title="pyspark.ml.tuning.CrossValidator.getEstimator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getEstimator</span></code></a>()</p></td> |
| <td><p>Gets the value of estimator or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getEstimatorParamMaps" title="pyspark.ml.tuning.CrossValidator.getEstimatorParamMaps"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getEstimatorParamMaps</span></code></a>()</p></td> |
| <td><p>Gets the value of estimatorParamMaps or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getEvaluator" title="pyspark.ml.tuning.CrossValidator.getEvaluator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getEvaluator</span></code></a>()</p></td> |
| <td><p>Gets the value of evaluator or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getFoldCol" title="pyspark.ml.tuning.CrossValidator.getFoldCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getFoldCol</span></code></a>()</p></td> |
| <td><p>Gets the value of foldCol or its default value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getNumFolds" title="pyspark.ml.tuning.CrossValidator.getNumFolds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getNumFolds</span></code></a>()</p></td> |
| <td><p>Gets the value of numFolds or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getOrDefault" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.getParallelism" title="pyspark.ml.tuning.CrossValidator.getParallelism"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getParallelism</span></code></a>()</p></td> |
| <td><p>Gets the value of parallelism or its default value.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getParam" title="pyspark.ml.tuning.CrossValidator.getParam"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getParam</span></code></a>(paramName)</p></td> |
| <td><p>Gets a param by its name.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.getSeed" title="pyspark.ml.tuning.CrossValidator.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-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.hasDefault" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.hasParam" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.isDefined" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.isSet" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.load" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.read" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.save" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.set" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.setCollectSubModels" title="pyspark.ml.tuning.CrossValidator.setCollectSubModels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCollectSubModels</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.collectSubModels" title="pyspark.ml.tuning.CrossValidator.collectSubModels"><code class="xref py py-attr docutils literal notranslate"><span class="pre">collectSubModels</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setEstimator" title="pyspark.ml.tuning.CrossValidator.setEstimator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setEstimator</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.estimator" title="pyspark.ml.tuning.CrossValidator.estimator"><code class="xref py py-attr docutils literal notranslate"><span class="pre">estimator</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setEstimatorParamMaps" title="pyspark.ml.tuning.CrossValidator.setEstimatorParamMaps"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setEstimatorParamMaps</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.estimatorParamMaps" title="pyspark.ml.tuning.CrossValidator.estimatorParamMaps"><code class="xref py py-attr docutils literal notranslate"><span class="pre">estimatorParamMaps</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setEvaluator" title="pyspark.ml.tuning.CrossValidator.setEvaluator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setEvaluator</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.evaluator" title="pyspark.ml.tuning.CrossValidator.evaluator"><code class="xref py py-attr docutils literal notranslate"><span class="pre">evaluator</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setFoldCol" title="pyspark.ml.tuning.CrossValidator.setFoldCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setFoldCol</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.foldCol" title="pyspark.ml.tuning.CrossValidator.foldCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">foldCol</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setNumFolds" title="pyspark.ml.tuning.CrossValidator.setNumFolds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setNumFolds</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.numFolds" title="pyspark.ml.tuning.CrossValidator.numFolds"><code class="xref py py-attr docutils literal notranslate"><span class="pre">numFolds</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setParallelism" title="pyspark.ml.tuning.CrossValidator.setParallelism"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParallelism</span></code></a>(value)</p></td> |
| <td><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.parallelism" title="pyspark.ml.tuning.CrossValidator.parallelism"><code class="xref py py-attr docutils literal notranslate"><span class="pre">parallelism</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setParams" title="pyspark.ml.tuning.CrossValidator.setParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setParams</span></code></a>(*[, estimator, …])</p></td> |
| <td><p>setParams(self, *, estimator=None, estimatorParamMaps=None, evaluator=None, numFolds=3, seed=None, parallelism=1, collectSubModels=False, foldCol=””): Sets params for cross validator.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.setSeed" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.seed" title="pyspark.ml.tuning.CrossValidator.seed"><code class="xref py py-attr docutils literal notranslate"><span class="pre">seed</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.write" title="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.collectSubModels" title="pyspark.ml.tuning.CrossValidator.collectSubModels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">collectSubModels</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.estimator" title="pyspark.ml.tuning.CrossValidator.estimator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">estimator</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.estimatorParamMaps" title="pyspark.ml.tuning.CrossValidator.estimatorParamMaps"><code class="xref py py-obj docutils literal notranslate"><span class="pre">estimatorParamMaps</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.evaluator" title="pyspark.ml.tuning.CrossValidator.evaluator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">evaluator</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.foldCol" title="pyspark.ml.tuning.CrossValidator.foldCol"><code class="xref py py-obj docutils literal notranslate"><span class="pre">foldCol</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.numFolds" title="pyspark.ml.tuning.CrossValidator.numFolds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numFolds</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.parallelism" title="pyspark.ml.tuning.CrossValidator.parallelism"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parallelism</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.params" title="pyspark.ml.tuning.CrossValidator.params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">params</span></code></a></p></td> |
| <td><p>Returns all params ordered by name.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.seed" title="pyspark.ml.tuning.CrossValidator.seed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seed</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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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> → CrossValidator<a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.copy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a copy of this instance with a randomly generated uid |
| and some extra params. This copies creates a deep copy of |
| the embedded paramMap, and copies the embedded and extra parameters over.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 1.4.0.</span></p> |
| </div> |
| <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><a class="reference internal" href="#pyspark.ml.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator"><code class="xref py py-class docutils literal notranslate"><span class="pre">CrossValidator</span></code></a></dt><dd><p>Copy of this instance</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.getCollectSubModels"> |
| <code class="sig-name descname">getCollectSubModels</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → bool<a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.getCollectSubModels" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of collectSubModels or its default value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.getEstimator"> |
| <code class="sig-name descname">getEstimator</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → pyspark.ml.base.Estimator<a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.getEstimator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of estimator or its default value.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.0.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.getEstimatorParamMaps"> |
| <code class="sig-name descname">getEstimatorParamMaps</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → List<span class="p">[</span>ParamMap<span class="p">]</span><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.getEstimatorParamMaps" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of estimatorParamMaps or its default value.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.0.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.getEvaluator"> |
| <code class="sig-name descname">getEvaluator</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="pyspark.ml.evaluation.Evaluator.html#pyspark.ml.evaluation.Evaluator" title="pyspark.ml.evaluation.Evaluator">pyspark.ml.evaluation.Evaluator</a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.getEvaluator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of evaluator or its default value.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.0.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.getFoldCol"> |
| <code class="sig-name descname">getFoldCol</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → str<a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.getFoldCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of foldCol or its default value.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.1.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.getNumFolds"> |
| <code class="sig-name descname">getNumFolds</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → int<a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.getNumFolds" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of numFolds or its default value.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 1.4.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.getParallelism"> |
| <code class="sig-name descname">getParallelism</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → int<a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.getParallelism" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the value of parallelism or its default value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidatorReader<a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.read" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an MLReader instance for this class.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.3.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.setCollectSubModels"> |
| <code class="sig-name descname">setCollectSubModels</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.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator">pyspark.ml.tuning.CrossValidator</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setCollectSubModels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setCollectSubModels" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.collectSubModels" title="pyspark.ml.tuning.CrossValidator.collectSubModels"><code class="xref py py-attr docutils literal notranslate"><span class="pre">collectSubModels</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.setEstimator"> |
| <code class="sig-name descname">setEstimator</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n">pyspark.ml.base.Estimator</span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator">pyspark.ml.tuning.CrossValidator</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setEstimator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setEstimator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.estimator" title="pyspark.ml.tuning.CrossValidator.estimator"><code class="xref py py-attr docutils literal notranslate"><span class="pre">estimator</span></code></a>.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.0.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.setEstimatorParamMaps"> |
| <code class="sig-name descname">setEstimatorParamMaps</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>ParamMap<span class="p">]</span></span></em><span class="sig-paren">)</span> → CrossValidator<a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setEstimatorParamMaps"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setEstimatorParamMaps" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.estimatorParamMaps" title="pyspark.ml.tuning.CrossValidator.estimatorParamMaps"><code class="xref py py-attr docutils literal notranslate"><span class="pre">estimatorParamMaps</span></code></a>.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.0.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.setEvaluator"> |
| <code class="sig-name descname">setEvaluator</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="p">:</span> <span class="n"><a class="reference internal" href="pyspark.ml.evaluation.Evaluator.html#pyspark.ml.evaluation.Evaluator" title="pyspark.ml.evaluation.Evaluator">pyspark.ml.evaluation.Evaluator</a></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator">pyspark.ml.tuning.CrossValidator</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setEvaluator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setEvaluator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.evaluator" title="pyspark.ml.tuning.CrossValidator.evaluator"><code class="xref py py-attr docutils literal notranslate"><span class="pre">evaluator</span></code></a>.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.0.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.setFoldCol"> |
| <code class="sig-name descname">setFoldCol</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.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator">pyspark.ml.tuning.CrossValidator</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setFoldCol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setFoldCol" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.foldCol" title="pyspark.ml.tuning.CrossValidator.foldCol"><code class="xref py py-attr docutils literal notranslate"><span class="pre">foldCol</span></code></a>.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.1.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.setNumFolds"> |
| <code class="sig-name descname">setNumFolds</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.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator">pyspark.ml.tuning.CrossValidator</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setNumFolds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setNumFolds" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.numFolds" title="pyspark.ml.tuning.CrossValidator.numFolds"><code class="xref py py-attr docutils literal notranslate"><span class="pre">numFolds</span></code></a>.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 1.4.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.setParallelism"> |
| <code class="sig-name descname">setParallelism</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.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator">pyspark.ml.tuning.CrossValidator</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setParallelism"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setParallelism" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.parallelism" title="pyspark.ml.tuning.CrossValidator.parallelism"><code class="xref py py-attr docutils literal notranslate"><span class="pre">parallelism</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.setParams"> |
| <code class="sig-name descname">setParams</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">estimator</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>pyspark.ml.base.Estimator<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">estimatorParamMaps</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>List<span class="p">[</span>ParamMap<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">evaluator</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span><a class="reference internal" href="pyspark.ml.evaluation.Evaluator.html#pyspark.ml.evaluation.Evaluator" title="pyspark.ml.evaluation.Evaluator">pyspark.ml.evaluation.Evaluator</a><span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">numFolds</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">3</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>, <em class="sig-param"><span class="n">parallelism</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">1</span></em>, <em class="sig-param"><span class="n">collectSubModels</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em>, <em class="sig-param"><span class="n">foldCol</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">''</span></em><span class="sig-paren">)</span> → CrossValidator<a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setParams" title="Permalink to this definition">¶</a></dt> |
| <dd><p>setParams(self, *, estimator=None, estimatorParamMaps=None, evaluator=None, numFolds=3, seed=None, parallelism=1, collectSubModels=False, foldCol=””): |
| Sets params for cross validator.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 1.4.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator" title="pyspark.ml.tuning.CrossValidator">pyspark.ml.tuning.CrossValidator</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.setSeed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.setSeed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the value of <a class="reference internal" href="#pyspark.ml.tuning.CrossValidator.seed" title="pyspark.ml.tuning.CrossValidator.seed"><code class="xref py py-attr docutils literal notranslate"><span class="pre">seed</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyspark.ml.tuning.CrossValidator.write"> |
| <code class="sig-name descname">write</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="pyspark.ml.util.MLWriter.html#pyspark.ml.util.MLWriter" title="pyspark.ml.util.MLWriter">pyspark.ml.util.MLWriter</a><a class="reference internal" href="../../_modules/pyspark/ml/tuning.html#CrossValidator.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.write" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an MLWriter instance for this ML instance.</p> |
| <div class="versionadded"> |
| <p><span class="versionmodified added">New in version 2.3.0.</span></p> |
| </div> |
| </dd></dl> |
| |
| <p class="rubric">Attributes Documentation</p> |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.collectSubModels"> |
| <code class="sig-name descname">collectSubModels</code><em class="property"> = Param(parent='undefined', name='collectSubModels', doc='Param for whether to collect a list of sub-models trained during tuning. If set to false, then only the single best sub-model will be available after fitting. If set to true, then all sub-models will be available. Warning: For large models, collecting all sub-models can cause OOMs on the Spark driver.')</em><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.collectSubModels" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.estimator"> |
| <code class="sig-name descname">estimator</code><em class="property"> = Param(parent='undefined', name='estimator', doc='estimator to be cross-validated')</em><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.estimator" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.estimatorParamMaps"> |
| <code class="sig-name descname">estimatorParamMaps</code><em class="property"> = Param(parent='undefined', name='estimatorParamMaps', doc='estimator param maps')</em><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.estimatorParamMaps" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.evaluator"> |
| <code class="sig-name descname">evaluator</code><em class="property"> = Param(parent='undefined', name='evaluator', doc='evaluator used to select hyper-parameters that maximize the validator metric')</em><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.evaluator" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.foldCol"> |
| <code class="sig-name descname">foldCol</code><em class="property"> = Param(parent='undefined', name='foldCol', doc="Param for the column name of user specified fold number. Once this is specified, :py:class:`CrossValidator` won't do random k-fold split. Note that this column should be integer type with range [0, numFolds) and Spark will throw exception on out-of-range fold numbers.")</em><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.foldCol" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.numFolds"> |
| <code class="sig-name descname">numFolds</code><em class="property"> = Param(parent='undefined', name='numFolds', doc='number of folds for cross validation')</em><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.numFolds" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.parallelism"> |
| <code class="sig-name descname">parallelism</code><em class="property"> = Param(parent='undefined', name='parallelism', doc='the number of threads to use when running parallel algorithms (>= 1).')</em><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.parallelism" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyspark.ml.tuning.CrossValidator.params"> |
| <code class="sig-name descname">params</code><a class="headerlink" href="#pyspark.ml.tuning.CrossValidator.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.tuning.CrossValidator.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.tuning.CrossValidator.seed" 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.tuning.ParamGridBuilder.html" title="previous page">ParamGridBuilder</a> |
| <a class='right-next' id="next-link" href="pyspark.ml.tuning.CrossValidatorModel.html" title="next page">CrossValidatorModel</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> |
