Skip to content

Commit 6377b6a

Browse files
author
github-actions[doc-deploy-bot]
committed
Docs for pull request 2067
1 parent 6e86e85 commit 6377b6a

File tree

10 files changed

+34
-4
lines changed

10 files changed

+34
-4
lines changed

‎pulls/2067/_modules/dpctl.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,7 @@ <h1>Source code for dpctl</h1><div class="highlight"><pre>
839839
<span class="kn">from</span><span class="w"> </span><span class="nn">._sycl_platform</span><span class="w"> </span><span class="kn">import</span> <span class="n">SyclPlatform</span><span class="p">,</span> <span class="n">get_platforms</span><span class="p">,</span> <span class="n">lsplatform</span>
840840
<span class="kn">from</span><span class="w"> </span><span class="nn">._sycl_queue</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
841841
<span class="n">LocalAccessor</span><span class="p">,</span>
842+
<span class="n">RawKernelArg</span><span class="p">,</span>
842843
<span class="n">SyclKernelInvalidRangeError</span><span class="p">,</span>
843844
<span class="n">SyclKernelSubmitError</span><span class="p">,</span>
844845
<span class="n">SyclQueue</span><span class="p">,</span>
@@ -895,6 +896,7 @@ <h1>Source code for dpctl</h1><div class="highlight"><pre>
895896
<span class="s2">&quot;SyclQueueCreationError&quot;</span><span class="p">,</span>
896897
<span class="s2">&quot;WorkGroupMemory&quot;</span><span class="p">,</span>
897898
<span class="s2">&quot;LocalAccessor&quot;</span><span class="p">,</span>
899+
<span class="s2">&quot;RawKernelArg&quot;</span><span class="p">,</span>
898900
<span class="p">]</span>
899901
<span class="n">__all__</span> <span class="o">+=</span> <span class="p">[</span>
900902
<span class="s2">&quot;get_device_cached_queue&quot;</span><span class="p">,</span>

‎pulls/2067/_sources/api_reference/libsyclinterface/generated/enum_DPCTLKernelArgType.rst.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Supported types for kernel arguments to be passed to a Sycl kernel using DPCTL.
2929
:target:`DPCTL_VOID_PTR<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a2b3d2dd8e0c358370eac0a59fb3fe089a68399621c4ff81e521dd7cddf2afc9b8>`,
3030
:target:`DPCTL_LOCAL_ACCESSOR<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a2b3d2dd8e0c358370eac0a59fb3fe089ab57b60de172a345897ea16cbf9ca01ff>`,
3131
:target:`DPCTL_WORK_GROUP_MEMORY<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a2b3d2dd8e0c358370eac0a59fb3fe089af1919075135526b50b220cc6829ee80d>`,
32+
:target:`DPCTL_RAW_KERNEL_ARG<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a2b3d2dd8e0c358370eac0a59fb3fe089a29d3d30a17e5dc9573f45d1c8b5cbd4f>`,
3233
:target:`DPCTL_UNSUPPORTED_KERNEL_ARG<doxid-d3/d94/dpctl__sycl__enum__types_8h_1a2b3d2dd8e0c358370eac0a59fb3fe089aa844e18f1a2d00e448ce2ca41e852f20>`,
3334
};
3435

‎pulls/2067/_sources/api_reference/libsyclinterface/generated/global.rst.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Overview
3838
// typedefs
3939

4040
typedef void :ref:`error_handler_callback<doxid-de/d75/dpctl__error__handler__type_8h_1aeb0f262687ced57ead8f8b7d0b7dcefe>`(int err_code);
41+
typedef struct DPCTLOpaqueSyclRawKernelArg* :target:`DPCTLSyclRawKernelArgRef<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1a72d61960f9c803f28ada3994d6b50f76>`;
4142
typedef struct DPCTLOpaqueSyclWorkGroupMemory* :target:`DPCTLSyclWorkGroupMemoryRef<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ab3a8275f34098811f89278732d5dc8a7>`;
4243
typedef :ref:`DPCTL_C_EXTERN_C_BEGIN<doxid-d7/d31/_extern_c_8h_1ad85f54ad0bab1d5206255e5920261be3>` struct :ref:`RawWorkGroupMemoryTy<doxid-db/d1d/struct_raw_work_group_memory_ty>` :target:`RawWorkGroupMemory<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ace3e58dbaa53288d9b7272fe9a6d03b3>`;
4344
typedef struct :ref:`MDLocalAccessorTy<doxid-db/dfd/struct_m_d_local_accessor_ty>` :ref:`MDLocalAccessor<doxid-da/db8/dpctl__sycl__queue__interface_8h_1a7779ae83e3fd4db1174768e1ba62f30b>`;
@@ -121,6 +122,18 @@ Overview
121122
:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` size_t
122123
:ref:`DPCTLDevice_Hash<doxid-d4/d5a/dpctl__sycl__device__interface_8h_1a28538fa8029a6d4c7ff4d972ec690b97>`(:ref:`__dpctl_keep<doxid-d2/d43/group___memory_semantics_1gadd48a0161309931574aed2025a16ade7>` const :ref:`DPCTLSyclDeviceRef<doxid-df/d57/dpctl__sycl__types_8h_1a8dae76b436012ecbdebbd568e77f440d>` DRef);
123124

125+
:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` bool
126+
:target:`DPCTLRawKernelArg_Available<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1a17f6390c34f180364c3d0404798702c0>`();
127+
128+
:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` :ref:`__dpctl_give<doxid-d2/d43/group___memory_semantics_1ga836492a42cdfef6419378dbf8d81f452>` :ref:`DPCTLSyclRawKernelArgRef<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1a72d61960f9c803f28ada3994d6b50f76>`
129+
:target:`DPCTLRawKernelArg_Create<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1aa1763e8649306773bcf52256af411260>`(
130+
void* bytes,
131+
size_t count
132+
);
133+
134+
:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` void
135+
:target:`DPCTLRawKernelArg_Delete<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ae8e1fb1182a0a39c2fed2aa9d4448767>`(:ref:`__dpctl_take<doxid-d2/d43/group___memory_semantics_1ga17fe5722d78d8ce138ca952889d07bc6>` :ref:`DPCTLSyclRawKernelArgRef<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1a72d61960f9c803f28ada3994d6b50f76>` Ref);
136+
124137
:ref:`DPCTL_API<doxid-d3/daa/_dll_export_8h_1aed0c117c235d99c414e0b5033d096785>` bool
125138
:target:`DPCTLWorkGroupMemory_Available<doxid-dd/db8/dpctl__sycl__extension__interface_8h_1ae822b8edf0c8c3192819037b4b8af68e>`();
126139

‎pulls/2067/api_reference/dpctl/generated/dpctl.memory.USMAllocationError.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ <h1>dpctl.memory.USMAllocationError<a class="headerlink" href="#dpctl-memory-usm
798798
<dl class="py exception">
799799
<dt class="sig sig-object py" id="dpctl.memory.USMAllocationError">
800800
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dpctl.memory.</span></span><span class="sig-name descname"><span class="pre">USMAllocationError</span></span><a class="headerlink" href="#dpctl.memory.USMAllocationError" title="Permalink to this definition"></a></dt>
801-
<dd><p>An exception raised when Universal Shared Memory (USM) allocation
801+
<dd><p>An exception raised when Unified Shared Memory (USM) allocation
802802
call returns a null pointer, signaling a failure to perform the allocation.
803803
Some common reasons for allocation failure are:</p>
804804
<blockquote>

‎pulls/2067/api_reference/dpctl/memory.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@
862862
<table class="autosummary longtable docutils align-default">
863863
<tbody>
864864
<tr class="row-odd"><td><p><a class="reference internal" href="generated/dpctl.memory.USMAllocationError.html#dpctl.memory.USMAllocationError" title="dpctl.memory.USMAllocationError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">USMAllocationError</span></code></a></p></td>
865-
<td><p>An exception raised when Universal Shared Memory (USM) allocation call returns a null pointer, signaling a failure to perform the allocation.</p></td>
865+
<td><p>An exception raised when Unified Shared Memory (USM) allocation call returns a null pointer, signaling a failure to perform the allocation.</p></td>
866866
</tr>
867867
</tbody>
868868
</table>

‎pulls/2067/api_reference/libsyclinterface/generated/enum_DPCTLKernelArgType.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
815815
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1a2b3d2dd8e0c358370eac0a59fb3fe089a68399621c4ff81e521dd7cddf2afc9b8"><span></span><span class="n">DPCTL_VOID_PTR</span></span><span></span><span class="p">,</span>
816816
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1a2b3d2dd8e0c358370eac0a59fb3fe089ab57b60de172a345897ea16cbf9ca01ff"><span></span><span class="n">DPCTL_LOCAL_ACCESSOR</span></span><span></span><span class="p">,</span>
817817
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1a2b3d2dd8e0c358370eac0a59fb3fe089af1919075135526b50b220cc6829ee80d"><span></span><span class="n">DPCTL_WORK_GROUP_MEMORY</span></span><span></span><span class="p">,</span>
818+
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1a2b3d2dd8e0c358370eac0a59fb3fe089a29d3d30a17e5dc9573f45d1c8b5cbd4f"><span></span><span class="n">DPCTL_RAW_KERNEL_ARG</span></span><span></span><span class="p">,</span>
818819
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1a2b3d2dd8e0c358370eac0a59fb3fe089aa844e18f1a2d00e448ce2ca41e852f20"><span></span><span class="n">DPCTL_UNSUPPORTED_KERNEL_ARG</span></span><span></span><span class="p">,</span>
819820
<span class="p">};</span></pre>
820821
</section>

‎pulls/2067/api_reference/libsyclinterface/generated/global.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -807,6 +807,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
807807
<span class="c1">// typedefs</span>
808808

809809
<span class="k">typedef</span> <span class="kt">void</span> <a class="reference internal" href="#doxid-de-d75-dpctl-error-handler-type-8h-1aeb0f262687ced57ead8f8b7d0b7dcefe"><span class="std std-ref">error_handler_callback</span></a><span></span><span class="p">(</span><span class="kt">int</span> <span class="n">err_code</span><span class="p">);</span>
810+
<span class="k">typedef</span> <span class="k">struct</span> <span class="n">DPCTLOpaqueSyclRawKernelArg</span><span class="o">*</span> <span class="doxyrest-code-target target" id="doxid-dd-db8-dpctl-sycl-extension-interface-8h-1a72d61960f9c803f28ada3994d6b50f76"><span></span><span class="n">DPCTLSyclRawKernelArgRef</span></span><span></span><span class="p">;</span>
810811
<span class="k">typedef</span> <span class="k">struct</span> <span class="n">DPCTLOpaqueSyclWorkGroupMemory</span><span class="o">*</span> <span class="doxyrest-code-target target" id="doxid-dd-db8-dpctl-sycl-extension-interface-8h-1ab3a8275f34098811f89278732d5dc8a7"><span></span><span class="n">DPCTLSyclWorkGroupMemoryRef</span></span><span></span><span class="p">;</span>
811812
<span class="k">typedef</span> <a class="reference internal" href="#doxid-d7-d31-extern-c-8h-1ad85f54ad0bab1d5206255e5920261be3"><span class="std std-ref">DPCTL_C_EXTERN_C_BEGIN</span></a><span></span> <span class="k">struct</span> <a class="reference internal" href="struct_RawWorkGroupMemoryTy.html#doxid-db-d1d-struct-raw-work-group-memory-ty"><span class="std std-ref">RawWorkGroupMemoryTy</span></a><span></span> <span class="doxyrest-code-target target" id="doxid-dd-db8-dpctl-sycl-extension-interface-8h-1ace3e58dbaa53288d9b7272fe9a6d03b3"><span></span><span class="n">RawWorkGroupMemory</span></span><span></span><span class="p">;</span>
812813
<span class="k">typedef</span> <span class="k">struct</span> <a class="reference internal" href="struct_MDLocalAccessorTy.html#doxid-db-dfd-struct-m-d-local-accessor-ty"><span class="std std-ref">MDLocalAccessorTy</span></a><span></span> <a class="reference internal" href="#doxid-da-db8-dpctl-sycl-queue-interface-8h-1a7779ae83e3fd4db1174768e1ba62f30b"><span class="std std-ref">MDLocalAccessor</span></a><span></span><span class="p">;</span>
@@ -890,6 +891,18 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
890891
DPCTL_API<span></span> <span class="kt">size_t</span>
891892
<a class="reference internal" href="#doxid-d4-d5a-dpctl-sycl-device-interface-8h-1a28538fa8029a6d4c7ff4d972ec690b97"><span class="std std-ref">DPCTLDevice_Hash</span></a><span></span><span class="p">(</span>__dpctl_keep<span></span> <span class="k">const</span> <a class="reference internal" href="#doxid-df-d57-dpctl-sycl-types-8h-1a8dae76b436012ecbdebbd568e77f440d"><span class="std std-ref">DPCTLSyclDeviceRef</span></a><span></span> <span class="n">DRef</span><span class="p">);</span>
892893

894+
DPCTL_API<span></span> <span class="kt">bool</span>
895+
<span class="doxyrest-code-target target" id="doxid-dd-db8-dpctl-sycl-extension-interface-8h-1a17f6390c34f180364c3d0404798702c0"><span></span><span class="n">DPCTLRawKernelArg_Available</span></span><span></span><span class="p">();</span>
896+
897+
DPCTL_API<span></span> __dpctl_give<span></span> <a class="reference internal" href="#doxid-dd-db8-dpctl-sycl-extension-interface-8h-1a72d61960f9c803f28ada3994d6b50f76"><span class="std std-ref">DPCTLSyclRawKernelArgRef</span></a><span></span>
898+
<span class="doxyrest-code-target target" id="doxid-dd-db8-dpctl-sycl-extension-interface-8h-1aa1763e8649306773bcf52256af411260"><span></span><span class="n">DPCTLRawKernelArg_Create</span></span><span></span><span class="p">(</span>
899+
<span class="kt">void</span><span class="o">*</span> <span class="n">bytes</span><span class="p">,</span>
900+
<span class="kt">size_t</span> <span class="n">count</span>
901+
<span class="p">);</span>
902+
903+
DPCTL_API<span></span> <span class="kt">void</span>
904+
<span class="doxyrest-code-target target" id="doxid-dd-db8-dpctl-sycl-extension-interface-8h-1ae8e1fb1182a0a39c2fed2aa9d4448767"><span></span><span class="n">DPCTLRawKernelArg_Delete</span></span><span></span><span class="p">(</span>__dpctl_take<span></span> <a class="reference internal" href="#doxid-dd-db8-dpctl-sycl-extension-interface-8h-1a72d61960f9c803f28ada3994d6b50f76"><span class="std std-ref">DPCTLSyclRawKernelArgRef</span></a><span></span> <span class="n">Ref</span><span class="p">);</span>
905+
893906
DPCTL_API<span></span> <span class="kt">bool</span>
894907
<span class="doxyrest-code-target target" id="doxid-dd-db8-dpctl-sycl-extension-interface-8h-1ae822b8edf0c8c3192819037b4b8af68e"><span></span><span class="n">DPCTLWorkGroupMemory_Available</span></span><span></span><span class="p">();</span>
895908

‎pulls/2067/beginners_guides/installation.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -858,7 +858,7 @@ <h2>Installation using pip<a class="headerlink" href="#installation-using-pip" t
858858
<section id="installation-via-intel-r-distribution-for-python">
859859
<h2>Installation via Intel(R) Distribution for Python<a class="headerlink" href="#installation-via-intel-r-distribution-for-python" title="Permalink to this heading"></a></h2>
860860
<p><a class="reference external" href="https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html">Intel(R) Distribution for Python*</a> is distributed as a conda-based installer
861-
and includes <a class="reference internal" href="../api_reference/dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> along with its dependencies and sister projects <a class="reference external" href="https://intelpython.github.io/dpnp/overview.html#module-dpnp" title="(in Data Parallel Extension for NumPy v0.18.0dev1+9.ge5ab49bc587)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
861+
and includes <a class="reference internal" href="../api_reference/dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> along with its dependencies and sister projects <a class="reference external" href="https://intelpython.github.io/dpnp/overview.html#module-dpnp" title="(in Data Parallel Extension for NumPy v0.18.0dev1+11.g6a81e553298)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
862862
and <a class="reference external" href="https://intelpython.github.io/numba-dpex/latest/index.html#module-numba_dpex" title="(in numba-dpex)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">numba_dpex</span></code></a>.</p>
863863
<p>Once the installed environment is activated, <code class="docutils literal notranslate"><span class="pre">dpctl</span></code> should be ready to use.</p>
864864
</section>

‎pulls/2067/objects.inv‎

141 Bytes
Binary file not shown.

‎pulls/2067/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)