Skip to content

Commit 7aa2090

Browse files
Add device, sycl_queue and usm_type keywords to dpnp.ndarray.copy method (#1976)
* Add device, sycl_queue and usm_type keywords to dpnp.ndarray.copy * Align description of sycl_queue keyword * Applied black formatting * Updated third party tests * Added tests for SYCL queue and USM device * update fftfreq and rfftfreq docstring --------- Co-authored-by: Vahid Tavanashad <[email protected]> Co-authored-by: vtavana <[email protected]> 6ae16ce
1 parent 62756ff commit 7aa2090

File tree

506 files changed

+2094
-1628
lines changed

Some content is hidden

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

506 files changed

+2094
-1628
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 hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 879cd041dfa92b638256b09f2d30e714
3+
config: 89cd5926c07abd7e2f0aa4b2bc17b4bf
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/dpnp/dpnp_array.html

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.16.0dev0+112.ge4acd3eff4 documentation</title>
15+
<title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.16.0dev0+113.g6ae16ce5bf documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=edd98bb5"></script>
26+
<script src="../../_static/documentation_options.js?v=714a5aca"></script>
2727
<script src="../../_static/doctools.js?v=9a2dae69"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.16.0dev0+112.ge4acd3eff4
46+
0.16.0dev0+113.g6ae16ce5bf
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -856,10 +856,35 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
856856

857857
<div class="viewcode-block" id="dpnp_array.copy">
858858
<a class="viewcode-back" href="../../reference/generated/dpnp.dpnp_array.dpnp_array.html#dpnp.dpnp_array.dpnp_array.copy">[docs]</a>
859-
<span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s2">&quot;C&quot;</span><span class="p">):</span>
859+
<span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s2">&quot;C&quot;</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">usm_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sycl_queue</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
860860
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
861861
<span class="sd"> Return a copy of the array.</span>
862862

863+
<span class="sd"> Refer to :obj:`dpnp.copy` for full documentation.</span>
864+
865+
<span class="sd"> Parameters</span>
866+
<span class="sd"> ----------</span>
867+
<span class="sd"> order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
868+
<span class="sd"> Memory layout of the newly output array.</span>
869+
<span class="sd"> Default: ``&quot;C&quot;``.</span>
870+
<span class="sd"> device : {None, string, SyclDevice, SyclQueue}, optional</span>
871+
<span class="sd"> An array API concept of device where the output array is created.</span>
872+
<span class="sd"> The `device` can be ``None`` (the default), an OneAPI filter</span>
873+
<span class="sd"> selector string, an instance of :class:`dpctl.SyclDevice`</span>
874+
<span class="sd"> corresponding to a non-partitioned SYCL device, an instance of</span>
875+
<span class="sd"> :class:`dpctl.SyclQueue`, or a `Device` object returned by</span>
876+
<span class="sd"> :obj:`dpnp.dpnp_array.dpnp_array.device` property.</span>
877+
<span class="sd"> Default: ``None``.</span>
878+
<span class="sd"> usm_type : {None, &quot;device&quot;, &quot;shared&quot;, &quot;host&quot;}, optional</span>
879+
<span class="sd"> The type of SYCL USM allocation for the output array.</span>
880+
<span class="sd"> Default: ``None``.</span>
881+
<span class="sd"> sycl_queue : {None, SyclQueue}, optional</span>
882+
<span class="sd"> A SYCL queue to use for output array allocation and copying. The</span>
883+
<span class="sd"> `sycl_queue` can be passed as ``None`` (the default), which means</span>
884+
<span class="sd"> to get the SYCL queue from `device` keyword if present or to use</span>
885+
<span class="sd"> a default queue.</span>
886+
<span class="sd"> Default: ``None``.</span>
887+
863888
<span class="sd"> Returns</span>
864889
<span class="sd"> -------</span>
865890
<span class="sd"> out : dpnp.ndarray</span>
@@ -872,8 +897,9 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
872897

873898
<span class="sd"> Notes</span>
874899
<span class="sd"> -----</span>
875-
<span class="sd"> This function is the preferred method for creating an array copy. The</span>
876-
<span class="sd"> function :func:`dpnp.copy` is similar, but it defaults to using order &#39;K&#39;.</span>
900+
<span class="sd"> This function is the preferred method for creating an array copy.</span>
901+
<span class="sd"> The function :func:`dpnp.copy` is similar, but it defaults to using</span>
902+
<span class="sd"> order ``&quot;K&quot;``.</span>
877903

878904
<span class="sd"> Examples</span>
879905
<span class="sd"> --------</span>
@@ -895,7 +921,13 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
895921

896922
<span class="sd"> &quot;&quot;&quot;</span>
897923

898-
<span class="k">return</span> <span class="n">dpnp</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">)</span></div>
924+
<span class="k">return</span> <span class="n">dpnp</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span>
925+
<span class="bp">self</span><span class="p">,</span>
926+
<span class="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">,</span>
927+
<span class="n">device</span><span class="o">=</span><span class="n">device</span><span class="p">,</span>
928+
<span class="n">usm_type</span><span class="o">=</span><span class="n">usm_type</span><span class="p">,</span>
929+
<span class="n">sycl_queue</span><span class="o">=</span><span class="n">sycl_queue</span><span class="p">,</span>
930+
<span class="p">)</span></div>
899931

900932

901933
<span class="c1"># &#39;ctypes&#39;,</span>

_modules/dpnp/dpnp_flatiter.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.16.0dev0+112.ge4acd3eff4 documentation</title>
15+
<title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.16.0dev0+113.g6ae16ce5bf documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=edd98bb5"></script>
26+
<script src="../../_static/documentation_options.js?v=714a5aca"></script>
2727
<script src="../../_static/doctools.js?v=9a2dae69"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.16.0dev0+112.ge4acd3eff4
46+
0.16.0dev0+113.g6ae16ce5bf
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

_modules/dpnp/dpnp_iface.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</script>
1313

1414
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
15-
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.16.0dev0+112.ge4acd3eff4 documentation</title>
15+
<title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.16.0dev0+113.g6ae16ce5bf documentation</title>
1616
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1717
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
1818

@@ -23,7 +23,7 @@
2323

2424
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2525
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26-
<script src="../../_static/documentation_options.js?v=edd98bb5"></script>
26+
<script src="../../_static/documentation_options.js?v=714a5aca"></script>
2727
<script src="../../_static/doctools.js?v=9a2dae69"></script>
2828
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2929
<script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
4343
Data Parallel Extension for NumPy
4444
</a>
4545
<div class="version">
46-
0.16.0dev0+112.ge4acd3eff4
46+
0.16.0dev0+113.g6ae16ce5bf
4747
</div>
4848
<div role="search">
4949
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

0 commit comments

Comments
 (0)