Skip to content

Commit 33a657a

Browse files
Update docstrings for linalg functions (#2373)
The PR updates docstrings for linalg functions to have a blank line prior `Default` value. Additionally, it adds a space after comma to align with used code style. 764f92c
1 parent 7eddf45 commit 33a657a

File tree

716 files changed

+1596
-1573
lines changed

Some content is hidden

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

716 files changed

+1596
-1573
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: 655b58f81e8de44a059b5b54d0051a22
3+
config: 8df2cdfd320b18c83fa276304d844cc7
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/dpnp/dpnp_array.html

Lines changed: 3 additions & 3 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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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>
@@ -1166,7 +1166,7 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
11661166
<span class="sd"> Examples</span>
11671167
<span class="sd"> --------</span>
11681168
<span class="sd"> &gt;&gt;&gt; import dpnp as np</span>
1169-
<span class="sd"> &gt;&gt;&gt; a = np.arange(4).reshape(2,2)</span>
1169+
<span class="sd"> &gt;&gt;&gt; a = np.arange(4).reshape(2, 2)</span>
11701170
<span class="sd"> &gt;&gt;&gt; a.diagonal()</span>
11711171
<span class="sd"> array([0, 3])</span>
11721172

_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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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: 4 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_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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>
@@ -3292,7 +3292,7 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
32923292
<span class="sd"> &gt;&gt;&gt; y = np.arange(-5, 5, 0.1)</span>
32933293
<span class="sd"> &gt;&gt;&gt; xx, yy = np.meshgrid(x, y, sparse=True)</span>
32943294
<span class="sd"> &gt;&gt;&gt; z = np.sin(xx**2 + yy**2) / (xx**2 + yy**2)</span>
3295-
<span class="sd"> &gt;&gt;&gt; h = plt.contourf(x,y,z)</span>
3295+
<span class="sd"> &gt;&gt;&gt; h = plt.contourf(x, y, z)</span>
32963296
<span class="sd"> &gt;&gt;&gt; plt.show()</span>
32973297

32983298
<span class="sd"> &quot;&quot;&quot;</span>
@@ -3368,7 +3368,7 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
33683368
<span class="sd"> Examples</span>
33693369
<span class="sd"> --------</span>
33703370
<span class="sd"> &gt;&gt;&gt; import dpnp as np</span>
3371-
<span class="sd"> &gt;&gt;&gt; np.mgrid[0:5,0:5]</span>
3371+
<span class="sd"> &gt;&gt;&gt; np.mgrid[0:5, 0:5]</span>
33723372
<span class="sd"> array([[[0, 0, 0, 0, 0],</span>
33733373
<span class="sd"> [1, 1, 1, 1, 1],</span>
33743374
<span class="sd"> [2, 2, 2, 2, 2],</span>

_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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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: 3 additions & 3 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.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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>
@@ -902,7 +902,7 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
902902
<span class="sd"> is the number of bins and array is the bin edges.</span>
903903

904904
<span class="sd"> Default: ``10``.</span>
905-
<span class="sd"> range : {None, dpnp.ndarray, usm_ndarray} of shape (2,2), optional</span>
905+
<span class="sd"> range : {None, dpnp.ndarray, usm_ndarray} of shape (2, 2), optional</span>
906906
<span class="sd"> The leftmost and rightmost edges of the bins along each dimension</span>
907907
<span class="sd"> If ``None`` the ranges are</span>
908908
<span class="sd"> ``[[x.min(), x.max()], [y.min(), y.max()]]``. All values outside</span>

_modules/dpnp/dpnp_iface_indexing.html

Lines changed: 6 additions & 6 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_indexing &mdash; Data Parallel Extension for NumPy 0.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface_indexing &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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>
@@ -764,7 +764,7 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
764764
<span class="sd"> Examples</span>
765765
<span class="sd"> --------</span>
766766
<span class="sd"> &gt;&gt;&gt; import dpnp as np</span>
767-
<span class="sd"> &gt;&gt;&gt; a = np.arange(4).reshape(2,2)</span>
767+
<span class="sd"> &gt;&gt;&gt; a = np.arange(4).reshape(2, 2)</span>
768768
<span class="sd"> &gt;&gt;&gt; a</span>
769769
<span class="sd"> array([[0, 1],</span>
770770
<span class="sd"> [2, 3]])</span>
@@ -775,7 +775,7 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
775775

776776
<span class="sd"> A 3-D example:</span>
777777

778-
<span class="sd"> &gt;&gt;&gt; a = np.arange(8).reshape(2,2,2)</span>
778+
<span class="sd"> &gt;&gt;&gt; a = np.arange(8).reshape(2, 2, 2)</span>
779779
<span class="sd"> &gt;&gt;&gt; a</span>
780780
<span class="sd"> array([[[0, 1],</span>
781781
<span class="sd"> [2, 3]],</span>
@@ -1351,8 +1351,8 @@ <h1>Source code for dpnp.dpnp_iface_indexing</h1><div class="highlight"><pre>
13511351
<span class="sd"> N dimensions.</span>
13521352

13531353
<span class="sd"> Using :obj:`dpnp.ix_` one can quickly construct index arrays that will</span>
1354-
<span class="sd"> index the cross product. ``a[dpnp.ix_([1,3],[2,5])]`` returns the array</span>
1355-
<span class="sd"> ``[[a[1,2] a[1,5]], [a[3,2] a[3,5]]]``.</span>
1354+
<span class="sd"> index the cross product. ``a[dpnp.ix_([1, 3],[2, 5])]`` returns the array</span>
1355+
<span class="sd"> ``[[a[1, 2] a[1, 5]], [a[3, 2] a[3, 5]]]``.</span>
13561356

13571357
<span class="sd"> Parameters</span>
13581358
<span class="sd"> ----------</span>

_modules/dpnp/dpnp_iface_libmath.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_libmath &mdash; Data Parallel Extension for NumPy 0.18.0dev0+31.gc2f07350587 documentation</title>
17+
<title>dpnp.dpnp_iface_libmath &mdash; Data Parallel Extension for NumPy 0.18.0dev0+32.g764f92c13f9 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=aa1b071c"></script>
24+
<script src="../../_static/documentation_options.js?v=56b7fb33"></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)