Docs for pull request 2025

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

pulls/2025/_modules/dpctl/enum_types.html

@@ -790,6 +790,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="dpctl/_sycl_platform.html">dpctl._sycl_platform</a></li>
 <li><a href="dpctl/_sycl_queue.html">dpctl._sycl_queue</a></li>
 <li><a href="dpctl/_sycl_timer.html">dpctl._sycl_timer</a></li>
+<li><a href="dpctl/enum_types.html">dpctl.enum_types</a></li>
 <li><a href="dpctl/memory/_memory.html">dpctl.memory._memory</a></li>
 <li><a href="dpctl/program/_program.html">dpctl.program._program</a></li>
 <li><a href="dpctl/tensor/_array_api.html">dpctl.tensor._array_api</a></li>

pulls/2025/_modules/index.html

@@ -0,0 +1,16 @@
+.. _dpctl_constants:
+
+Constants
+=========
+
+The following constants are defined in :py:mod:`dpctl`:
+
+.. currentmodule:: dpctl
+
+.. autodata:: device_type
+
+.. autodata:: backend_type
+
+.. autodata:: event_status_type
+
+.. autodata:: global_mem_cache_type

pulls/2025/_sources/api_reference/dpctl/constants.rst.txt

@@ -62,6 +62,20 @@
     has_cpu_devices
     has_accelerator_devices
 
+.. rubric:: Enums
+
+.. list-table::
+    :widths: 10 50
+
+    * - :py:class:`dpctl.device_type`
+      - An :class:`enum.Enum` of supported SYCL device types.
+    * - :py:class:`dpctl.backend_type`
+      - An :class:`enum.Enum` of supported SYCL backends.
+    * - :py:class:`dpctl.event_status_type`
+      - An :class:`enum.Enum` of SYCL event states.
+    * - :py:class:`dpctl.global_mem_cache_type`
+      - An :class:`enum.Enum` of global memory cache types for a device.
+
 .. rubric:: Exceptions
 
 .. autosummary::

pulls/2025/_sources/api_reference/dpctl/index.rst.txt

@@ -1,7 +1,7 @@
 .. _dpctl_tensor_constants:
 
 Constants
-========================
+=========
 
 The following constants are defined in :py:mod:`dpctl.tensor`:
 

pulls/2025/_sources/api_reference/dpctl/tensor.constants.rst.txt

@@ -831,7 +831,7 @@ <h1>dpctl.SyclPlatform<a class="headerlink" href="#dpctl-syclplatform" title="Pe
 <table class="autosummary longtable docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.SyclPlatform.get_devices.html#dpctl.SyclPlatform.get_devices" title="dpctl.SyclPlatform.get_devices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_devices</span></code></a>([device_type])</p></td>
-<td><p>Returns the list of <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> objects associated with <a class="reference internal" href="#dpctl.SyclPlatform" title="dpctl.SyclPlatform"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclPlatform</span></code></a> instance selected based on the given <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code>.</p></td>
+<td><p>Returns the list of <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> objects associated with <a class="reference internal" href="#dpctl.SyclPlatform" title="dpctl.SyclPlatform"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclPlatform</span></code></a> instance selected based on the given <a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a>.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/dpctl.SyclPlatform.print_platform_info.html#dpctl.SyclPlatform.print_platform_info" title="dpctl.SyclPlatform.print_platform_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print_platform_info</span></code></a>([verbosity])</p></td>
 <td><p>Print information about the SYCL platform.</p></td>

pulls/2025/api_reference/dpctl/constants.html

@@ -793,27 +793,27 @@ <h1>dpctl.get_devices<a class="headerlink" href="#dpctl-get-devices" title="Perm
 <dt class="sig sig-object py" id="dpctl.get_devices">
 <span class="sig-prename descclassname"><span class="pre">dpctl.</span></span><span class="sig-name descname"><span class="pre">get_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">backend_type.all</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">device_type.all</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.get_devices" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns a list of <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> instances selected based on
-the given <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code> values.</p>
+the given <a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a> and <a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a> values.</p>
 <p>The function is analogous to <code class="docutils literal notranslate"><span class="pre">sycl::devices::get_devices()</span></code>, but with an
 additional functionality that allows filtering SYCL devices based on
 <code class="docutils literal notranslate"><span class="pre">backend</span></code> in addition to only <code class="docutils literal notranslate"><span class="pre">device_type</span></code>.</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>backend</strong> (str, <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code>, optional) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code> enum value or a string that
+<li><p><strong>backend</strong> (str, <a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a>, optional) – A <a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a> enum value or a string that
 specifies a SYCL backend. Currently, accepted values are: “cuda”,
 “hip”, “opencl”, “level_zero”, or “all”.
 Default: <code class="docutils literal notranslate"><span class="pre">dpctl.backend_type.all</span></code>.</p></li>
-<li><p><strong>device_type</strong> (str, <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code>, optional) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> enum value or a string that
+<li><p><strong>device_type</strong> (str, <a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a>, optional) – A <a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a> enum value or a string that
 specifies a SYCL device type. Currently, accepted values are:
 “gpu”, “cpu”, “accelerator”, or “all”.
 Default: <code class="docutils literal notranslate"><span class="pre">dpctl.device_type.all</span></code>.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>A list of available <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> instances that
-satisfy the provided <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code> and
-<code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> values.</p>
+satisfy the provided <a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a> and
+<a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a> values.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a></p>

pulls/2025/api_reference/dpctl/generated/dpctl.SyclPlatform.html

@@ -793,23 +793,23 @@ <h1>dpctl.get_num_devices<a class="headerlink" href="#dpctl-get-num-devices" tit
 <dt class="sig sig-object py" id="dpctl.get_num_devices">
 <span class="sig-prename descclassname"><span class="pre">dpctl.</span></span><span class="sig-name descname"><span class="pre">get_num_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">backend_type.all</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">device_type.all</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.get_num_devices" title="Permalink to this definition">¶</a></dt>
 <dd><p>A helper function to return the number of SYCL devices of a given
-<code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code>.</p>
+<a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a> and <a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a>.</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>backend</strong> (str, <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code>, optional) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code> enum value or a string that
+<li><p><strong>backend</strong> (str, <a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a>, optional) – A <a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a> enum value or a string that
 specifies a SYCL backend. Currently, accepted values are: “cuda”,
 “hip”, “opencl”, “level_zero”, or “all”.
 Default: <code class="docutils literal notranslate"><span class="pre">dpctl.backend_type.all</span></code>.</p></li>
-<li><p><strong>device_type</strong> (str, <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code>, optional) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> enum value or a string that
+<li><p><strong>device_type</strong> (str, <a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a>, optional) – A <a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a> enum value or a string that
 specifies a SYCL device type. Currently, accepted values are:
 “gpu”, “cpu”, “accelerator”, or “all”.
 Default: <code class="docutils literal notranslate"><span class="pre">dpctl.device_type.all</span></code>.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>The number of available SYCL devices that satisfy the provided
-<code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code>
+<a class="reference internal" href="../constants.html#dpctl.backend_type" title="dpctl.backend_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code></a> and <a class="reference internal" href="../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a>
 values.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>

pulls/2025/api_reference/dpctl/generated/dpctl.get_devices.html

@@ -794,10 +794,10 @@ <h1>dpctl.SyclPlatform.get_devices<a class="headerlink" href="#dpctl-syclplatfor
 <span class="sig-prename descclassname"><span class="pre">SyclPlatform.</span></span><span class="sig-name descname"><span class="pre">get_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">device_type.all</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclPlatform.get_devices" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the list of <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> objects associated with
 <a class="reference internal" href="../dpctl.SyclPlatform.html#dpctl.SyclPlatform" title="dpctl.SyclPlatform"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclPlatform</span></code></a> instance selected based on
-the given <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code>.</p>
+the given <a class="reference internal" href="../../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>device_type</strong> (str, <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code>, optional) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> enum value or a string that
+<dd class="field-odd"><p><strong>device_type</strong> (str, <a class="reference internal" href="../../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a>, optional) – A <a class="reference internal" href="../../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a> enum value or a string that
 specifies a SYCL device type. Currently, accepted values are:
 “gpu”, “cpu”, “accelerator”, or “all”, and their equivalent
 <code class="docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> enumerators.
@@ -812,7 +812,7 @@ <h1>dpctl.SyclPlatform.get_devices<a class="headerlink" href="#dpctl-syclplatfor
 </dd>
 <dt class="field-even">Raises<span class="colon">:</span></dt>
 <dd class="field-even"><ul class="simple">
-<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 <cite>device_type</cite> is not a string or <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code>
+<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 <cite>device_type</cite> is not a string or <a class="reference internal" href="../../constants.html#dpctl.device_type" title="dpctl.device_type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code></a>
     enum.</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 <code class="docutils literal notranslate"><span class="pre">DPCTLPlatform_GetDevices</span></code> call returned
     <code class="docutils literal notranslate"><span class="pre">NULL</span></code> instead of a <code class="docutils literal notranslate"><span class="pre">DPCTLDeviceVectorRef</span></code> object.</p></li>