Skip to content

Commit 915642e

Browse files
github-actions[bot]github-actions[bot]
committed
Update dpnp.ndarray docstrings (#2422)
This PR improves documentations of `dpnp.ndarray` class, including: - adding missing docstrings to the methods and attributes - extending `ndarray.rst` page to have all methods and attributes rendered - aligning signatures of the methods with numpy.ndarray class - adding a page with dpnp constants - updating a link with `dpnp.DLDeviceType` enum Also `dpnp_array.py` was added to pylint scope. f93db81
1 parent 2168d23 commit 915642e

File tree

743 files changed

+5657
-2387
lines changed

Some content is hidden

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

743 files changed

+5657
-2387
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: 25a6f231e121602ac546c537ce0a9df4
3+
config: e8af9150191947c021ea6729765e91d9
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_modules/dpnp/dpnp_array.html

Lines changed: 447 additions & 295 deletions
Large diffs are not rendered by default.

‎_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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_array_api_info &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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: 9 additions & 8 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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_iface_arraycreation &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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>
@@ -2321,8 +2321,9 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
23212321
<span class="sd"> Parameters</span>
23222322
<span class="sd"> ----------</span>
23232323
<span class="sd"> x : object</span>
2324-
<span class="sd"> A Python object representing an array that implements the ``__dlpack__``</span>
2325-
<span class="sd"> and ``__dlpack_device__`` methods.</span>
2324+
<span class="sd"> A Python object representing an array that implements the</span>
2325+
<span class="sd"> :meth:`dpnp.ndarray.__dlpack__` and</span>
2326+
<span class="sd"> :meth:`dpnp.ndarray.__dlpack_device__`.</span>
23262327
<span class="sd"> device : {None, string, tuple, device}, optional</span>
23272328
<span class="sd"> Device where the output array is to be placed. `device` keyword values</span>
23282329
<span class="sd"> can be:</span>
@@ -2338,10 +2339,10 @@ <h1>Source code for dpnp.dpnp_iface_arraycreation</h1><div class="highlight"><pr
23382339
<span class="sd"> ``device.sycl_queue``. The `device` object is obtained via</span>
23392340
<span class="sd"> :attr:`dpctl.tensor.usm_ndarray.device`.</span>
23402341
<span class="sd"> * ``(device_type, device_id)`` : 2-tuple matching the format of the</span>
2341-
<span class="sd"> output of the ``__dlpack_device__`` method: an integer enumerator</span>
2342-
<span class="sd"> representing the device type followed by an integer representing</span>
2343-
<span class="sd"> the index of the device. The only supported :class:`dpnp.DLDeviceType`</span>
2344-
<span class="sd"> device types are ``&quot;kDLCPU&quot;`` and ``&quot;kDLOneAPI&quot;``.</span>
2342+
<span class="sd"> output of the :meth:`dpnp.ndarray.__dlpack_device__`: an integer</span>
2343+
<span class="sd"> enumerator representing the device type followed by an integer</span>
2344+
<span class="sd"> representing the index of the device. The only supported</span>
2345+
<span class="sd"> :class:`dpnp.DLDeviceType` is ``&quot;kDLCPU&quot;`` or ``&quot;kDLOneAPI&quot;``.</span>
23452346

23462347
<span class="sd"> Default: ``None``.</span>
23472348
<span class="sd"> copy : {bool, None}, optional</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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_iface_bitwise &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_iface_counting &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_iface_functional &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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.19.0dev1+15.g876e9403a7e documentation</title>
17+
<title>dpnp.dpnp_iface_histograms &mdash; Data Parallel Extension for NumPy 0.19.0dev1+17.gf93db815a7 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=dafbec2e"></script>
24+
<script src="../../_static/documentation_options.js?v=ada94ba0"></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)