Docs for pull request 1953

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

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

@@ -855,8 +855,8 @@ <h1>dpctl.SyclDevice<a class="headerlink" href="#dpctl-sycldevice" title="Permal
 <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>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.SyclDevice.get_unpartitioned_parent_device.html#dpctl.SyclDevice.get_unpartitioned_parent_device" title="dpctl.SyclDevice.get_unpartitioned_parent_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_unpartitioned_parent_device</span></code></a>(self)</p></td>
-<td><p>Returns the unpartitioned parent device of this device, or None for a root device.</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.SyclDevice.get_unpartitioned_parent_device.html#dpctl.SyclDevice.get_unpartitioned_parent_device" title="dpctl.SyclDevice.get_unpartitioned_parent_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_unpartitioned_parent_device</span></code></a>()</p></td>
+<td><p>Returns the unpartitioned parent device of this device.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/dpctl.SyclDevice.print_device_info.html#dpctl.SyclDevice.print_device_info" title="dpctl.SyclDevice.print_device_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print_device_info</span></code></a>()</p></td>
 <td><p>Print information about the SYCL device.</p></td>

pulls/1953/api_reference/dpctl/generated/dpctl.tensor.usm_ndarray.html

@@ -867,7 +867,7 @@ <h1>dpctl.tensor.usm_ndarray<a class="headerlink" href="#dpctl-tensor-usm-ndarra
 <div class="table-wrapper autosummary longtable docutils container">
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.tensor.usm_ndarray.to_device.html#dpctl.tensor.usm_ndarray.to_device" title="dpctl.tensor.usm_ndarray.to_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_device</span></code></a>(target_device)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.tensor.usm_ndarray.to_device.html#dpctl.tensor.usm_ndarray.to_device" title="dpctl.tensor.usm_ndarray.to_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_device</span></code></a>(target_device, /, *[, stream])</p></td>
 <td><p>Transfers this array to specified target device.</p></td>
 </tr>
 </tbody>

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

@@ -798,7 +798,7 @@ <h1>dpctl.SyclDevice.get_device_id<a class="headerlink" href="#dpctl-sycldevice-
 <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 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 could not be found.</p>
 </dd>
 <dt class="field-even">Example<span class="colon">:</span></dt>
 <dd class="field-even"><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">dpctl</span>

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

@@ -787,13 +787,14 @@
 <h1>dpctl.SyclDevice.get_unpartitioned_parent_device<a class="headerlink" href="#dpctl-sycldevice-get-unpartitioned-parent-device" title="Permalink to this heading">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="dpctl.SyclDevice.get_unpartitioned_parent_device">
-<span class="sig-prename descclassname"><span class="pre">SyclDevice.</span></span><span class="sig-name descname"><span class="pre">get_unpartitioned_parent_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclDevice.get_unpartitioned_parent_device" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the unpartitioned parent device of this device, or None for a
-root device.</p>
+<span class="sig-prename descclassname"><span class="pre">SyclDevice.</span></span><span class="sig-name descname"><span class="pre">get_unpartitioned_parent_device</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclDevice.get_unpartitioned_parent_device" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the unpartitioned parent device of this device.</p>
+<p>If this device is already an unpartitioned, root device,
+the same device is returned.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>A parent, unpartitioned <a class="reference internal" href="../dpctl.SyclDevice.html#dpctl.SyclDevice" title="dpctl.SyclDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclDevice</span></code></a> instance if
-the device is a sub-device, <code class="docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
+<dd class="field-odd"><p>A parent, unpartitioned <a class="reference internal" href="../dpctl.SyclDevice.html#dpctl.SyclDevice" title="dpctl.SyclDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclDevice</span></code></a> instance, or
+<code class="docutils literal notranslate"><span class="pre">self</span></code> if already a root device.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference internal" href="../dpctl.SyclDevice.html#dpctl.SyclDevice" title="dpctl.SyclDevice">dpctl.SyclDevice</a></p>

pulls/1953/api_reference/dpctl/generated/generated/dpctl.tensor.usm_ndarray.to_device.html

@@ -787,7 +787,7 @@
 <h1>dpctl.tensor.usm_ndarray.to_device<a class="headerlink" href="#dpctl-tensor-usm-ndarray-to-device" title="Permalink to this heading">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="dpctl.tensor.usm_ndarray.to_device">
-<span class="sig-prename descclassname"><span class="pre">usm_ndarray.</span></span><span class="sig-name descname"><span class="pre">to_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_device</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.tensor.usm_ndarray.to_device" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">usm_ndarray.</span></span><span class="sig-name descname"><span class="pre">to_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_device</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.tensor.usm_ndarray.to_device" title="Permalink to this definition">¶</a></dt>
 <dd><p>Transfers this array to specified target device.</p>
 <dl class="field-list">
 <dt class="field-odd">Example<span class="colon">:</span></dt>