Docs for pull request 2317

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

pulls/2317/_modules/dpctl/compiler/utils/_utils.html

@@ -702,6 +702,7 @@ <h1>All modules for which code is available</h1>
 <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/compiler/_compiler.html">dpctl.compiler._compiler</a></li>
+<li><a href="dpctl/compiler/utils/_utils.html">dpctl.compiler.utils._utils</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>

pulls/2317/_modules/index.html

@@ -39,12 +39,12 @@ execution via :py:meth:`dpctl.SyclQueue.submit`.
 
     SyclKernelBundleCompilationError
 
-:py:mod:`dpctl.program.utils`
+:py:mod:`dpctl.compiler.utils`
 -----------------------------
 
-.. py:module:: dpctl.program.utils
+.. py:module:: dpctl.compiler.utils
 
-.. currentmodule:: dpctl.program.utils
+.. currentmodule:: dpctl.compiler.utils
 
 .. autofunction:: parse_spirv_specializations
 

pulls/2317/_sources/api_reference/dpctl/compiler.rst.txt

@@ -749,8 +749,62 @@
 </tbody>
 </table>
 </div>
-<section id="module-dpctl.program.utils">
-<span id="dpctl-program-utils"></span><h2><a class="reference internal" href="#module-dpctl.program.utils" title="dpctl.program.utils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl.program.utils</span></code></a><a class="headerlink" href="#module-dpctl.program.utils" title="Permalink to this heading">¶</a></h2>
+<section id="dpctl-compiler-utils">
+<h2><a class="reference internal" href="#module-dpctl.compiler.utils" title="dpctl.compiler.utils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl.compiler.utils</span></code></a><a class="headerlink" href="#dpctl-compiler-utils" title="Permalink to this heading">¶</a></h2>
+<span class="target" id="module-dpctl.compiler.utils"></span><dl class="py function">
+<dt class="sig sig-object py" id="dpctl.compiler.utils.parse_spirv_specializations">
+<span class="sig-prename descclassname"><span class="pre">dpctl.compiler.utils.</span></span><span class="sig-name descname"><span class="pre">parse_spirv_specializations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spv_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><span class="pre">bytes</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.14)"><span class="pre">bytearray</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.14)"><span class="pre">memoryview</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#dpctl.compiler.utils.SpecializationConstantInfo" title="dpctl.compiler.utils._utils.SpecializationConstantInfo"><span class="pre">dpctl.compiler.utils._utils.SpecializationConstantInfo</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/dpctl/compiler/utils/_utils.html#parse_spirv_specializations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dpctl.compiler.utils.parse_spirv_specializations" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parses SPIR-V byte stream to extract information about specializations,
+including the specialization IDs, types, names, and default values.</p>
+<p>Note that the dtype information may be imprecise, as the compiler may
+choose to, for example, represent a bool as char, or may represent both
+signed and unsigned integers as unsigned integer bit buckets of the same
+length.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>spv_bytes</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.14)"><em>bytes</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.14)"><em>bytearray</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#memoryview" title="(in Python v3.14)"><em>memoryview</em></a>) – the SPIR-V byte stream.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><p>a tuple of parsed constants and their information represented by
+<cite>SpecializationConstantInfo</cite> objects, sorted by their
+specialization IDs. The length of the tuple is equal to the number
+of specialization constants found. Each
+<cite>SpecializationConstantInfo</cite> object contains the following
+attributes:</p>
+<ul class="simple">
+<li><p><cite>spec_id</cite> (int): The specialization ID.</p></li>
+<li><p><cite>dtype</cite> (str): A NumPy style string representing the data type.</p></li>
+<li><dl class="simple">
+<dt><cite>itemsize</cite> (int): The size of the specialization constant in</dt><dd><p>bytes.</p>
+</dd>
+</dl>
+</li>
+<li><dl class="simple">
+<dt><cite>name</cite> (str): The variable name. If not preserved in the binary,</dt><dd><p>a default name in the format <cite>unnamed_spec_const_{spec_id}</cite> is
+used.</p>
+</dd>
+</dl>
+</li>
+<li><dl class="simple">
+<dt><cite>default_value</cite> (int | float | bool | None): The default value of</dt><dd><p>the specialization constant. If not specified, <cite>None</cite> is used.</p>
+</dd>
+</dl>
+</li>
+</ul>
+</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#tuple" title="(in Python v3.14)">tuple</a>[<a class="reference internal" href="#dpctl.compiler.utils.SpecializationConstantInfo" title="dpctl.compiler.utils.SpecializationConstantInfo">SpecializationConstantInfo</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="dpctl.compiler.utils.SpecializationConstantInfo">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dpctl.compiler.utils.</span></span><span class="sig-name descname"><span class="pre">SpecializationConstantInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">itemsize</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/dpctl/compiler/utils/_utils.html#SpecializationConstantInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dpctl.compiler.utils.SpecializationConstantInfo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Data class representing specialization constant information.</p>
+</dd></dl>
+
 </section>
 </section>
 
@@ -810,7 +864,11 @@
           <div class="toc-tree">
             <ul>
 <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl.compiler</span></code></a><ul>
-<li><a class="reference internal" href="#module-dpctl.program.utils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl.program.utils</span></code></a></li>
+<li><a class="reference internal" href="#dpctl-compiler-utils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl.compiler.utils</span></code></a><ul>
+<li><a class="reference internal" href="#dpctl.compiler.utils.parse_spirv_specializations"><code class="docutils literal notranslate"><span class="pre">parse_spirv_specializations()</span></code></a></li>
+<li><a class="reference internal" href="#dpctl.compiler.utils.SpecializationConstantInfo"><code class="docutils literal notranslate"><span class="pre">SpecializationConstantInfo</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>

pulls/2317/api_reference/dpctl/compiler.html

@@ -931,24 +931,24 @@ <h2>D</h2>
 </li>
         </ul></li>
         <li>
-    dpctl.memory
+    dpctl.compiler.utils
 
         <ul>
-          <li><a href="api_reference/dpctl/memory.html#module-dpctl.memory">module</a>
+          <li><a href="api_reference/dpctl/compiler.html#module-dpctl.compiler.utils">module</a>
 </li>
         </ul></li>
         <li>
-    dpctl.program
+    dpctl.memory
 
         <ul>
-          <li><a href="api_reference/dpctl/program.html#module-dpctl.program">module</a>
+          <li><a href="api_reference/dpctl/memory.html#module-dpctl.memory">module</a>
 </li>
         </ul></li>
         <li>
-    dpctl.program.utils
+    dpctl.program
 
         <ul>
-          <li><a href="api_reference/dpctl/compiler.html#module-dpctl.program.utils">module</a>
+          <li><a href="api_reference/dpctl/program.html#module-dpctl.program">module</a>
 </li>
         </ul></li>
         <li>
@@ -1845,12 +1845,12 @@ <h2>M</h2>
           <li><a href="api_reference/dpctl/index.html#module-dpctl">dpctl</a>
 </li>
           <li><a href="api_reference/dpctl/compiler.html#module-dpctl.compiler">dpctl.compiler</a>
+</li>
+          <li><a href="api_reference/dpctl/compiler.html#module-dpctl.compiler.utils">dpctl.compiler.utils</a>
 </li>
           <li><a href="api_reference/dpctl/memory.html#module-dpctl.memory">dpctl.memory</a>
 </li>
           <li><a href="api_reference/dpctl/program.html#module-dpctl.program">dpctl.program</a>
-</li>
-          <li><a href="api_reference/dpctl/compiler.html#module-dpctl.program.utils">dpctl.program.utils</a>
 </li>
           <li><a href="api_reference/dpctl/utils.html#module-dpctl.utils">dpctl.utils</a>
 </li>
@@ -1938,6 +1938,8 @@ <h2>P</h2>
 </li>
         </ul></li>
         <li><a href="api_reference/dpctl/generated/generated/dpctl.SyclDevice.parent_device.html#dpctl.SyclDevice.parent_device">parent_device (dpctl.SyclDevice attribute)</a>
+</li>
+        <li><a href="api_reference/dpctl/compiler.html#dpctl.compiler.utils.parse_spirv_specializations">parse_spirv_specializations() (in module dpctl.compiler.utils)</a>
 </li>
         <li><a href="api_reference/dpctl/generated/generated/dpctl.SyclDevice.partition_affinity_domains.html#dpctl.SyclDevice.partition_affinity_domains">partition_affinity_domains (dpctl.SyclDevice attribute)</a>
 </li>
@@ -1974,14 +1976,14 @@ <h2>P</h2>
 </li>
         <li><a href="api_reference/dpctl/generated/generated/dpctl.SyclQueue.prefetch.html#dpctl.SyclQueue.prefetch">prefetch() (dpctl.SyclQueue method)</a>
 </li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api_reference/dpctl/generated/generated/dpctl.SyclDevice.print_device_info.html#dpctl.SyclDevice.print_device_info">print_device_info() (dpctl.SyclDevice method)</a>
 
         <ul>
           <li><a href="api_reference/dpctl/generated/generated/dpctl.SyclQueue.print_device_info.html#dpctl.SyclQueue.print_device_info">(dpctl.SyclQueue method)</a>
 </li>
         </ul></li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api_reference/dpctl/generated/generated/dpctl.SyclPlatform.print_platform_info.html#dpctl.SyclPlatform.print_platform_info">print_platform_info() (dpctl.SyclPlatform method)</a>
 </li>
         <li><a href="api_reference/dpctl/generated/generated/dpctl.SyclEvent.profiling_info_end.html#dpctl.SyclEvent.profiling_info_end">profiling_info_end (dpctl.SyclEvent attribute)</a>
@@ -2078,6 +2080,8 @@ <h2>S</h2>
 </li>
         </ul></li>
         <li><a href="api_reference/dpctl/generated/dpctl.compiler.SpecializationConstant.html#dpctl.compiler.SpecializationConstant">SpecializationConstant (class in dpctl.compiler)</a>
+</li>
+        <li><a href="api_reference/dpctl/compiler.html#dpctl.compiler.utils.SpecializationConstantInfo">SpecializationConstantInfo (class in dpctl.compiler.utils)</a>
 </li>
         <li>
     struct

pulls/2317/genindex.html

@@ -718,19 +718,19 @@ <h1>Python Module Index</h1>
   <tr class="cg-1">
     <td></td>
     <td>&#160;&#160;&#160;
-        <a href="api_reference/dpctl/memory.html#module-dpctl.memory"><code class="xref">dpctl.memory</code></a></td><td>
+        <a href="api_reference/dpctl/compiler.html#module-dpctl.compiler.utils"><code class="xref">dpctl.compiler.utils</code></a></td><td>
     <em></em></td>
   </tr>
   <tr class="cg-1">
     <td></td>
     <td>&#160;&#160;&#160;
-        <a href="api_reference/dpctl/program.html#module-dpctl.program"><code class="xref">dpctl.program</code></a></td><td>
+        <a href="api_reference/dpctl/memory.html#module-dpctl.memory"><code class="xref">dpctl.memory</code></a></td><td>
     <em></em></td>
   </tr>
   <tr class="cg-1">
     <td></td>
     <td>&#160;&#160;&#160;
-        <a href="api_reference/dpctl/compiler.html#module-dpctl.program.utils"><code class="xref">dpctl.program.utils</code></a></td><td>
+        <a href="api_reference/dpctl/program.html#module-dpctl.program"><code class="xref">dpctl.program</code></a></td><td>
     <em></em></td>
   </tr>
   <tr class="cg-1">