Docs for pull request 2273

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

pulls/2273/api_reference/dpctl/generated/dpctl.SyclQueue.html

@@ -741,10 +741,10 @@ <h1>dpctl.SyclQueue<a class="headerlink" href="#dpctl-syclqueue" title="Permalin
 <td><p>Returns the address of the C API <code class="docutils literal notranslate"><span class="pre">DPCTLSyclQueueRef</span></code> pointer as integral value of type <code class="docutils literal notranslate"><span class="pre">size_t</span></code>.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/dpctl.SyclQueue.copy.html#dpctl.SyclQueue.copy" title="dpctl.SyclQueue.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>(dest, src, count[, dtype])</p></td>
-<td><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> bytes from <code class="docutils literal notranslate"><span class="pre">src</span></code> to <code class="docutils literal notranslate"><span class="pre">dest</span></code> and wait.</p></td>
+<td><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> elements of type <code class="docutils literal notranslate"><span class="pre">dtype</span></code> from <code class="docutils literal notranslate"><span class="pre">src</span></code> to <code class="docutils literal notranslate"><span class="pre">dest</span></code> and wait.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.SyclQueue.copy_async.html#dpctl.SyclQueue.copy_async" title="dpctl.SyclQueue.copy_async"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy_async</span></code></a>(dest, src, count[, dEvents, dtype])</p></td>
-<td><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> bytes from <code class="docutils literal notranslate"><span class="pre">src</span></code> to <code class="docutils literal notranslate"><span class="pre">dest</span></code> asynchronously.</p></td>
+<td><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> elements of type <code class="docutils literal notranslate"><span class="pre">dtype</span></code> from <code class="docutils literal notranslate"><span class="pre">src</span></code> to <code class="docutils literal notranslate"><span class="pre">dest</span></code> asynchronously.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/dpctl.SyclQueue.get_sycl_context.html#dpctl.SyclQueue.get_sycl_context" title="dpctl.SyclQueue.get_sycl_context"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_sycl_context</span></code></a>()</p></td>
 <td><p></p></td>

pulls/2273/api_reference/dpctl/generated/generated/dpctl.SyclQueue.copy.html

@@ -623,10 +623,13 @@
 <h1>dpctl.SyclQueue.copy<a class="headerlink" href="#dpctl-syclqueue-copy" title="Permalink to this heading">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="dpctl.SyclQueue.copy">
-<span class="sig-prename descclassname"><span class="pre">SyclQueue.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</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.SyclQueue.copy" title="Permalink to this definition">¶</a></dt>
-<dd><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> bytes from <code class="docutils literal notranslate"><span class="pre">src</span></code> to <code class="docutils literal notranslate"><span class="pre">dest</span></code> and wait.</p>
-<p>Internally, this dispatches <code class="docutils literal notranslate"><span class="pre">sycl::queue::copy</span></code> instantiated for
-byte-sized elements (or typed elements if dtype is specified).</p>
+<span class="sig-prename descclassname"><span class="pre">SyclQueue.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'u1'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclQueue.copy" title="Permalink to this definition">¶</a></dt>
+<dd><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> elements of type <code class="docutils literal notranslate"><span class="pre">dtype</span></code> from <code class="docutils literal notranslate"><span class="pre">src</span></code> to
+<code class="docutils literal notranslate"><span class="pre">dest</span></code> and wait.</p>
+<p>Internally, this dispatches <code class="docutils literal notranslate"><span class="pre">sycl::queue::copy</span></code>. The number of
+bytes transferred is <code class="docutils literal notranslate"><span class="pre">count</span></code> multiplied by the size of <code class="docutils literal notranslate"><span class="pre">dtype</span></code>.
+The default <code class="docutils literal notranslate"><span class="pre">dtype</span></code> of <code class="docutils literal notranslate"><span class="pre">&quot;u1&quot;</span></code> (a single byte) makes the default
+a byte-wise copy.</p>
 <p>This is a synchronizing variant corresponding to
 <a class="reference internal" href="dpctl.SyclQueue.copy_async.html#dpctl.SyclQueue.copy_async" title="dpctl.SyclQueue.copy_async"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dpctl.SyclQueue.copy_async()</span></code></a>.</p>
 <dl class="field-list simple">
@@ -636,10 +639,11 @@ <h1>dpctl.SyclQueue.copy<a class="headerlink" href="#dpctl-syclqueue-copy" title
 writable buffer protocol.</p></li>
 <li><p><strong>src</strong> – Source USM object or Python object supporting buffer
 protocol.</p></li>
-<li><p><strong>count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Number of bytes to copy.</p></li>
-<li><p><strong>dtype</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><em>optional</em>) – Data type string (e.g., ‘i4’, ‘f8’) for typed copy
-validation. If provided, validates that count is a
-multiple of the element size.</p></li>
+<li><p><strong>count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Number of elements to copy.</p></li>
+<li><p><strong>dtype</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><em>optional</em>) – Data type string of the elements to copy. Determines the
+element size used to convert <code class="docutils literal notranslate"><span class="pre">count</span></code> into a byte count.
+Defaults to <code class="docutils literal notranslate"><span class="pre">&quot;u1&quot;</span></code> (one byte per element).
+Supported types: i1, u1, i2, u2, i4, u4, i8, u8, f4, f8.</p></li>
 </ul>
 </dd>
 </dl>

pulls/2273/api_reference/dpctl/generated/generated/dpctl.SyclQueue.copy_async.html

@@ -623,22 +623,25 @@
 <h1>dpctl.SyclQueue.copy_async<a class="headerlink" href="#dpctl-syclqueue-copy-async" title="Permalink to this heading">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="dpctl.SyclQueue.copy_async">
-<span class="sig-prename descclassname"><span class="pre">SyclQueue.</span></span><span class="sig-name descname"><span class="pre">copy_async</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dEvents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</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.SyclQueue.copy_async" title="Permalink to this definition">¶</a></dt>
-<dd><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> bytes from <code class="docutils literal notranslate"><span class="pre">src</span></code> to <code class="docutils literal notranslate"><span class="pre">dest</span></code> asynchronously.</p>
-<p>Internally, this dispatches <code class="docutils literal notranslate"><span class="pre">sycl::queue::copy</span></code> instantiated for
-byte-sized elements (or typed elements if dtype is specified).</p>
+<span class="sig-prename descclassname"><span class="pre">SyclQueue.</span></span><span class="sig-name descname"><span class="pre">copy_async</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dEvents</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'u1'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclQueue.copy_async" title="Permalink to this definition">¶</a></dt>
+<dd><p>Copy <code class="docutils literal notranslate"><span class="pre">count</span></code> elements of type <code class="docutils literal notranslate"><span class="pre">dtype</span></code> from <code class="docutils literal notranslate"><span class="pre">src</span></code> to
+<code class="docutils literal notranslate"><span class="pre">dest</span></code> asynchronously.</p>
+<p>Internally, this dispatches <code class="docutils literal notranslate"><span class="pre">sycl::queue::copy</span></code>. The number of
+bytes transferred is <code class="docutils literal notranslate"><span class="pre">count</span></code> multiplied by the size of <code class="docutils literal notranslate"><span class="pre">dtype</span></code>.
+The default <code class="docutils literal notranslate"><span class="pre">dtype</span></code> of <code class="docutils literal notranslate"><span class="pre">&quot;u1&quot;</span></code> (a single byte) makes the default
+a byte-wise copy.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>dest</strong> – Destination USM object or Python object supporting
 writable buffer protocol.</p></li>
 <li><p><strong>src</strong> – Source USM object or Python object supporting buffer
 protocol.</p></li>
-<li><p><strong>count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Number of bytes to copy.</p></li>
+<li><p><strong>count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Number of elements to copy.</p></li>
 <li><p><strong>dEvents</strong> (<em>List</em><em>[</em><a class="reference internal" href="../dpctl.SyclEvent.html#dpctl.SyclEvent" title="dpctl.SyclEvent"><em>dpctl.SyclEvent</em></a><em>]</em><em>, </em><em>optional</em>) – Events that this copy depends on.</p></li>
-<li><p><strong>dtype</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><em>optional</em>) – Data type string (e.g., ‘i4’, ‘f8’) for typed copy
-validation. If provided, validates that count is a
-multiple of the element size.
+<li><p><strong>dtype</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><em>optional</em>) – Data type string of the elements to copy. Determines the
+element size used to convert <code class="docutils literal notranslate"><span class="pre">count</span></code> into a byte count.
+Defaults to <code class="docutils literal notranslate"><span class="pre">&quot;u1&quot;</span></code> (one byte per element).
 Supported types: i1, u1, i2, u2, i4, u4, i8, u8, f4, f8.</p></li>
 </ul>
 </dd>

pulls/2273/beginners_guides/installation.html

@@ -689,7 +689,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.21.0dev0+54.gaf51b25ae4b)"><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.21.0dev0+65.gffccc2ee6d7)"><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>