Skip to content

Commit 9512ab1

Browse files
Add correction keyword argument to dpnp.std and dpnp.var (#2300)
The PR proposes to add `correction` keyword argument to statistics functions, assuming `dpnp.std`, `dpnp.var`, `dpnp.nanstd`, `dpnp.nanvar` functions and `dpnp.ndarray.std`, `dpnp.ndarray.var` methods. The keyword is mandated according to python array API. The corresponding muted tests are enabled in python array API compliance scope. Also this PR adds improvements to the docstrings of functions from statistics interface. f97b64c
1 parent 5e7bc4d commit 9512ab1

File tree

703 files changed

+1857
-1582
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

703 files changed

+1857
-1582
lines changed

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 126cb26d36eca07967908956510543d3
3+
config: f2ac0180b85040abd25b0c3e2f61f41a
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/dpnp/dpnp_array.html

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>
@@ -1926,6 +1926,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
19261926
<span class="o">*</span><span class="p">,</span>
19271927
<span class="n">where</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
19281928
<span class="n">mean</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
1929+
<span class="n">correction</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
19291930
<span class="p">):</span>
19301931
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
19311932
<span class="sd"> Returns the standard deviation of the array elements, along given axis.</span>
@@ -1935,7 +1936,15 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
19351936
<span class="sd"> &quot;&quot;&quot;</span>
19361937

19371938
<span class="k">return</span> <span class="n">dpnp</span><span class="o">.</span><span class="n">std</span><span class="p">(</span>
1938-
<span class="bp">self</span><span class="p">,</span> <span class="n">axis</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">ddof</span><span class="p">,</span> <span class="n">keepdims</span><span class="p">,</span> <span class="n">where</span><span class="o">=</span><span class="n">where</span><span class="p">,</span> <span class="n">mean</span><span class="o">=</span><span class="n">mean</span>
1939+
<span class="bp">self</span><span class="p">,</span>
1940+
<span class="n">axis</span><span class="p">,</span>
1941+
<span class="n">dtype</span><span class="p">,</span>
1942+
<span class="n">out</span><span class="p">,</span>
1943+
<span class="n">ddof</span><span class="p">,</span>
1944+
<span class="n">keepdims</span><span class="p">,</span>
1945+
<span class="n">where</span><span class="o">=</span><span class="n">where</span><span class="p">,</span>
1946+
<span class="n">mean</span><span class="o">=</span><span class="n">mean</span><span class="p">,</span>
1947+
<span class="n">correction</span><span class="o">=</span><span class="n">correction</span><span class="p">,</span>
19391948
<span class="p">)</span></div>
19401949

19411950

@@ -2157,6 +2166,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
21572166
<span class="o">*</span><span class="p">,</span>
21582167
<span class="n">where</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
21592168
<span class="n">mean</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
2169+
<span class="n">correction</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
21602170
<span class="p">):</span>
21612171
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
21622172
<span class="sd"> Returns the variance of the array elements, along given axis.</span>
@@ -2166,7 +2176,15 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
21662176
<span class="sd"> &quot;&quot;&quot;</span>
21672177

21682178
<span class="k">return</span> <span class="n">dpnp</span><span class="o">.</span><span class="n">var</span><span class="p">(</span>
2169-
<span class="bp">self</span><span class="p">,</span> <span class="n">axis</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">ddof</span><span class="p">,</span> <span class="n">keepdims</span><span class="p">,</span> <span class="n">where</span><span class="o">=</span><span class="n">where</span><span class="p">,</span> <span class="n">mean</span><span class="o">=</span><span class="n">mean</span>
2179+
<span class="bp">self</span><span class="p">,</span>
2180+
<span class="n">axis</span><span class="p">,</span>
2181+
<span class="n">dtype</span><span class="p">,</span>
2182+
<span class="n">out</span><span class="p">,</span>
2183+
<span class="n">ddof</span><span class="p">,</span>
2184+
<span class="n">keepdims</span><span class="p">,</span>
2185+
<span class="n">where</span><span class="o">=</span><span class="n">where</span><span class="p">,</span>
2186+
<span class="n">mean</span><span class="o">=</span><span class="n">mean</span><span class="p">,</span>
2187+
<span class="n">correction</span><span class="o">=</span><span class="n">correction</span><span class="p">,</span>
21702188
<span class="p">)</span></div>
21712189
</div>
21722190

_modules/dpnp/dpnp_array_api_info.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

_modules/dpnp/dpnp_flatiter.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

_modules/dpnp/dpnp_iface.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

_modules/dpnp/dpnp_iface_arraycreation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

_modules/dpnp/dpnp_iface_bitwise.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

_modules/dpnp/dpnp_iface_counting.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

_modules/dpnp/dpnp_iface_functional.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

_modules/dpnp/dpnp_iface_histograms.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.17.0dev6+1.g63ce8584a38 documentation</title>
17+
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.17.0dev6+2.gf97b64c08a7 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020

2121

2222
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2323
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
24-
<script src="../../_static/documentation_options.js?v=a4a36aa7"></script>
24+
<script src="../../_static/documentation_options.js?v=cac1da1e"></script>
2525
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2626
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2727
<script src="../../_static/js/theme.js"></script>

0 commit comments

Comments
 (0)