Leverage on dpctl.tensor implementation in dpnp.take_along_axis d2cb65b

Author: github-actions[bot]

pull/1969/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e395942f1199ed54462eae9719751525
+config: 57e5cf5daf4ef166f043e7040ed8a90c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

pull/1969/_modules/dpnp/dpnp_array.html

@@ -12,7 +12,7 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.16.0dev0+116.g51f10b8338 documentation</title>
+  <title>dpnp.dpnp_array &mdash; Data Parallel Extension for NumPy 0.16.0dev0+123.gd2cb65ba4c documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -23,7 +23,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=046e4312"></script>
+        <script src="../../_static/documentation_options.js?v=95c6a3ab"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
             Data Parallel Extension for NumPy
           </a>
               <div class="version">
-                0.16.0dev0+116.g51f10b8338
+                0.16.0dev0+123.gd2cb65ba4c
               </div>
 <div role="search">
   <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>
 
 <div class="viewcode-block" id="dpnp_array.copy">
 <a class="viewcode-back" href="../../reference/generated/dpnp.dpnp_array.dpnp_array.html#dpnp.dpnp_array.dpnp_array.copy">[docs]</a>
-    <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="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>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Return a copy of the array.</span>
 
+<span class="sd">        Refer to :obj:`dpnp.copy` for full documentation.</span>
+
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        order : {&quot;C&quot;, &quot;F&quot;, &quot;A&quot;, &quot;K&quot;}, optional</span>
+<span class="sd">            Memory layout of the newly output array.</span>
+<span class="sd">            Default: ``&quot;C&quot;``.</span>
+<span class="sd">        device : {None, string, SyclDevice, SyclQueue}, optional</span>
+<span class="sd">            An array API concept of device where the output array is created.</span>
+<span class="sd">            The `device` can be ``None`` (the default), an OneAPI filter</span>
+<span class="sd">            selector string, an instance of :class:`dpctl.SyclDevice`</span>
+<span class="sd">            corresponding to a non-partitioned SYCL device, an instance of</span>
+<span class="sd">            :class:`dpctl.SyclQueue`, or a `Device` object returned by</span>
+<span class="sd">            :obj:`dpnp.dpnp_array.dpnp_array.device` property.</span>
+<span class="sd">            Default: ``None``.</span>
+<span class="sd">        usm_type : {None, &quot;device&quot;, &quot;shared&quot;, &quot;host&quot;}, optional</span>
+<span class="sd">            The type of SYCL USM allocation for the output array.</span>
+<span class="sd">            Default: ``None``.</span>
+<span class="sd">        sycl_queue : {None, SyclQueue}, optional</span>
+<span class="sd">            A SYCL queue to use for output array allocation and copying. The</span>
+<span class="sd">            `sycl_queue` can be passed as ``None`` (the default), which means</span>
+<span class="sd">            to get the SYCL queue from `device` keyword if present or to use</span>
+<span class="sd">            a default queue.</span>
+<span class="sd">            Default: ``None``.</span>
+
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        out : dpnp.ndarray</span>
@@ -872,8 +897,9 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
 
 <span class="sd">        Notes</span>
 <span class="sd">        -----</span>
-<span class="sd">        This function is the preferred method for creating an array copy. The</span>
-<span class="sd">        function :func:`dpnp.copy` is similar, but it defaults to using order &#39;K&#39;.</span>
+<span class="sd">        This function is the preferred method for creating an array copy.</span>
+<span class="sd">        The function :func:`dpnp.copy` is similar, but it defaults to using</span>
+<span class="sd">        order ``&quot;K&quot;``.</span>
 
 <span class="sd">        Examples</span>
 <span class="sd">        --------</span>
@@ -895,7 +921,13 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
 
 <span class="sd">        &quot;&quot;&quot;</span>
 
-        <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>
+        <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>
+            <span class="n">device</span><span class="o">=</span><span class="n">device</span><span class="p">,</span>
+            <span class="n">usm_type</span><span class="o">=</span><span class="n">usm_type</span><span class="p">,</span>
+            <span class="n">sycl_queue</span><span class="o">=</span><span class="n">sycl_queue</span><span class="p">,</span>
+        <span class="p">)</span></div>
 
 
     <span class="c1"># &#39;ctypes&#39;,</span>
@@ -1470,12 +1502,45 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">shape</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Lengths of axes. A tuple of numbers represents size of each dimension.</span>
+<span class="sd">        Tuple of array dimensions.</span>
+
+<span class="sd">        The shape property is usually used to get the current shape of an array,</span>
+<span class="sd">        but may also be used to reshape the array in-place by assigning a tuple</span>
+<span class="sd">        of array dimensions to it. Unlike :obj:`dpnp.reshape`, only non-negative</span>
+<span class="sd">        values are supported to be set as new shape. Reshaping an array in-place</span>
+<span class="sd">        will fail if a copy is required.</span>
+
+<span class="sd">        For full documentation refer to :obj:`numpy.ndarray.shape`.</span>
+
+<span class="sd">        Note</span>
+<span class="sd">        ----</span>
+<span class="sd">        Using :obj:`dpnp.ndarray.reshape` or :obj:`dpnp.reshape` is the</span>
+<span class="sd">        preferred approach to set new shape of an array.</span>
 
-<span class="sd">        Setter of this property involves reshaping without copy. If the array</span>
-<span class="sd">        cannot be reshaped without copy, it raises an exception.</span>
+<span class="sd">        See Also</span>
+<span class="sd">        --------</span>
+<span class="sd">        :obj:`dpnp.shape` : Equivalent getter function.</span>
+<span class="sd">        :obj:`dpnp.reshape` : Function similar to setting `shape`.</span>
+<span class="sd">        :obj:`dpnp.ndarray.reshape` : Method similar to setting `shape`.</span>
 
-<span class="sd">        .. seealso: :attr:`numpy.ndarray.shape`</span>
+<span class="sd">        Examples</span>
+<span class="sd">        --------</span>
+<span class="sd">        &gt;&gt;&gt; import dpnp as np</span>
+<span class="sd">        &gt;&gt;&gt; x = np.array([1, 2, 3, 4])</span>
+<span class="sd">        &gt;&gt;&gt; x.shape</span>
+<span class="sd">        (4,)</span>
+<span class="sd">        &gt;&gt;&gt; y = np.zeros((2, 3, 4))</span>
+<span class="sd">        &gt;&gt;&gt; y.shape</span>
+<span class="sd">        (2, 3, 4)</span>
+
+<span class="sd">        &gt;&gt;&gt; y.shape = (3, 8)</span>
+<span class="sd">        &gt;&gt;&gt; y</span>
+<span class="sd">        array([[ 0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.],</span>
+<span class="sd">               [ 0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.],</span>
+<span class="sd">               [ 0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.]])</span>
+<span class="sd">        &gt;&gt;&gt; y.shape = (3, 6)</span>
+<span class="sd">        ...</span>
+<span class="sd">        TypeError: Can not reshape array of size 24 into (3, 6)</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
 
@@ -1486,16 +1551,23 @@ <h1>Source code for dpnp.dpnp_array</h1><div class="highlight"><pre>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Set new lengths of axes.</span>
 
-<span class="sd">        A tuple of numbers represents size of each dimension.</span>
-<span class="sd">        It involves reshaping without copy. If the array cannot be reshaped without copy,</span>
-<span class="sd">        it raises an exception.</span>
+<span class="sd">        Modifies array instance in-place by changing its metadata about the</span>
+<span class="sd">        shape and the strides of the array, or raises `AttributeError`</span>
+<span class="sd">        exception if in-place change is not possible.</span>
 
-<span class="sd">        .. seealso: :attr:`numpy.ndarray.shape`</span>
+<span class="sd">        Whether the array can be reshape in-place depends on its strides. Use</span>
+<span class="sd">        :obj:`dpnp.reshape` function which always succeeds to reshape the array</span>
+<span class="sd">        by performing a copy if necessary.</span>
 
-<span class="sd">        &quot;&quot;&quot;</span>
+<span class="sd">        For full documentation refer to :obj:`numpy.ndarray.shape`.</span>
+
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        newshape : {tuple, int}</span>
+<span class="sd">            New shape. Only non-negative values are supported. The new shape</span>
+<span class="sd">            may not lead to the change in the number of elements in the array.</span>
 
-        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">newshape</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
-            <span class="n">newshape</span> <span class="o">=</span> <span class="p">(</span><span class="n">newshape</span><span class="p">,)</span>
+<span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_array_obj</span><span class="o">.</span><span class="n">shape</span> <span class="o">=</span> <span class="n">newshape</span>
 

pull/1969/_modules/dpnp/dpnp_flatiter.html

@@ -12,7 +12,7 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.16.0dev0+116.g51f10b8338 documentation</title>
+  <title>dpnp.dpnp_flatiter &mdash; Data Parallel Extension for NumPy 0.16.0dev0+123.gd2cb65ba4c documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -23,7 +23,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=046e4312"></script>
+        <script src="../../_static/documentation_options.js?v=95c6a3ab"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
             Data Parallel Extension for NumPy
           </a>
               <div class="version">
-                0.16.0dev0+116.g51f10b8338
+                0.16.0dev0+123.gd2cb65ba4c
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">

pull/1969/_modules/dpnp/dpnp_iface.html

@@ -12,7 +12,7 @@
     </script>
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.16.0dev0+116.g51f10b8338 documentation</title>
+  <title>dpnp.dpnp_iface &mdash; Data Parallel Extension for NumPy 0.16.0dev0+123.gd2cb65ba4c documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -23,7 +23,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=046e4312"></script>
+        <script src="../../_static/documentation_options.js?v=95c6a3ab"></script>
         <script src="../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -43,7 +43,7 @@
             Data Parallel Extension for NumPy
           </a>
               <div class="version">
-                0.16.0dev0+116.g51f10b8338
+                0.16.0dev0+123.gd2cb65ba4c
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">