Docs for pull request 1953

Author: github-actions[doc-deploy-bot]

pulls/1953/_modules/dpctl/tensor/_ctors.html

@@ -839,6 +839,10 @@ <h1>Source code for dpctl.tensor._ctors</h1><div class="highlight"><pre>
     <span class="k">if</span> <span class="n">_is_object_with_buffer_protocol</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
         <span class="n">np_obj</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">np_obj</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">np_obj</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="n">_host_set</span>
+    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">):</span>
+        <span class="n">usm_ar</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">usm_ar</span><span class="p">,</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">):</span>
+            <span class="k">return</span> <span class="n">usm_ar</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">usm_ar</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">usm_ar</span><span class="o">.</span><span class="n">sycl_queue</span><span class="p">])</span>
     <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s2">&quot;__sycl_usm_array_interface__&quot;</span><span class="p">):</span>
         <span class="n">usm_ar</span> <span class="o">=</span> <span class="n">_usm_ndarray_from_suai</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">usm_ar</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">usm_ar</span><span class="o">.</span><span class="n">dtype</span><span class="p">,</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">usm_ar</span><span class="o">.</span><span class="n">sycl_queue</span><span class="p">])</span>
@@ -1084,6 +1088,11 @@ <h1>Source code for dpctl.tensor._ctors</h1><div class="highlight"><pre>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">):</span>
         <span class="n">usm_types_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">o</span><span class="o">.</span><span class="n">usm_type</span><span class="p">)</span>
         <span class="k">return</span>
+    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">):</span>
+        <span class="n">usm_arr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">usm_arr</span><span class="p">,</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">):</span>
+            <span class="n">usm_types_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">usm_arr</span><span class="o">.</span><span class="n">usm_type</span><span class="p">)</span>
+            <span class="k">return</span>
     <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="s2">&quot;__sycl_usm_array_interface__&quot;</span><span class="p">):</span>
         <span class="n">usm_ar</span> <span class="o">=</span> <span class="n">_usm_ndarray_from_suai</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
         <span class="n">usm_types_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">usm_ar</span><span class="o">.</span><span class="n">usm_type</span><span class="p">)</span>
@@ -1108,6 +1117,11 @@ <h1>Source code for dpctl.tensor._ctors</h1><div class="highlight"><pre>
         <span class="p">)</span>
         <span class="n">_manager</span><span class="o">.</span><span class="n">add_event_pair</span><span class="p">(</span><span class="n">ht_ev</span><span class="p">,</span> <span class="n">cpy_ev</span><span class="p">)</span>
         <span class="k">return</span>
+    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">seq_o</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">):</span>
+        <span class="n">usm_arr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">seq_o</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">usm_arr</span><span class="p">,</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">):</span>
+            <span class="n">_device_copy_walker</span><span class="p">(</span><span class="n">usm_arr</span><span class="p">,</span> <span class="n">res</span><span class="p">,</span> <span class="n">_manager</span><span class="p">)</span>
+            <span class="k">return</span>
     <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">seq_o</span><span class="p">,</span> <span class="s2">&quot;__sycl_usm_array_interface__&quot;</span><span class="p">):</span>
         <span class="n">usm_ar</span> <span class="o">=</span> <span class="n">_usm_ndarray_from_suai</span><span class="p">(</span><span class="n">seq_o</span><span class="p">)</span>
         <span class="n">exec_q</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">sycl_queue</span>
@@ -1139,6 +1153,11 @@ <h1>Source code for dpctl.tensor._ctors</h1><div class="highlight"><pre>
             <span class="k">return</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="n">usm_res</span><span class="p">[</span><span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="n">seq_o</span>
+    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">seq_o</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">):</span>
+        <span class="n">usm_arr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">seq_o</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">usm_arr</span><span class="p">,</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">):</span>
+            <span class="n">_copy_through_host_walker</span><span class="p">(</span><span class="n">usm_arr</span><span class="p">,</span> <span class="n">usm_res</span><span class="p">)</span>
+            <span class="k">return</span>
     <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">seq_o</span><span class="p">,</span> <span class="s2">&quot;__sycl_usm_array_interface__&quot;</span><span class="p">):</span>
         <span class="n">usm_ar</span> <span class="o">=</span> <span class="n">_usm_ndarray_from_suai</span><span class="p">(</span><span class="n">seq_o</span><span class="p">)</span>
         <span class="k">if</span> <span class="p">(</span>
@@ -1342,6 +1361,17 @@ <h1>Source code for dpctl.tensor._ctors</h1><div class="highlight"><pre>
             <span class="n">sycl_queue</span><span class="o">=</span><span class="n">sycl_queue</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="p">)</span>
+    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">):</span>
+        <span class="n">usm_arr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s2">&quot;__usm_ndarray__&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">usm_arr</span><span class="p">,</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">):</span>
+            <span class="k">return</span> <span class="n">_asarray_from_usm_ndarray</span><span class="p">(</span>
+                <span class="n">usm_arr</span><span class="p">,</span>
+                <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">,</span>
+                <span class="n">copy</span><span class="o">=</span><span class="n">copy</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="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">,</span>
+            <span class="p">)</span>
     <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s2">&quot;__sycl_usm_array_interface__&quot;</span><span class="p">):</span>
         <span class="n">ary</span> <span class="o">=</span> <span class="n">_usm_ndarray_from_suai</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">_asarray_from_usm_ndarray</span><span class="p">(</span>

pulls/1953/api_reference/dpctl/generated/dpctl.SyclDevice.html

@@ -825,17 +825,16 @@ <h1>dpctl.SyclDevice<a class="headerlink" href="#dpctl-sycldevice" title="Permal
 </div>
 </dd>
 <dt class="field-even">Parameters<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>arg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>optional</em>) – The argument can be a selector string or <code class="docutils literal notranslate"><span class="pre">None</span></code>.
+<dd class="field-even"><p><strong>arg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>optional</em>) – The argument can be a selector string, another
+<a class="reference internal" href="#dpctl.SyclDevice" title="dpctl.SyclDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclDevice</span></code></a>, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.
 Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
 </dd>
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#MemoryError" title="(in Python v3.13)"><strong>MemoryError</strong></a> – If the constructor could not allocate necessary
     temporary memory.</p></li>
 <li><p><a class="reference internal" href="dpctl.SyclDeviceCreationError.html#dpctl.SyclDeviceCreationError" title="dpctl.SyclDeviceCreationError"><strong>SyclDeviceCreationError</strong></a> – If the <a class="reference internal" href="#dpctl.SyclDevice" title="dpctl.SyclDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclDevice</span></code></a> object creation failed.</p></li>
-<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – If the list of <a class="reference internal" href="#dpctl.SyclDevice" title="dpctl.SyclDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclDevice</span></code></a> objects was empty,
-    or the input capsule contained a null pointer or could not
-    be renamed.</p></li>
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.13)"><strong>TypeError</strong></a> – If the argument is not a <a class="reference internal" href="#dpctl.SyclDevice" title="dpctl.SyclDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclDevice</span></code></a> or string.</p></li>
 </ul>
 </dd>
 </dl>
@@ -850,7 +849,7 @@ <h1>dpctl.SyclDevice<a class="headerlink" href="#dpctl-sycldevice" title="Permal
 <td><p>Creates a list of sub-devices by partitioning a root device based on the provided partition specifier.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.SyclDevice.get_device_id.html#dpctl.SyclDevice.get_device_id" title="dpctl.SyclDevice.get_device_id"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_device_id</span></code></a>()</p></td>
-<td><p>For a parent device, returns the canonical index of this device in the list of devices visible to dpctl.</p></td>
+<td><p>For an unpartitioned device, returns the canonical index of this device in the list of devices visible to dpctl.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/dpctl.SyclDevice.get_filter_string.html#dpctl.SyclDevice.get_filter_string" title="dpctl.SyclDevice.get_filter_string"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_filter_string</span></code></a>([include_backend, ...])</p></td>
 <td><p>For a parent device, returns a filter selector string that includes backend or device type based on the value of the given keyword arguments.</p></td>

pulls/1953/api_reference/dpctl/generated/generated/dpctl.SyclDevice.get_device_id.html

@@ -787,11 +787,15 @@ <h1>dpctl.SyclDevice.get_device_id<a class="headerlink" href="#dpctl-sycldevice-
 <dl class="py method">
 <dt class="sig sig-object py" id="dpctl.SyclDevice.get_device_id">
 <span class="sig-prename descclassname"><span class="pre">SyclDevice.</span></span><span class="sig-name descname"><span class="pre">get_device_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclDevice.get_device_id" title="Permalink to this definition">¶</a></dt>
-<dd><p>For a parent device, returns the canonical index of this device in the
-list of devices visible to dpctl.
-:returns:     The index of the device.
-:rtype: int</p>
+<dd><p>For an unpartitioned device, returns the canonical index of this device
+in the list of devices visible to dpctl.</p>
 <dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The index of the device.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a></p>
+</dd>
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – If the device is a sub-device.</p>
 </dd>

pulls/1953/beginners_guides/installation.html

@@ -847,7 +847,7 @@ <h2>Installation using pip<a class="headerlink" href="#installation-using-pip" t
 <section id="installation-via-intel-r-distribution-for-python">
 <h2>Installation via Intel(R) Distribution for Python<a class="headerlink" href="#installation-via-intel-r-distribution-for-python" title="Permalink to this heading">¶</a></h2>
 <p><a class="reference external" href="https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html">Intel(R) Distribution for Python*</a> is distributed as a conda-based installer
-and includes <a class="reference internal" href="../api_reference/dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> along with its dependencies and sister projects <a class="reference external" href="https://intelpython.github.io/dpnp/overview.html#module-dpnp" title="(in Data Parallel Extension for NumPy v0.17.0dev4+1.g44bb0680455)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
+and includes <a class="reference internal" href="../api_reference/dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> along with its dependencies and sister projects <a class="reference external" href="https://intelpython.github.io/dpnp/overview.html#module-dpnp" title="(in Data Parallel Extension for NumPy v0.17.0dev4+3.g498e705d848)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
 and <a class="reference external" href="https://intelpython.github.io/numba-dpex/latest/index.html#module-numba_dpex" title="(in numba-dpex)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">numba_dpex</span></code></a>.</p>
 <p>Once the installed environment is activated, <code class="docutils literal notranslate"><span class="pre">dpctl</span></code> should be ready to use.</p>
 </section>