blob: a7cb97c6ce3c29d8bb38fa01081c08933285474f [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>pyspark.pandas.DataFrame.cummin &#8212; 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/pyspark.pandas/api/pyspark.pandas.DataFrame.cummin.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="pyspark.pandas.DataFrame.cummax" href="pyspark.pandas.DataFrame.cummax.html" />
<link rel="prev" title="pyspark.pandas.DataFrame.var" href="pyspark.pandas.DataFrame.var.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="active">
<a href="../index.html">Pandas API on Spark</a>
<ul>
<li class="">
<a href="../io.html">Input/Output</a>
</li>
<li class="">
<a href="../general_functions.html">General functions</a>
</li>
<li class="">
<a href="../series.html">Series</a>
</li>
<li class="active">
<a href="../frame.html">DataFrame</a>
</li>
<li class="">
<a href="../indexing.html">Index objects</a>
</li>
<li class="">
<a href="../window.html">Window</a>
</li>
<li class="">
<a href="../groupby.html">GroupBy</a>
</li>
<li class="">
<a href="../ml.html">Machine Learning utilities</a>
</li>
<li class="">
<a href="../extensions.html">Extensions</a>
</li>
</ul>
</li>
<li class="">
<a href="../../pyspark.ss/index.html">Structured Streaming</a>
</li>
<li class="">
<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="pyspark-pandas-dataframe-cummin">
<h1>pyspark.pandas.DataFrame.cummin<a class="headerlink" href="#pyspark-pandas-dataframe-cummin" title="Permalink to this headline"></a></h1>
<dl class="py method">
<dt id="pyspark.pandas.DataFrame.cummin">
<code class="sig-prename descclassname">DataFrame.</code><code class="sig-name descname">cummin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">skipna</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">True</span></em><span class="sig-paren">)</span> &#x2192; FrameLike<a class="headerlink" href="#pyspark.pandas.DataFrame.cummin" title="Permalink to this definition"></a></dt>
<dd><p>Return cumulative minimum over a DataFrame or Series axis.</p>
<p>Returns a DataFrame or Series of the same size containing the cumulative minimum.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>the current implementation of cummin uses Spark’s Window without
specifying partition specification. This leads to move all data into
single partition in single machine and could cause serious
performance degradation. Avoid this method against very large dataset.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>skipna</strong><span class="classifier">boolean, default True</span></dt><dd><p>Exclude NA/null values. If an entire row/column is NA, the result will be NA.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>DataFrame or Series</dt><dd></dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="pyspark.pandas.DataFrame.min.html#pyspark.pandas.DataFrame.min" title="pyspark.pandas.DataFrame.min"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.min</span></code></a></dt><dd><p>Return the minimum over DataFrame axis.</p>
</dd>
<dt><a class="reference internal" href="pyspark.pandas.DataFrame.cummax.html#pyspark.pandas.DataFrame.cummax" title="pyspark.pandas.DataFrame.cummax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.cummax</span></code></a></dt><dd><p>Return cumulative maximum over DataFrame axis.</p>
</dd>
<dt><a class="reference internal" href="#pyspark.pandas.DataFrame.cummin" title="pyspark.pandas.DataFrame.cummin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.cummin</span></code></a></dt><dd><p>Return cumulative minimum over DataFrame axis.</p>
</dd>
<dt><a class="reference internal" href="pyspark.pandas.DataFrame.cumsum.html#pyspark.pandas.DataFrame.cumsum" title="pyspark.pandas.DataFrame.cumsum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.cumsum</span></code></a></dt><dd><p>Return cumulative sum over DataFrame axis.</p>
</dd>
<dt><a class="reference internal" href="pyspark.pandas.Series.min.html#pyspark.pandas.Series.min" title="pyspark.pandas.Series.min"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Series.min</span></code></a></dt><dd><p>Return the minimum over Series axis.</p>
</dd>
<dt><a class="reference internal" href="pyspark.pandas.Series.cummax.html#pyspark.pandas.Series.cummax" title="pyspark.pandas.Series.cummax"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Series.cummax</span></code></a></dt><dd><p>Return cumulative maximum over Series axis.</p>
</dd>
<dt><a class="reference internal" href="pyspark.pandas.Series.cummin.html#pyspark.pandas.Series.cummin" title="pyspark.pandas.Series.cummin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Series.cummin</span></code></a></dt><dd><p>Return cumulative minimum over Series axis.</p>
</dd>
<dt><a class="reference internal" href="pyspark.pandas.Series.cumsum.html#pyspark.pandas.Series.cumsum" title="pyspark.pandas.Series.cumsum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Series.cumsum</span></code></a></dt><dd><p>Return cumulative sum over Series axis.</p>
</dd>
<dt><a class="reference internal" href="pyspark.pandas.Series.cumprod.html#pyspark.pandas.Series.cumprod" title="pyspark.pandas.Series.cumprod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Series.cumprod</span></code></a></dt><dd><p>Return cumulative product over Series axis.</p>
</dd>
</dl>
</div>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">df</span> <span class="o">=</span> <span class="n">ps</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">([[</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">3.0</span><span class="p">,</span> <span class="kc">None</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]],</span> <span class="n">columns</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="s1">&#39;AB&#39;</span><span class="p">))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span>
<span class="go"> A B</span>
<span class="go">0 2.0 1.0</span>
<span class="go">1 3.0 NaN</span>
<span class="go">2 1.0 0.0</span>
</pre></div>
</div>
<p>By default, iterates over rows and finds the minimum in each column.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">df</span><span class="o">.</span><span class="n">cummin</span><span class="p">()</span>
<span class="go"> A B</span>
<span class="go">0 2.0 1.0</span>
<span class="go">1 2.0 NaN</span>
<span class="go">2 1.0 0.0</span>
</pre></div>
</div>
<p>It works identically in Series.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">df</span><span class="o">.</span><span class="n">A</span><span class="o">.</span><span class="n">cummin</span><span class="p">()</span>
<span class="go">0 2.0</span>
<span class="go">1 2.0</span>
<span class="go">2 1.0</span>
<span class="go">Name: A, dtype: float64</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
<div class='prev-next-bottom'>
<a class='left-prev' id="prev-link" href="pyspark.pandas.DataFrame.var.html" title="previous page">pyspark.pandas.DataFrame.var</a>
<a class='right-next' id="next-link" href="pyspark.pandas.DataFrame.cummax.html" title="next page">pyspark.pandas.DataFrame.cummax</a>
</div>
</main>
</div>
</div>
<script src="../../../_static/js/index.3da636dd464baa7582d2.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
&copy; Copyright .<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
</p>
</div>
</footer>
</body>
</html>