Skip to content

Commit aff3826

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

File tree

4 files changed

+47
-59
lines changed

4 files changed

+47
-59
lines changed

pulls/2019/_modules/dpctl/enum_types.html

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -812,14 +812,12 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
812812
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
813813
<span class="sd"> An :class:`enum.Enum` of supported SYCL device types.</span>
814814

815-
<span class="sd"> Accepted enum values are:</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>
815+
<span class="sd"> | ``all``</span>
816+
<span class="sd"> | ``accelerator``</span>
817+
<span class="sd"> | ``automatic``</span>
818+
<span class="sd"> | ``cpu``</span>
819+
<span class="sd"> | ``custom``</span>
820+
<span class="sd"> | ``gpu``</span>
823821

824822
<span class="sd"> :Example:</span>
825823
<span class="sd"> .. code-block:: python</span>
@@ -848,13 +846,11 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
848846
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
849847
<span class="sd"> An :class:`enum.Enum` of supported SYCL backends.</span>
850848

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>
849+
<span class="sd"> | ``all``</span>
850+
<span class="sd"> | ``cuda``</span>
851+
<span class="sd"> | ``hip``</span>
852+
<span class="sd"> | ``level_zero``</span>
853+
<span class="sd"> | ``opencl``</span>
858854

859855
<span class="sd"> :Example:</span>
860856
<span class="sd"> .. code-block:: python</span>
@@ -878,12 +874,10 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
878874
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
879875
<span class="sd"> An :class:`enum.Enum` of SYCL event states.</span>
880876

881-
<span class="sd"> Accepted enum values are:</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>
877+
<span class="sd"> | ``unknown_status``</span>
878+
<span class="sd"> | ``submitted``</span>
879+
<span class="sd"> | ``running``</span>
880+
<span class="sd"> | ``complete``</span>
887881

888882
<span class="sd"> :Example:</span>
889883
<span class="sd"> .. code-block:: python</span>
@@ -904,12 +898,10 @@ <h1>Source code for dpctl.enum_types</h1><div class="highlight"><pre>
904898
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
905899
<span class="sd"> An :class:`enum.Enum` of global memory cache types for a device.</span>
906900

907-
<span class="sd"> Accepted enum values are:</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>
901+
<span class="sd"> | ``indeterminate``</span>
902+
<span class="sd"> | ``none``</span>
903+
<span class="sd"> | ``read_only``</span>
904+
<span class="sd"> | ``read_write``</span>
913905

914906
<span class="sd"> :Example:</span>
915907
<span class="sd"> .. code-block:: python</span>

pulls/2019/api_reference/dpctl/constants.html

Lines changed: 27 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -794,15 +794,14 @@
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-
<p>Accepted enum values are</p>
798797
<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>
798+
<div><div class="line-block">
799+
<div class="line"><code class="docutils literal notranslate"><span class="pre">all</span></code></div>
800+
<div class="line"><code class="docutils literal notranslate"><span class="pre">cuda</span></code></div>
801+
<div class="line"><code class="docutils literal notranslate"><span class="pre">hip</span></code></div>
802+
<div class="line"><code class="docutils literal notranslate"><span class="pre">level_zero</span></code></div>
803+
<div class="line"><code class="docutils literal notranslate"><span class="pre">opencl</span></code></div>
804+
</div>
806805
</div></blockquote>
807806
<dl class="field-list">
808807
<dt class="field-odd">Example<span class="colon">:</span></dt>
@@ -822,16 +821,15 @@
822821
<dt class="sig sig-object py" id="dpctl.device_type">
823822
<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>
824823
<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>
825-
<p>Accepted enum values are:</p>
826824
<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>
825+
<div><div class="line-block">
826+
<div class="line"><code class="docutils literal notranslate"><span class="pre">all</span></code></div>
827+
<div class="line"><code class="docutils literal notranslate"><span class="pre">accelerator</span></code></div>
828+
<div class="line"><code class="docutils literal notranslate"><span class="pre">automatic</span></code></div>
829+
<div class="line"><code class="docutils literal notranslate"><span class="pre">cpu</span></code></div>
830+
<div class="line"><code class="docutils literal notranslate"><span class="pre">custom</span></code></div>
831+
<div class="line"><code class="docutils literal notranslate"><span class="pre">gpu</span></code></div>
832+
</div>
835833
</div></blockquote>
836834
<dl class="field-list">
837835
<dt class="field-odd">Example<span class="colon">:</span></dt>
@@ -855,14 +853,13 @@
855853
<dt class="sig sig-object py" id="dpctl.event_status_type">
856854
<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>
857855
<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>
858-
<p>Accepted enum values are:</p>
859856
<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>
857+
<div><div class="line-block">
858+
<div class="line"><code class="docutils literal notranslate"><span class="pre">unknown_status</span></code></div>
859+
<div class="line"><code class="docutils literal notranslate"><span class="pre">submitted</span></code></div>
860+
<div class="line"><code class="docutils literal notranslate"><span class="pre">running</span></code></div>
861+
<div class="line"><code class="docutils literal notranslate"><span class="pre">complete</span></code></div>
862+
</div>
866863
</div></blockquote>
867864
<dl class="field-list">
868865
<dt class="field-odd">Example<span class="colon">:</span></dt>
@@ -880,14 +877,13 @@
880877
<dt class="sig sig-object py" id="dpctl.global_mem_cache_type">
881878
<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>
882879
<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>
883-
<p>Accepted enum values are:</p>
884880
<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>
881+
<div><div class="line-block">
882+
<div class="line"><code class="docutils literal notranslate"><span class="pre">indeterminate</span></code></div>
883+
<div class="line"><code class="docutils literal notranslate"><span class="pre">none</span></code></div>
884+
<div class="line"><code class="docutils literal notranslate"><span class="pre">read_only</span></code></div>
885+
<div class="line"><code class="docutils literal notranslate"><span class="pre">read_write</span></code></div>
886+
</div>
891887
</div></blockquote>
892888
<dl class="field-list">
893889
<dt class="field-odd">Example<span class="colon">:</span></dt>

pulls/2019/objects.inv

0 Bytes
Binary file not shown.

pulls/2019/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)