Skip to content

Commit d3cc2a9

Browse files
author
github-actions[doc-deploy-bot]
committed
Latest docs.
1 parent dd71bf4 commit d3cc2a9

10 files changed

+53
-40
lines changed

master/api_reference/dpctl/generated/dpctl.program.create_program_from_spirv.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -799,9 +799,9 @@ <h1>dpctl.program.create_program_from_spirv<a class="headerlink" href="#dpctl-pr
799799
<dt class="sig sig-object py" id="dpctl.program.create_program_from_spirv">
800800
<span class="sig-prename descclassname"><span class="pre">dpctl.program.</span></span><span class="sig-name descname"><span class="pre">create_program_from_spirv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">IL</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.program.create_program_from_spirv" title="Permalink to this definition"></a></dt>
801801
<dd><p>Creates a Sycl interoperability program from an SPIR-V binary.</p>
802-
<p>We use the <code class="xref c c-func docutils literal notranslate"><span class="pre">DPCTLKernelBundle_CreateFromOCLSpirv()</span></code> C API function to
803-
create a <code class="docutils literal notranslate"><span class="pre">sycl::kernel_bundle&lt;sycl::bundle_state::executable&gt;</span></code> object
804-
from an compiled SPIR-V binary file.</p>
802+
<p>We use the <code class="xref c c-func docutils literal notranslate"><span class="pre">DPCTLKernelBundle_CreateFromOCLSpirv()</span></code> C API function
803+
to create a <code class="docutils literal notranslate"><span class="pre">sycl::kernel_bundle&lt;sycl::bundle_state::executable&gt;</span></code>
804+
object from an compiled SPIR-V binary file.</p>
805805
<dl class="field-list simple">
806806
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
807807
<dd class="field-odd"><ul class="simple">

master/api_reference/dpctl/generated/dpctl.tensor.from_dlpack.html

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -798,14 +798,19 @@ <h1>dpctl.tensor.from_dlpack<a class="headerlink" href="#dpctl-tensor-from-dlpac
798798
<dl class="py function">
799799
<dt class="sig sig-object py" id="dpctl.tensor.from_dlpack">
800800
<span class="sig-prename descclassname"><span class="pre">dpctl.tensor.</span></span><span class="sig-name descname"><span class="pre">from_dlpack</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.tensor.from_dlpack" title="Permalink to this definition"></a></dt>
801-
<dd><p>Constructs <a class="reference internal" href="dpctl.tensor.usm_ndarray.html#dpctl.tensor.usm_ndarray" title="dpctl.tensor.usm_ndarray"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.usm_ndarray</span></code></a> or <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a> instance
802-
from a Python object <code class="docutils literal notranslate"><span class="pre">x</span></code> that implements <code class="docutils literal notranslate"><span class="pre">__dlpack__</span></code> protocol.</p>
801+
<dd><p>Constructs <a class="reference internal" href="dpctl.tensor.usm_ndarray.html#dpctl.tensor.usm_ndarray" title="dpctl.tensor.usm_ndarray"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.usm_ndarray</span></code></a> or <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>
802+
instance from a Python object <code class="docutils literal notranslate"><span class="pre">x</span></code> that implements <code class="docutils literal notranslate"><span class="pre">__dlpack__</span></code> protocol.</p>
803803
<dl class="field-list simple">
804804
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
805805
<dd class="field-odd"><ul class="simple">
806806
<li><p><strong>x</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><em>object</em></a>) – A Python object representing an array that supports
807807
<code class="docutils literal notranslate"><span class="pre">__dlpack__</span></code> protocol.</p></li>
808-
<li><p><strong>device</strong> (Optional[str, <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>, <a class="reference internal" href="dpctl.SyclQueue.html#dpctl.SyclQueue" title="dpctl.SyclQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclQueue</span></code></a>, <a class="reference internal" href="../tensor.utility_functions.html#dpctl.tensor.Device" title="dpctl.tensor.Device"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.Device</span></code></a>, tuple([<a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.IntEnum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.IntEnum</span></code></a>, int])])) – <p>Device where the output array is to be placed. <code class="docutils literal notranslate"><span class="pre">device</span></code> keyword values can be:</p>
808+
<li><p><strong>(</strong> (<em>device</em>) – Optional[str, <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>,
809+
<a class="reference internal" href="dpctl.SyclQueue.html#dpctl.SyclQueue" title="dpctl.SyclQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclQueue</span></code></a>,
810+
<a class="reference internal" href="../tensor.utility_functions.html#dpctl.tensor.Device" title="dpctl.tensor.Device"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.Device</span></code></a>,
811+
tuple([<a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.IntEnum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.IntEnum</span></code></a>, int])])</p></li>
812+
<li><p><strong>)</strong><p>Device where the output array is to be placed. <code class="docutils literal notranslate"><span class="pre">device</span></code> keyword
813+
values can be:</p>
809814
<ul>
810815
<li><dl class="simple">
811816
<dt><code class="docutils literal notranslate"><span class="pre">None</span></code></dt><dd><p>The data remains on the same device.</p>
@@ -835,11 +840,11 @@ <h1>dpctl.tensor.from_dlpack<a class="headerlink" href="#dpctl-tensor-from-dlpac
835840
</dl>
836841
</li>
837842
<li><dl class="simple">
838-
<dt><code class="docutils literal notranslate"><span class="pre">(device_type,</span> <span class="pre">device_id)</span></code></dt><dd><p>2-tuple matching the format of the output of the <code class="docutils literal notranslate"><span class="pre">__dlpack_device__</span></code>
839-
method: an integer enumerator representing the device type followed by
840-
an integer representing the index of the device.
841-
The only supported <a class="reference internal" href="../tensor.constants.html#dpctl.tensor.DLDeviceType" title="dpctl.tensor.DLDeviceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.DLDeviceType</span></code></a> device types
842-
are <code class="docutils literal notranslate"><span class="pre">&quot;kDLCPU&quot;</span></code> and <code class="docutils literal notranslate"><span class="pre">&quot;kDLOneAPI&quot;</span></code>.</p>
843+
<dt><code class="docutils literal notranslate"><span class="pre">(device_type,</span> <span class="pre">device_id)</span></code></dt><dd><p>2-tuple matching the format of the output of the
844+
<code class="docutils literal notranslate"><span class="pre">__dlpack_device__</span></code> method: an integer enumerator representing
845+
the device type followed by an integer representing the index of
846+
the device. The only supported <a class="reference internal" href="../tensor.constants.html#dpctl.tensor.DLDeviceType" title="dpctl.tensor.DLDeviceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.DLDeviceType</span></code></a>
847+
device types are <code class="docutils literal notranslate"><span class="pre">&quot;kDLCPU&quot;</span></code> and <code class="docutils literal notranslate"><span class="pre">&quot;kDLOneAPI&quot;</span></code>.</p>
843848
</dd>
844849
</dl>
845850
</li>
@@ -867,16 +872,17 @@ <h1>dpctl.tensor.from_dlpack<a class="headerlink" href="#dpctl-tensor-from-dlpac
867872
<p>The type of the returned object
868873
depends on where the data backing up input object <code class="docutils literal notranslate"><span class="pre">x</span></code> resides.
869874
If it resides in a USM allocation on a SYCL device, the
870-
type <a class="reference internal" href="dpctl.tensor.usm_ndarray.html#dpctl.tensor.usm_ndarray" title="dpctl.tensor.usm_ndarray"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.usm_ndarray</span></code></a> is returned, otherwise if it resides
871-
on <code class="docutils literal notranslate"><span class="pre">&quot;kDLCPU&quot;</span></code> device the type is <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>, and otherwise
872-
an exception is raised.</p>
875+
type <a class="reference internal" href="dpctl.tensor.usm_ndarray.html#dpctl.tensor.usm_ndarray" title="dpctl.tensor.usm_ndarray"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.usm_ndarray</span></code></a> is returned, otherwise if it
876+
resides on <code class="docutils literal notranslate"><span class="pre">&quot;kDLCPU&quot;</span></code> device the type is <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>,
877+
and otherwise an exception is raised.</p>
873878
<div class="admonition note">
874879
<p class="admonition-title">Note</p>
875-
<p>If the return type is <a class="reference internal" href="dpctl.tensor.usm_ndarray.html#dpctl.tensor.usm_ndarray" title="dpctl.tensor.usm_ndarray"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.usm_ndarray</span></code></a>, the associated
876-
SYCL queue is derived from the <code class="docutils literal notranslate"><span class="pre">device</span></code> keyword. When <code class="docutils literal notranslate"><span class="pre">device</span></code>
877-
keyword value has type <a class="reference internal" href="dpctl.SyclQueue.html#dpctl.SyclQueue" title="dpctl.SyclQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclQueue</span></code></a>, the explicit queue
878-
instance is used, when <code class="docutils literal notranslate"><span class="pre">device</span></code> keyword value has type <a class="reference internal" href="../tensor.utility_functions.html#dpctl.tensor.Device" title="dpctl.tensor.Device"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.Device</span></code></a>,
879-
the <code class="docutils literal notranslate"><span class="pre">device.sycl_queue</span></code> is used. In all other cases, the cached
880+
<p>If the return type is <a class="reference internal" href="dpctl.tensor.usm_ndarray.html#dpctl.tensor.usm_ndarray" title="dpctl.tensor.usm_ndarray"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.usm_ndarray</span></code></a>, the
881+
associated SYCL queue is derived from the <code class="docutils literal notranslate"><span class="pre">device</span></code> keyword.
882+
When <code class="docutils literal notranslate"><span class="pre">device</span></code> keyword value has type <a class="reference internal" href="dpctl.SyclQueue.html#dpctl.SyclQueue" title="dpctl.SyclQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.SyclQueue</span></code></a>,
883+
the explicit queue instance is used, when <code class="docutils literal notranslate"><span class="pre">device</span></code> keyword
884+
value has type <a class="reference internal" href="../tensor.utility_functions.html#dpctl.tensor.Device" title="dpctl.tensor.Device"><code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.tensor.Device</span></code></a>, the
885+
<code class="docutils literal notranslate"><span class="pre">device.sycl_queue</span></code> is used. In all other cases, the cached
880886
SYCL queue corresponding to the implied SYCL device is used.</p>
881887
</div>
882888
</p>

master/api_reference/dpctl/generated/generated/dpctl.SyclDevice.create_sub_devices.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -832,23 +832,24 @@ <h1>dpctl.SyclDevice.create_sub_devices<a class="headerlink" href="#dpctl-syclde
832832
<ul class="simple">
833833
<li><dl class="simple">
834834
<dt>Specifying an int (<code class="docutils literal notranslate"><span class="pre">count</span></code>)</dt><dd><p>The returned list contains as
835-
many sub-devices as can be created such that each sub-device
836-
contains <code class="docutils literal notranslate"><span class="pre">count</span></code> compute units. If the device’s total number
837-
of compute units is not evenly divided by <code class="docutils literal notranslate"><span class="pre">count</span></code>, then the
838-
remaining compute units are not included in any of the
839-
sub-devices.</p>
835+
many sub-devices as can be created such that each
836+
sub-device contains <code class="docutils literal notranslate"><span class="pre">count</span></code> compute units. If the
837+
device’s total number of compute units is not evenly
838+
divided by <code class="docutils literal notranslate"><span class="pre">count</span></code>, then the remaining compute units
839+
are not included in any of the sub-devices.</p>
840840
</dd>
841841
</dl>
842842
</li>
843843
<li><dl class="simple">
844-
<dt>Specifying an affinity domain as a string</dt><dd><p>The supported values are: <code class="docutils literal notranslate"><span class="pre">&quot;numa&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;L4_cache&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;L3_cache&quot;</span></code>,
845-
<code class="docutils literal notranslate"><span class="pre">&quot;L2_cache&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;L1_cache&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;next_partitionable&quot;</span></code>.</p>
844+
<dt>Specifying an affinity domain as a string</dt><dd><p>The supported values are: <code class="docutils literal notranslate"><span class="pre">&quot;numa&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;L4_cache&quot;</span></code>,
845+
<code class="docutils literal notranslate"><span class="pre">&quot;L3_cache&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;L2_cache&quot;</span></code>, <code class="docutils literal notranslate"><span class="pre">&quot;L1_cache&quot;</span></code>,
846+
<code class="docutils literal notranslate"><span class="pre">&quot;next_partitionable&quot;</span></code>.</p>
846847
</dd>
847848
</dl>
848849
</li>
849850
<li><dl class="simple">
850-
<dt>Specifying a collection of integral values</dt><dd><p>For each non-zero value <code class="docutils literal notranslate"><span class="pre">M</span></code> in the collection, a sub-device with <code class="docutils literal notranslate"><span class="pre">M</span></code>
851-
compute units is created.</p>
851+
<dt>Specifying a collection of integral values</dt><dd><p>For each non-zero value <code class="docutils literal notranslate"><span class="pre">M</span></code> in the collection, a
852+
sub-device with <code class="docutils literal notranslate"><span class="pre">M</span></code> compute units is created.</p>
852853
</dd>
853854
</dl>
854855
</li>

master/api_reference/dpctl/generated/generated/dpctl.SyclDevice.sub_group_independent_forward_progress.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -798,8 +798,8 @@ <h1>dpctl.SyclDevice.sub_group_independent_forward_progress<a class="headerlink"
798798
<dl class="py attribute">
799799
<dt class="sig sig-object py" id="dpctl.SyclDevice.sub_group_independent_forward_progress">
800800
<span class="sig-prename descclassname"><span class="pre">SyclDevice.</span></span><span class="sig-name descname"><span class="pre">sub_group_independent_forward_progress</span></span><a class="headerlink" href="#dpctl.SyclDevice.sub_group_independent_forward_progress" title="Permalink to this definition"></a></dt>
801-
<dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if the device supports independent forward progress of
802-
sub-groups with respect to other sub-groups in the same work-group.</p>
801+
<dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if the device supports independent forward progress
802+
of sub-groups with respect to other sub-groups in the same work-group.</p>
803803
<dl class="field-list simple">
804804
<dt class="field-odd">Returns<span class="colon">:</span></dt>
805805
<dd class="field-odd"><p>Indicates if the device supports independent forward progress

master/api_reference/dpctl/generated/generated/dpctl.SyclPlatform.print_platform_info.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -814,8 +814,8 @@ <h1>dpctl.SyclPlatform.print_platform_info<a class="headerlink" href="#dpctl-syc
814814
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
815815
<dd class="field-odd"><p><strong>verbosity</strong> (<em>Literal</em><em>[</em><em>0</em><em>, </em><em>1</em><em>, </em><em>2</em><em>]</em><em>, </em><em>optional</em>) – <p>.
816816
The verbosity controls how much information is printed by the
817-
function. Value <code class="docutils literal notranslate"><span class="pre">0</span></code> is the lowest level set by default and <code class="docutils literal notranslate"><span class="pre">2</span></code>
818-
is the highest level to print the most verbose output.
817+
function. Value <code class="docutils literal notranslate"><span class="pre">0</span></code> is the lowest level set by default and
818+
<code class="docutils literal notranslate"><span class="pre">2</span></code> is the highest level to print the most verbose output.
819819
Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
820820
</p>
821821
</dd>

0 commit comments

Comments
 (0)