Docs for pull request 2317

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

pulls/2317/_modules/dpctl.html

@@ -282,6 +282,7 @@
 <li class="toctree-l3 has-children"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.SyclDevice.html">dpctl.SyclDevice</a><input aria-label="Toggle navigation of dpctl.SyclDevice" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclDevice.addressof_ref.html">dpctl.SyclDevice.addressof_ref</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclDevice.can_access_peer.html">dpctl.SyclDevice.can_access_peer</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclDevice.can_compile.html">dpctl.SyclDevice.can_compile</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclDevice.component_devices.html">dpctl.SyclDevice.component_devices</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclDevice.create_sub_devices.html">dpctl.SyclDevice.create_sub_devices</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclDevice.disable_peer_access.html">dpctl.SyclDevice.disable_peer_access</a></li>
@@ -391,7 +392,12 @@
 <li class="toctree-l3 has-children"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.SyclContext.html">dpctl.SyclContext</a><input aria-label="Toggle navigation of dpctl.SyclContext" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.addressof_ref.html">dpctl.SyclContext.addressof_ref</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.get_devices.html">dpctl.SyclContext.get_devices</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.atomic_fence_order_capabilities.html">dpctl.SyclContext.atomic_fence_order_capabilities</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.atomic_fence_scope_capabilities.html">dpctl.SyclContext.atomic_fence_scope_capabilities</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.atomic_memory_order_capabilities.html">dpctl.SyclContext.atomic_memory_order_capabilities</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.atomic_memory_scope_capabilities.html">dpctl.SyclContext.atomic_memory_scope_capabilities</a></li>
 <li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.device_count.html">dpctl.SyclContext.device_count</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../api_reference/dpctl/generated/generated/dpctl.SyclContext.sycl_platform.html">dpctl.SyclContext.sycl_platform</a></li>
 </ul>
 </li>
 <li class="toctree-l3 has-children"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.SyclQueue.html">dpctl.SyclQueue</a><input aria-label="Toggle navigation of dpctl.SyclQueue" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
@@ -556,6 +562,8 @@
 <li class="toctree-l2 has-children"><a class="reference internal" href="../../../api_reference/dpctl/compiler.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl.compiler</span></code></a><input aria-label="Toggle navigation of dpctl.compiler" class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" role="switch" type="checkbox"/><label for="toctree-checkbox-17"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.compiler.create_kernel_bundle_from_source.html">dpctl.compiler.create_kernel_bundle_from_source</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.compiler.create_kernel_bundle_from_spirv.html">dpctl.compiler.create_kernel_bundle_from_spirv</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.compiler.create_kernel_bundle_from_sycl_source.html">dpctl.compiler.create_kernel_bundle_from_sycl_source</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.compiler.is_sycl_source_compilation_available.html">dpctl.compiler.is_sycl_source_compilation_available</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.compiler.SyclKernelBundle.html">dpctl.compiler.SyclKernelBundle</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.compiler.SyclKernel.html">dpctl.compiler.SyclKernel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../../api_reference/dpctl/generated/dpctl.compiler.SpecializationConstant.html">dpctl.compiler.SpecializationConstant</a></li>
@@ -684,19 +692,19 @@ <h1>Source code for dpctl.program._program</h1><div class="highlight"><pre>
 <span class="c1">#</span>
 <span class="c1"># Copyright 2020-2025 Intel Corporation</span>
 <span class="c1">#</span>
-<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
+<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
 <span class="c1"># you may not use this file except in compliance with the License.</span>
 <span class="c1"># You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
-<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
+<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 
-<span class="sd">&quot;&quot;&quot;Deprecated wrapper functions for backward compatibility.&quot;&quot;&quot;</span>
+<span class="sd">"""Deprecated wrapper functions for backward compatibility."""</span>
 
 <span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span>
 
@@ -707,38 +715,38 @@ <h1>Source code for dpctl.program._program</h1><div class="highlight"><pre>
 <span class="p">)</span>
 
 
-<div class="viewcode-block" id="create_program_from_source"><a class="viewcode-back" href="../../../api_reference/dpctl/generated/dpctl.program.create_program_from_source.html#dpctl.program.create_program_from_source">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">create_program_from_source</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">copts</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;This function is a deprecated alias for</span>
+<div class="viewcode-block" id="create_program_from_source"><a class="viewcode-back" href="../../../api_reference/dpctl/generated/dpctl.program.create_program_from_source.html#dpctl.program.create_program_from_source">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">create_program_from_source</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">copts</span><span class="o">=</span><span class="s2">""</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">"""This function is a deprecated alias for</span>
 <span class="sd">    :func:`dpctl.compiler.create_kernel_bundle_from_source`.</span>
 <span class="sd">    New code should use :func:`dpctl.compiler.create_kernel_bundle_from_source`.</span>
-<span class="sd">    &quot;&quot;&quot;</span>
+<span class="sd">    """</span>
     <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
-        <span class="s2">&quot;create_program_from_source is deprecated and will be removed in a &quot;</span>
-        <span class="s2">&quot;future release. Use create_kernel_bundle_from_source instead.&quot;</span><span class="p">,</span>
+        <span class="s2">"create_program_from_source is deprecated and will be removed in a "</span>
+        <span class="s2">"future release. Use create_kernel_bundle_from_source instead."</span><span class="p">,</span>
         <span class="ne">DeprecationWarning</span><span class="p">,</span>
         <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
     <span class="p">)</span>
     <span class="k">return</span> <span class="n">create_kernel_bundle_from_source</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">copts</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="create_program_from_spirv"><a class="viewcode-back" href="../../../api_reference/dpctl/generated/dpctl.program.create_program_from_spirv.html#dpctl.program.create_program_from_spirv">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">create_program_from_spirv</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">IL</span><span class="p">,</span> <span class="n">copts</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;This function is a deprecated alias for</span>
+<div class="viewcode-block" id="create_program_from_spirv"><a class="viewcode-back" href="../../../api_reference/dpctl/generated/dpctl.program.create_program_from_spirv.html#dpctl.program.create_program_from_spirv">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">create_program_from_spirv</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">IL</span><span class="p">,</span> <span class="n">copts</span><span class="o">=</span><span class="s2">""</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">"""This function is a deprecated alias for</span>
 <span class="sd">    :func:`dpctl.compiler.create_kernel_bundle_from_spirv`.</span>
 <span class="sd">    New code should use :func:`dpctl.compiler.create_kernel_bundle_from_spirv`.</span>
-<span class="sd">    &quot;&quot;&quot;</span>
+<span class="sd">    """</span>
     <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
-        <span class="s2">&quot;create_program_from_spirv is deprecated and will be removed in a &quot;</span>
-        <span class="s2">&quot;future release. Use create_kernel_bundle_from_spirv instead.&quot;</span><span class="p">,</span>
+        <span class="s2">"create_program_from_spirv is deprecated and will be removed in a "</span>
+        <span class="s2">"future release. Use create_kernel_bundle_from_spirv instead."</span><span class="p">,</span>
         <span class="ne">DeprecationWarning</span><span class="p">,</span>
         <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
     <span class="p">)</span>
     <span class="k">return</span> <span class="n">create_kernel_bundle_from_spirv</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">IL</span><span class="p">,</span> <span class="n">copts</span><span class="p">)</span></div>
 
 
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
-    <span class="s2">&quot;create_program_from_source&quot;</span><span class="p">,</span>
-    <span class="s2">&quot;create_program_from_spirv&quot;</span><span class="p">,</span>
-    <span class="s2">&quot;SyclKernel&quot;</span><span class="p">,</span>
+    <span class="s2">"create_program_from_source"</span><span class="p">,</span>
+    <span class="s2">"create_program_from_spirv"</span><span class="p">,</span>
+    <span class="s2">"SyclKernel"</span><span class="p">,</span>
 <span class="p">]</span>
 </pre></div>
         </article>