Skip to content

Commit 92c2384

Browse files
author
github-actions[doc-deploy-bot]
committed
Docs for pull request 2019
1 parent 7c3a0e6 commit 92c2384

File tree

3 files changed

+63
-51
lines changed

3 files changed

+63
-51
lines changed

pulls/2019/_modules/dpctl/enum_types.html

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -813,12 +813,13 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
813813
<span class="sd"> An :class:`enum.Enum` of supported SYCL device types.</span>
814814

815815
<span class="sd"> Accepted enum values are:</span>
816-
<span class="sd"> ``all``</span>
817-
<span class="sd"> ``accelerator``</span>
818-
<span class="sd"> ``automatic``</span>
819-
<span class="sd"> ``cpu``</span>
820-
<span class="sd"> ``custom``</span>
821-
<span class="sd"> ``gpu``</span>
816+
817+
<span class="sd"> * ``all``</span>
818+
<span class="sd"> * ``accelerator``</span>
819+
<span class="sd"> * ``automatic``</span>
820+
<span class="sd"> * ``cpu``</span>
821+
<span class="sd"> * ``custom``</span>
822+
<span class="sd"> * ``gpu``</span>
822823

823824
<span class="sd"> :Example:</span>
824825
<span class="sd"> .. code-block:: python</span>
@@ -847,12 +848,13 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
847848
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
848849
<span class="sd"> An :class:`enum.Enum` of supported SYCL backends.</span>
849850

850-
<span class="sd"> Accepted enum values are:</span>
851-
<span class="sd"> ``all``</span>
852-
<span class="sd"> ``cuda``</span>
853-
<span class="sd"> ``hip``</span>
854-
<span class="sd"> ``level_zero``</span>
855-
<span class="sd"> ``opencl``</span>
851+
<span class="sd"> Accepted enum values are</span>
852+
853+
<span class="sd"> * ``all``</span>
854+
<span class="sd"> * ``cuda``</span>
855+
<span class="sd"> * ``hip``</span>
856+
<span class="sd"> * ``level_zero``</span>
857+
<span class="sd"> * ``opencl``</span>
856858

857859
<span class="sd"> :Example:</span>
858860
<span class="sd"> .. code-block:: python</span>
@@ -877,10 +879,11 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
877879
<span class="sd"> An :class:`enum.Enum` of SYCL event states.</span>
878880

879881
<span class="sd"> Accepted enum values are:</span>
880-
<span class="sd"> ``unknown_status``</span>
881-
<span class="sd"> ``submitted``</span>
882-
<span class="sd"> ``running``</span>
883-
<span class="sd"> ``complete``</span>
882+
883+
<span class="sd"> * ``unknown_status``</span>
884+
<span class="sd"> * ``submitted``</span>
885+
<span class="sd"> * ``running``</span>
886+
<span class="sd"> * ``complete``</span>
884887

885888
<span class="sd"> :Example:</span>
886889
<span class="sd"> .. code-block:: python</span>
@@ -902,10 +905,11 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
902905
<span class="sd"> An :class:`enum.Enum` of global memory cache types for a device.</span>
903906

904907
<span class="sd"> Accepted enum values are:</span>
905-
<span class="sd"> ``indeterminate``</span>
906-
<span class="sd"> ``none``</span>
907-
<span class="sd"> ``read_only``</span>
908-
<span class="sd"> ``read_write``</span>
908+
909+
<span class="sd"> * ``indeterminate``</span>
910+
<span class="sd"> * ``none``</span>
911+
<span class="sd"> * ``read_only``</span>
912+
<span class="sd"> * ``read_write``</span>
909913

910914
<span class="sd"> :Example:</span>
911915
<span class="sd"> .. code-block:: python</span>

pulls/2019/api_reference/dpctl/constants.html

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -794,14 +794,16 @@
794794
<dt class="sig sig-object py" id="dpctl.backend_type">
795795
<span class="sig-prename descclassname"><span class="pre">dpctl.</span></span><span class="sig-name descname"><span class="pre">backend_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;enum</span> <span class="pre">'backend_type'&gt;</span></em><a class="reference internal" href="../../_modules/dpctl/enum_types.html#backend_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dpctl.backend_type" title="Permalink to this definition"></a></dt>
796796
<dd><p>An <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a> of supported SYCL backends.</p>
797-
<dl class="simple">
798-
<dt>Accepted enum values are:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">all</span></code>
799-
<code class="docutils literal notranslate"><span class="pre">cuda</span></code>
800-
<code class="docutils literal notranslate"><span class="pre">hip</span></code>
801-
<code class="docutils literal notranslate"><span class="pre">level_zero</span></code>
802-
<code class="docutils literal notranslate"><span class="pre">opencl</span></code></p>
803-
</dd>
804-
</dl>
797+
<p>Accepted enum values are</p>
798+
<blockquote>
799+
<div><ul class="simple">
800+
<li><p><code class="docutils literal notranslate"><span class="pre">all</span></code></p></li>
801+
<li><p><code class="docutils literal notranslate"><span class="pre">cuda</span></code></p></li>
802+
<li><p><code class="docutils literal notranslate"><span class="pre">hip</span></code></p></li>
803+
<li><p><code class="docutils literal notranslate"><span class="pre">level_zero</span></code></p></li>
804+
<li><p><code class="docutils literal notranslate"><span class="pre">opencl</span></code></p></li>
805+
</ul>
806+
</div></blockquote>
805807
<dl class="field-list">
806808
<dt class="field-odd">Example<span class="colon">:</span></dt>
807809
<dd class="field-odd"><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>
@@ -820,15 +822,17 @@
820822
<dt class="sig sig-object py" id="dpctl.device_type">
821823
<span class="sig-prename descclassname"><span class="pre">dpctl.</span></span><span class="sig-name descname"><span class="pre">device_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;enum</span> <span class="pre">'device_type'&gt;</span></em><a class="reference internal" href="../../_modules/dpctl/enum_types.html#device_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dpctl.device_type" title="Permalink to this definition"></a></dt>
822824
<dd><p>An <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a> of supported SYCL device types.</p>
823-
<dl class="simple">
824-
<dt>Accepted enum values are:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">all</span></code>
825-
<code class="docutils literal notranslate"><span class="pre">accelerator</span></code>
826-
<code class="docutils literal notranslate"><span class="pre">automatic</span></code>
827-
<code class="docutils literal notranslate"><span class="pre">cpu</span></code>
828-
<code class="docutils literal notranslate"><span class="pre">custom</span></code>
829-
<code class="docutils literal notranslate"><span class="pre">gpu</span></code></p>
830-
</dd>
831-
</dl>
825+
<p>Accepted enum values are:</p>
826+
<blockquote>
827+
<div><ul class="simple">
828+
<li><p><code class="docutils literal notranslate"><span class="pre">all</span></code></p></li>
829+
<li><p><code class="docutils literal notranslate"><span class="pre">accelerator</span></code></p></li>
830+
<li><p><code class="docutils literal notranslate"><span class="pre">automatic</span></code></p></li>
831+
<li><p><code class="docutils literal notranslate"><span class="pre">cpu</span></code></p></li>
832+
<li><p><code class="docutils literal notranslate"><span class="pre">custom</span></code></p></li>
833+
<li><p><code class="docutils literal notranslate"><span class="pre">gpu</span></code></p></li>
834+
</ul>
835+
</div></blockquote>
832836
<dl class="field-list">
833837
<dt class="field-odd">Example<span class="colon">:</span></dt>
834838
<dd class="field-odd"><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>
@@ -851,13 +855,15 @@
851855
<dt class="sig sig-object py" id="dpctl.event_status_type">
852856
<span class="sig-prename descclassname"><span class="pre">dpctl.</span></span><span class="sig-name descname"><span class="pre">event_status_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;enum</span> <span class="pre">'event_status_type'&gt;</span></em><a class="reference internal" href="../../_modules/dpctl/enum_types.html#event_status_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dpctl.event_status_type" title="Permalink to this definition"></a></dt>
853857
<dd><p>An <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a> of SYCL event states.</p>
854-
<dl class="simple">
855-
<dt>Accepted enum values are:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">unknown_status</span></code>
856-
<code class="docutils literal notranslate"><span class="pre">submitted</span></code>
857-
<code class="docutils literal notranslate"><span class="pre">running</span></code>
858-
<code class="docutils literal notranslate"><span class="pre">complete</span></code></p>
859-
</dd>
860-
</dl>
858+
<p>Accepted enum values are:</p>
859+
<blockquote>
860+
<div><ul class="simple">
861+
<li><p><code class="docutils literal notranslate"><span class="pre">unknown_status</span></code></p></li>
862+
<li><p><code class="docutils literal notranslate"><span class="pre">submitted</span></code></p></li>
863+
<li><p><code class="docutils literal notranslate"><span class="pre">running</span></code></p></li>
864+
<li><p><code class="docutils literal notranslate"><span class="pre">complete</span></code></p></li>
865+
</ul>
866+
</div></blockquote>
861867
<dl class="field-list">
862868
<dt class="field-odd">Example<span class="colon">:</span></dt>
863869
<dd class="field-odd"><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>
@@ -874,13 +880,15 @@
874880
<dt class="sig sig-object py" id="dpctl.global_mem_cache_type">
875881
<span class="sig-prename descclassname"><span class="pre">dpctl.</span></span><span class="sig-name descname"><span class="pre">global_mem_cache_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;enum</span> <span class="pre">'global_mem_cache_type'&gt;</span></em><a class="reference internal" href="../../_modules/dpctl/enum_types.html#global_mem_cache_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dpctl.global_mem_cache_type" title="Permalink to this definition"></a></dt>
876882
<dd><p>An <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a> of global memory cache types for a device.</p>
877-
<dl class="simple">
878-
<dt>Accepted enum values are:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">indeterminate</span></code>
879-
<code class="docutils literal notranslate"><span class="pre">none</span></code>
880-
<code class="docutils literal notranslate"><span class="pre">read_only</span></code>
881-
<code class="docutils literal notranslate"><span class="pre">read_write</span></code></p>
882-
</dd>
883-
</dl>
883+
<p>Accepted enum values are:</p>
884+
<blockquote>
885+
<div><ul class="simple">
886+
<li><p><code class="docutils literal notranslate"><span class="pre">indeterminate</span></code></p></li>
887+
<li><p><code class="docutils literal notranslate"><span class="pre">none</span></code></p></li>
888+
<li><p><code class="docutils literal notranslate"><span class="pre">read_only</span></code></p></li>
889+
<li><p><code class="docutils literal notranslate"><span class="pre">read_write</span></code></p></li>
890+
</ul>
891+
</div></blockquote>
884892
<dl class="field-list">
885893
<dt class="field-odd">Example<span class="colon">:</span></dt>
886894
<dd class="field-odd"><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/2019/objects.inv

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)