This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/datafusion-python.git
The following commit(s) were added to refs/heads/asf-staging by this push:
new 3afac48f Publish built docs triggered by
74b32214fb2c9a06f72cd0495b19fee5d5a3047b
3afac48f is described below
commit 3afac48ff94fd4f3802daa25b2e12611afec0ac3
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Mar 18 06:16:19 2026 +0000
Publish built docs triggered by 74b32214fb2c9a06f72cd0495b19fee5d5a3047b
---
.../autoapi/datafusion/functions/index.rst.txt | 191 ++++++++++++++++++--
autoapi/datafusion/functions/index.html | 192 +++++++++++++++++++--
searchindex.js | 2 +-
user-guide/common-operations/aggregations.html | 32 ++--
user-guide/common-operations/basic-info.html | 46 ++---
user-guide/common-operations/functions.html | 20 +--
6 files changed, 412 insertions(+), 71 deletions(-)
diff --git a/_sources/autoapi/datafusion/functions/index.rst.txt
b/_sources/autoapi/datafusion/functions/index.rst.txt
index 73ef69ef..c3b0efa9 100644
--- a/_sources/autoapi/datafusion/functions/index.rst.txt
+++ b/_sources/autoapi/datafusion/functions/index.rst.txt
@@ -1059,6 +1059,15 @@ Module Contents
:param value_x: The independent variable for correlation
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0], "b": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.corr(dfn.col("a"), dfn.col("b")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: cos(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1095,14 +1104,11 @@ Module Contents
>>> from math import pi
>>> ctx = dfn.SessionContext()
>>> df = ctx.from_pydict({"a": [pi / 4]})
- >>> import builtins
>>> result = df.select(
... dfn.functions.cot(dfn.col("a")).alias("cot")
... )
- >>> builtins.round(
- ... result.collect_column("cot")[0].as_py(), 1
- ... )
- 1.0
+ >>> result.collect_column("cot")[0].as_py()
+ 1.0...
.. py:function:: count(expressions: datafusion.expr.Expr |
list[datafusion.expr.Expr] | None = None, distinct: bool = False, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -1151,7 +1157,7 @@ Module Contents
Computes the sample covariance.
- This is an alias for :py:func:`covar_samp`.
+ .. seealso:: This is an alias for :py:func:`covar_samp`.
.. py:function:: covar_pop(value_y: datafusion.expr.Expr, value_x:
datafusion.expr.Expr, filter: datafusion.expr.Expr | None = None) ->
datafusion.expr.Expr
@@ -1167,6 +1173,19 @@ Module Contents
:param value_x: The independent variable for covariance
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 5.0, 10.0], "b": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [],
+ ... [dfn.functions.covar_pop(
+ ... dfn.col("a"), dfn.col("b")
+ ... ).alias("v")]
+ ... )
+ >>> result.collect_column("v")[0].as_py()
+ 3.0
+
.. py:function:: covar_samp(value_y: datafusion.expr.Expr, value_x:
datafusion.expr.Expr, filter: datafusion.expr.Expr | None = None) ->
datafusion.expr.Expr
@@ -1181,6 +1200,15 @@ Module Contents
:param value_x: The independent variable for covariance
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0], "b": [4.0, 5.0, 6.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.covar_samp(dfn.col("a"),
dfn.col("b")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: cume_dist(partition_by: list[datafusion.expr.Expr] |
datafusion.expr.Expr | None = None, order_by: list[datafusion.expr.SortKey] |
datafusion.expr.SortKey | None = None) -> datafusion.expr.Expr
@@ -2335,14 +2363,11 @@ Module Contents
>>> from math import pi
>>> ctx = dfn.SessionContext()
>>> df = ctx.from_pydict({"a": [180.0]})
- >>> import builtins
>>> result = df.select(
... dfn.functions.radians(dfn.col("a")).alias("rad")
... )
- >>> builtins.round(
- ... result.collect_column("rad")[0].as_py(), 6
- ... )
- 3.141593
+ >>> result.collect_column("rad")[0].as_py() == pi
+ True
.. py:function:: random() -> datafusion.expr.Expr
@@ -2516,6 +2541,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [1.0, 2.0, 3.0], "x": [4.0, 5.0, 6.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_avgx(dfn.col("y"),
dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 5.0
+
.. py:function:: regr_avgy(y: datafusion.expr.Expr, x: datafusion.expr.Expr,
filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2531,6 +2565,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [1.0, 2.0, 3.0], "x": [4.0, 5.0, 6.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_avgy(dfn.col("y"),
dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: regr_count(y: datafusion.expr.Expr, x: datafusion.expr.Expr,
filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2546,6 +2589,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [1.0, 2.0, 3.0], "x": [4.0, 5.0, 6.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_count(dfn.col("y"),
dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 3
+
.. py:function:: regr_intercept(y: datafusion.expr.Expr, x:
datafusion.expr.Expr, filter: datafusion.expr.Expr | None = None) ->
datafusion.expr.Expr
@@ -2561,6 +2613,16 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [2.0, 4.0, 6.0], "x": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [],
+ ... [dfn.functions.regr_intercept(dfn.col("y"),
dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 0.0
+
.. py:function:: regr_r2(y: datafusion.expr.Expr, x: datafusion.expr.Expr,
filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2576,6 +2638,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [2.0, 4.0, 6.0], "x": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_r2(dfn.col("y"), dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: regr_slope(y: datafusion.expr.Expr, x: datafusion.expr.Expr,
filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2591,6 +2662,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [2.0, 4.0, 6.0], "x": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_slope(dfn.col("y"),
dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: regr_sxx(y: datafusion.expr.Expr, x: datafusion.expr.Expr,
filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2606,6 +2686,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [1.0, 2.0, 3.0], "x": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_sxx(dfn.col("y"), dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: regr_sxy(y: datafusion.expr.Expr, x: datafusion.expr.Expr,
filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2621,6 +2710,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [1.0, 2.0, 3.0], "x": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_sxy(dfn.col("y"), dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: regr_syy(y: datafusion.expr.Expr, x: datafusion.expr.Expr,
filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2636,6 +2734,15 @@ Module Contents
:param x: The linear regression independent variable
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"y": [1.0, 2.0, 3.0], "x": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.regr_syy(dfn.col("y"), dfn.col("x")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: repeat(string: datafusion.expr.Expr, n: datafusion.expr.Expr)
-> datafusion.expr.Expr
@@ -2848,6 +2955,14 @@ Module Contents
:param expression: The value to find the minimum of
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [2.0, 4.0, 6.0]})
+ >>> result = df.aggregate([],
[dfn.functions.stddev(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: stddev_pop(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2859,6 +2974,16 @@ Module Contents
:param expression: The value to find the minimum of
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.stddev_pop(dfn.col("a")).alias("v")]
+ ... )
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: stddev_samp(arg: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -2866,6 +2991,16 @@ Module Contents
This is an alias for :py:func:`stddev`.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [2.0, 4.0, 6.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.stddev_samp(dfn.col("a")).alias("v")]
+ ... )
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: string_agg(expression: datafusion.expr.Expr, delimiter: str,
filter: datafusion.expr.Expr | None = None, order_by:
list[datafusion.expr.SortKey] | datafusion.expr.SortKey | None = None) ->
datafusion.expr.Expr
@@ -3195,6 +3330,14 @@ Module Contents
This is an alias for :py:func:`var_samp`.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate([], [dfn.functions.var(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: var_pop(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -3206,6 +3349,14 @@ Module Contents
:param expression: The variable to compute the variance for
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [0.0, 2.0]})
+ >>> result = df.aggregate([],
[dfn.functions.var_pop(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: var_samp(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -3217,6 +3368,14 @@ Module Contents
:param expression: The variable to compute the variance for
:param filter: If provided, only compute against rows for which the filter
is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate([],
[dfn.functions.var_samp(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: var_sample(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -3224,6 +3383,16 @@ Module Contents
This is an alias for :py:func:`var_samp`.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.var_sample(dfn.col("a")).alias("v")]
+ ... )
+ >>> result.collect_column("v")[0].as_py()
+ 1.0
+
.. py:function:: when(when: datafusion.expr.Expr, then: datafusion.expr.Expr)
-> datafusion.expr.CaseBuilder
diff --git a/autoapi/datafusion/functions/index.html
b/autoapi/datafusion/functions/index.html
index de7a15a8..cb836d3a 100644
--- a/autoapi/datafusion/functions/index.html
+++ b/autoapi/datafusion/functions/index.html
@@ -4350,6 +4350,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"b"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">corr</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class=" [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4388,14 +4397,11 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">from</span><span class="w"> </span><span class="nn">math</span><span
class="w"> </span><span class="kn">import</span> <span class="n">pi</span>
<span class="gp">>>> </span><span class="n">ctx</span> <span
class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">SessionContext</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="n">pi</span> <span class="o">/</span> <span
class="mi">4</span><span class="p">]})</span>
-<span class="gp">>>> </span><span class="kn">import</span><span
class="w"> </span><span class="nn">builtins</span>
<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">cot</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">))</span><span
class="o">.</span><span class="n">alias</span><span class="p">(</span><span
class="s2">"cot"</span><span class="p">)</span>
<span class="gp">... </span><span class="p">)</span>
-<span class="gp">>>> </span><span class="n">builtins</span><span
class="o">.</span><span class="n">round</span><span class="p">(</span>
-<span class="gp">... </span> <span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"cot"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">(),</span> <span
class="mi">1</span>
-<span class="gp">... </span><span class="p">)</span>
-<span class="go">1.0</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"cot"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0...</span>
</pre></div>
</div>
</dd></dl>
@@ -4454,7 +4460,10 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<dt class="sig sig-object py" id="datafusion.functions.covar">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">covar</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">value_y</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafusi [...]
<dd><p>Computes the sample covariance.</p>
+<div class="admonition seealso">
+<p class="admonition-title">See also</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.covar_samp"
title="datafusion.functions.covar_samp"><code class="xref py py-func docutils
literal notranslate"><span class="pre">covar_samp()</span></code></a>.</p>
+</div>
</dd></dl>
<dl class="py function">
@@ -4473,6 +4482,19 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">5.0</span><span class="p">,</span> <span class="mf">10.0</span><span
class="p">],</span> <span class="s2">"b"</span><span class="p [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span>
+<span class="gp">... </span> <span class="p">[</span><span
class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">covar_pop</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"b"</span><span class="p">)</span>
+<span class="gp">... </span> <span class="p">)</span><span
class="o">.</span><span class="n">alias</span><span class="p">(</span><span
class="s2">"v"</span><span class="p">)]</span>
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4491,6 +4513,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"b"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">covar_samp</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span c [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -5754,14 +5785,11 @@ column names or expressions.</p></li>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">from</span><span class="w"> </span><span class="nn">math</span><span
class="w"> </span><span class="kn">import</span> <span class="n">pi</span>
<span class="gp">>>> </span><span class="n">ctx</span> <span
class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">SessionContext</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">180.0</span><span class="p">]})</span>
-<span class="gp">>>> </span><span class="kn">import</span><span
class="w"> </span><span class="nn">builtins</span>
<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">radians</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">))</span><span
class="o">.</span><span class="n">alias</span><span class="p">(</span><span
class="s2">"rad"</span><span class="p">)</span>
<span class="gp">... </span><span class="p">)</span>
-<span class="gp">>>> </span><span class="n">builtins</span><span
class="o">.</span><span class="n">round</span><span class="p">(</span>
-<span class="gp">... </span> <span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"rad"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">(),</span> <span
class="mi">6</span>
-<span class="gp">... </span><span class="p">)</span>
-<span class="go">3.141593</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"rad"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span> <span
class="o">==</span> <span class="n">pi</span>
+<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
@@ -5952,6 +5980,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_avgx</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span cl [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">5.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -5971,6 +6008,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_avgy</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span cl [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -5990,6 +6036,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_count</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span c [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6009,6 +6064,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span
class="mf">4.0</span><span class="p">,</span> <span class="mf">6.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span>
+<span class="gp">... </span> <span class="p">[</span><span
class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_intercept</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span class="p">(</span><span [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">0.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6028,6 +6093,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span
class="mf">4.0</span><span class="p">,</span> <span class="mf">6.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_r2</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"y"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
clas [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6047,6 +6121,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span
class="mf">4.0</span><span class="p">,</span> <span class="mf">6.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_slope</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span c [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6066,6 +6149,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_sxx</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span cla [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6085,6 +6177,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_sxy</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span cla [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6104,6 +6205,15 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"y"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"x"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">regr_syy</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"y"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span cla [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6340,6 +6450,14 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span
class="mf">4.0</span><span class="p">,</span> <span class="mf">6.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">stddev</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span cl
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6356,6 +6474,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">3.0</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">stddev_pop</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">))</span><span class="o">.</span><span class="n">alias</span><span
class="p">(</span><span cl [...]
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6363,6 +6491,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">stddev_samp</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">arg</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafu [...]
<dd><p>Computes the sample standard deviation of the argument.</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.stddev" title="datafusion.functions.stddev"><code
class="xref py py-func docutils literal notranslate"><span
class="pre">stddev()</span></code></a>.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">2.0</span><span class="p">,</span> <span
class="mf">4.0</span><span class="p">,</span> <span class="mf">6.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">stddev_samp</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">))</span><span class="o">.</span><span class="n">alias</span><span
class="p">(</span><span c [...]
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6711,6 +6849,14 @@ HH:MM:SS.nnnnnnnnn;</p>
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">var</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expression</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafus [...]
<dd><p>Computes the sample variance of the argument.</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.var_samp"
title="datafusion.functions.var_samp"><code class="xref py py-func docutils
literal notranslate"><span class="pre">var_samp()</span></code></a>.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">var</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span class
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6727,6 +6873,14 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">var_pop</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span c
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6743,6 +6897,14 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">var_samp</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6750,6 +6912,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">var_sample</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expression</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre"> [...]
<dd><p>Computes the sample variance of the argument.</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.var_samp"
title="datafusion.functions.var_samp"><code class="xref py py-func docutils
literal notranslate"><span class="pre">var_samp()</span></code></a>.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">var_sample</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">))</span><span class="o">.</span><span class="n">alias</span><span
class="p">(</span><span cl [...]
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1.0</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
diff --git a/searchindex.js b/searchindex.js
index 6371e196..253aef5e 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, null]], "Additional
Resources": [[37, "additional-resources"]], "Aggregate Functions": [[24,
"aggregate-functions"], [31, "aggregate-functions"], [33,
"aggregate-functions"]], "Aggregation": [[24, null]], "Alternative Approach":
[[20, "alternative-approach"]], "Apache Iceberg": [[35, "apache-iceberg"]],
"Arrays": [[26, "arrays"]], "Arrow": [[39, null]], "Attributes": [[4,
"attributes"], [5, "attributes"], [7, "attributes"], [12, "attr [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, null]], "Additional
Resources": [[37, "additional-resources"]], "Aggregate Functions": [[24,
"aggregate-functions"], [31, "aggregate-functions"], [33,
"aggregate-functions"]], "Aggregation": [[24, null]], "Alternative Approach":
[[20, "alternative-approach"]], "Apache Iceberg": [[35, "apache-iceberg"]],
"Arrays": [[26, "arrays"]], "Arrow": [[39, null]], "Attributes": [[4,
"attributes"], [5, "attributes"], [7, "attributes"], [12, "attr [...]
\ No newline at end of file
diff --git a/user-guide/common-operations/aggregations.html
b/user-guide/common-operations/aggregations.html
index a32867b0..3e79ead1 100644
--- a/user-guide/common-operations/aggregations.html
+++ b/user-guide/common-operations/aggregations.html
@@ -620,15 +620,15 @@ Pokemon set. Since there will be many entries of <code
class="docutils literal n
<span
class="o">+----------+--------------------------------------------------+</span>
<span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span>
<span class="o">|</span> <span class="n">Type</span> <span
class="mi">2</span> <span class="n">List</span>
<span class="o">|</span>
<span
class="o">+----------+--------------------------------------------------+</span>
-<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Grass</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="p">]</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Flying</span><span
class="p">,</span> <span class="n">Steel</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Grass</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">,</span> <span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Ground</span><span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Steel</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Fairy</span> <span
class="o">|</span> <span class="p">[]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Fairy</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Flying</span><span
class="p">,</span> <span class="n">Fairy</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">,</span> <span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Poison</span><span
class="p">]</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Dragon</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="n">Ice</span><span class="p">,</span> <span
class="n">Fighting</span><span class="p">,</span> <span
class="n">Poison</span><span class="p">,</span> <span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Dark</span><span
class="p">,</span> <span class="n">Fighting</span><span class="p">,</span>
<span class="n">Ice</span><span class="p">,</span> <span class="p">,</span>
<span class="n">Flying</span><span class="p">,</span> <span
class="n">Poison</span><span class="p">,</span> <span
class="n">Psychic</span><span class="p">]</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Ground</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Rock</span><span
class="p">]</span> <span
class="o">|</span>
<span
class="o">+----------+--------------------------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
@@ -648,11 +648,11 @@ entries entirely removed. The second is we can use the
<code class="docutils lit
<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Steel</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Fairy</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Dragon</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span class="n">Ice</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span
class="n">Fighting</span><span class="p">]</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">Rock</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Water</span><span
class="p">,</span> <span class="n">Ground</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">]</span> <span
class="o">|</span>
+<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Dragon</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Ice</span><span class="p">,</span> <span
class="n">Psychic</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span
class="n">Fighting</span><span class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Rock</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span
class="p">,</span> <span class="n">Water</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">]</span> <span
class="o">|</span>
<span class="o">|</span> <span class="n">Ghost</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">]</span> <span
class="o">|</span>
<span
class="o">+----------+------------------------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
@@ -663,15 +663,15 @@ entries entirely removed. The second is we can use the
<code class="docutils lit
<span
class="o">+----------+------------------------------------------------+</span>
<span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span>
<span class="o">|</span> <span class="n">Type</span> <span
class="mi">2</span> <span class="n">List</span>
<span class="o">|</span>
<span
class="o">+----------+------------------------------------------------+</span>
-<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Grass</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">]</span> <span
class="o">|</span>
-<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Ground</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Grass</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="n">Poison</span><span class="p">]</span> <span
class="o">|</span>
+<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Steel</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Fairy</span> <span
class="o">|</span> <span
class="o">|</span>
-<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Fairy</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Fairy</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Dragon</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Fighting</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">,</span> <span
class="n">Poison</span><span class="p">,</span> <span class="n">Ice</span><span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Fighting</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span
class="n">Psychic</span><span class="p">,</span> <span
class="n">Ice</span><span class="p">,</span> <span class="n">Flying</span><span
class="p">]</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Ground</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Rock</span><span
class="p">]</span> <span
class="o">|</span>
<span
class="o">+----------+------------------------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
diff --git a/user-guide/common-operations/basic-info.html
b/user-guide/common-operations/basic-info.html
index 3240ac20..4045aff9 100644
--- a/user-guide/common-operations/basic-info.html
+++ b/user-guide/common-operations/basic-info.html
@@ -456,11 +456,11 @@
<span class="o">+-----+---------+--------+--------+</span>
<span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span>
<span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span class="n">groups</span>
<span class="o">|</span>
<span class="o">+-----+---------+--------+--------+</span>
-<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">773</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">333</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">3</span> <span class="o">|</span>
<span class="n">java</span> <span class="o">|</span> <span
class="mi">117</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">4</span> <span class="o">|</span>
<span class="n">haskell</span> <span class="o">|</span> <span
class="mi">943</span> <span class="o">|</span> <span class="n">C</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">5</span> <span class="o">|</span>
<span class="n">go</span> <span class="o">|</span> <span
class="mi">226</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">937</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">153</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">3</span> <span class="o">|</span>
<span class="n">java</span> <span class="o">|</span> <span
class="mi">151</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">4</span> <span class="o">|</span>
<span class="n">haskell</span> <span class="o">|</span> <span
class="mi">529</span> <span class="o">|</span> <span class="n">C</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">5</span> <span class="o">|</span>
<span class="n">go</span> <span class="o">|</span> <span
class="mi">363</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
<span class="o">+-----+---------+--------+--------+</span>
</pre></div>
</div>
@@ -471,8 +471,8 @@
<span class="o">+-----+--------+--------+--------+</span>
<span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span>
<span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span class="n">groups</span>
<span class="o">|</span>
<span class="o">+-----+--------+--------+--------+</span>
-<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">773</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">333</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">937</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">153</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
<span class="o">+-----+--------+--------+--------+</span>
</pre></div>
</div>
@@ -490,28 +490,28 @@ passing them to an Arrow table, and then converting them
to a pandas DataFrame.<
<div class="highlight-ipython notranslate"><div
class="highlight"><pre><span></span><span class="n">In</span> <span
class="p">[</span><span class="mi">8</span><span class="p">]:</span> <span
class="n">df</span><span class="o">.</span><span
class="n">to_pandas</span><span class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span
class="mi">8</span><span class="p">]:</span>
<span class="n">nrs</span> <span class="n">names</span> <span
class="n">random</span> <span class="n">groups</span>
-<span class="mi">0</span> <span class="mi">1</span> <span
class="n">python</span> <span class="mi">773</span> <span
class="n">A</span>
-<span class="mi">1</span> <span class="mi">2</span> <span
class="n">ruby</span> <span class="mi">333</span> <span
class="n">A</span>
-<span class="mi">2</span> <span class="mi">3</span> <span
class="n">java</span> <span class="mi">117</span> <span
class="n">B</span>
-<span class="mi">3</span> <span class="mi">4</span> <span
class="n">haskell</span> <span class="mi">943</span> <span
class="n">C</span>
-<span class="mi">4</span> <span class="mi">5</span> <span
class="n">go</span> <span class="mi">226</span> <span
class="n">B</span>
+<span class="mi">0</span> <span class="mi">1</span> <span
class="n">python</span> <span class="mi">937</span> <span
class="n">A</span>
+<span class="mi">1</span> <span class="mi">2</span> <span
class="n">ruby</span> <span class="mi">153</span> <span
class="n">A</span>
+<span class="mi">2</span> <span class="mi">3</span> <span
class="n">java</span> <span class="mi">151</span> <span
class="n">B</span>
+<span class="mi">3</span> <span class="mi">4</span> <span
class="n">haskell</span> <span class="mi">529</span> <span
class="n">C</span>
+<span class="mi">4</span> <span class="mi">5</span> <span
class="n">go</span> <span class="mi">363</span> <span
class="n">B</span>
</pre></div>
</div>
<p><a class="reference internal"
href="../../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.describe"
title="datafusion.dataframe.DataFrame.describe"><code class="xref py py-func
docutils literal notranslate"><span class="pre">describe()</span></code></a>
shows a quick statistic summary of your data:</p>
<div class="highlight-ipython notranslate"><div
class="highlight"><pre><span></span><span class="n">In</span> <span
class="p">[</span><span class="mi">9</span><span class="p">]:</span> <span
class="n">df</span><span class="o">.</span><span class="n">describe</span><span
class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span
class="mi">9</span><span class="p">]:</span>
<span class="n">DataFrame</span><span class="p">()</span>
-<span
class="o">+------------+--------------------+-------+-------------------+--------+</span>
-<span class="o">|</span> <span class="n">describe</span> <span
class="o">|</span> <span class="n">nrs</span> <span
class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span
class="n">groups</span> <span class="o">|</span>
-<span
class="o">+------------+--------------------+-------+-------------------+--------+</span>
-<span class="o">|</span> <span class="n">count</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span
class="mf">5.0</span> <span class="o">|</span> <span
class="mi">5</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">null_count</span> <span
class="o">|</span> <span class="mf">0.0</span> <span
class="o">|</span> <span class="mi">0</span> <span class="o">|</span> <span
class="mf">0.0</span> <span class="o">|</span> <span
class="mi">0</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">mean</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">478.4</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">std</span> <span
class="o">|</span> <span class="mf">1.5811388300841898</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">359.8955404002667</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
-<span class="o">|</span> <span class="nb">min</span> <span
class="o">|</span> <span class="mf">1.0</span> <span
class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span
class="mf">117.0</span> <span class="o">|</span> <span
class="n">A</span> <span class="o">|</span>
-<span class="o">|</span> <span class="nb">max</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span
class="mf">943.0</span> <span class="o">|</span> <span
class="n">C</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">median</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">333.0</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
-<span
class="o">+------------+--------------------+-------+-------------------+--------+</span>
+<span
class="o">+------------+--------------------+-------+--------------------+--------+</span>
+<span class="o">|</span> <span class="n">describe</span> <span
class="o">|</span> <span class="n">nrs</span> <span
class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span
class="n">groups</span> <span class="o">|</span>
+<span
class="o">+------------+--------------------+-------+--------------------+--------+</span>
+<span class="o">|</span> <span class="n">count</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span
class="mf">5.0</span> <span class="o">|</span> <span
class="mi">5</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">null_count</span> <span
class="o">|</span> <span class="mf">0.0</span> <span
class="o">|</span> <span class="mi">0</span> <span class="o">|</span> <span
class="mf">0.0</span> <span class="o">|</span> <span
class="mi">0</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">mean</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">426.6</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">std</span> <span
class="o">|</span> <span class="mf">1.5811388300841898</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">326.28637728228864</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
+<span class="o">|</span> <span class="nb">min</span> <span
class="o">|</span> <span class="mf">1.0</span> <span
class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span
class="mf">151.0</span> <span class="o">|</span> <span
class="n">A</span> <span class="o">|</span>
+<span class="o">|</span> <span class="nb">max</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span
class="mf">937.0</span> <span class="o">|</span> <span
class="n">C</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">median</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">363.0</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
+<span
class="o">+------------+--------------------+-------+--------------------+--------+</span>
</pre></div>
</div>
</section>
diff --git a/user-guide/common-operations/functions.html
b/user-guide/common-operations/functions.html
index 26dd3284..798a3240 100644
--- a/user-guide/common-operations/functions.html
+++ b/user-guide/common-operations/functions.html
@@ -566,16 +566,16 @@ In here we will cover some of the more popular use cases.
If you want to view al
<span class="o">+-------------------------------+</span>
<span class="o">|</span> <span class="n">now</span><span class="p">()</span>
<span class="o">|</span>
<span class="o">+-------------------------------+</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">14</span><span class="p">:</span><span
class="mf">08.563777484</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">18</span><span class="n">T06</span><span class="p">:</span><span
class="mi">16</span><span class="p">:</span><span
class="mf">07.390088442</span> <span class="o">|</span>
<span class="o">+-------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
</pre></div>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
