Skip to content

Commit 6254645

Browse files
author
github-actions[doc-deploy-bot]
committed
Docs for pull request 2304
1 parent 7b5f2ff commit 6254645

16 files changed

Lines changed: 17 additions & 17 deletions

File tree

pulls/2304/_sources/api_reference/dpctl/filter_selector_string.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ least one component.
2424
``Backend`` specifies the desired backend of targeted devices, while
2525
``DeviceType`` specifies the type of targeted devices.
2626
``RelativeDeviceNumber`` refers to the number of the device that matches
27-
any other given requirements, starting from `0` to marking the
27+
any other given requirements, starting from 0 to marking the
2828
"first device that matches the requirements".
2929

3030
Attempting to use a non-conforming string in places where filter selector

pulls/2304/_sources/api_reference/dpctl_cmake.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
CMake support
44
=============
55

6-
:py:mod:`dpctl` comes with the configuration file `dpctl-config.cmake` which is installed
6+
:py:mod:`dpctl` comes with the configuration file :file:`dpctl-config.cmake` which is installed
77
on the `standard search path CMake uses to search for packages <cmake_find_package_search_paths_>`_.
88

99
To build your extension that leverages :py:mod:`dpctl`, include the following line in your CMake script:

pulls/2304/_sources/beginners_guides/installation.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ AMD build
211211
212212
python scripts/build_locally.py --verbose --target-hip=<arch>
213213
214-
Note that the `oneAPI for AMD GPUs` plugin requires the architecture be specified and only
214+
Note that the oneAPI for AMD GPUs plugin requires the architecture be specified and only
215215
one architecture can be specified at a time.
216216

217217
To determine the architecture code (``<arch>``) for your AMD GPU, run:

pulls/2304/_sources/beginners_guides/managing_devices.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ For Intel GPU devices, additional architectural information can be access with :
310310
311311
In [2]: d_gpu = dpctl.SyclDevice()
312312
313-
# Output for Iris Xe integerate GPU, with PCI ID 0x9a49
313+
# Output for Iris Xe integrate GPU, with PCI ID 0x9a49
314314
# (corresponding decimal value: 39497)
315315
In [3]: dpctl.utils.intel_device_info(d_gpu)
316316
Out[3]:

pulls/2304/_sources/contributor_guides/building.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ library.
209209
pushd build || exit 1
210210
211211
INSTALL_PREFIX=$(pwd)/../install
212-
rm -rf ${INSTALL_PREFIX}
212+
rm -rf "${INSTALL_PREFIX}"
213213
export ONEAPI_ROOT=/opt/intel/oneapi
214214
# Values are set as appropriate for oneAPI DPC++ 2024.0
215215
# or later.

pulls/2304/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Intel(R) oneAPI :dpcpp_compiler:`DPC++ compiler <>`.
5656

5757
Access API Reference
5858

59-
.. grid-item-card:: Contibutor Guides
59+
.. grid-item-card:: Contributor Guides
6060

6161
The contributing guidelines will suggest a process of
6262
contributing to :mod:`dpctl`.

pulls/2304/_sources/user_guides/basic_concepts.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ backend. The context is required to map unified address space pointer to the dev
111111
where it was allocated unambiguously.
112112

113113
In order for two DPC++-based Python extensions to share USM allocations, they each
114-
must use the `same` SYCL context when submitting for execution programs that would
114+
must use the *same* SYCL context when submitting for execution programs that would
115115
access this allocation.
116116

117117
Since ``sycl::context`` is dynamically constructed by each extension sharing a USM allocation,

pulls/2304/api_reference/dpctl/filter_selector_string.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@
598598
<p><code class="docutils literal notranslate"><span class="pre">Backend</span></code> specifies the desired backend of targeted devices, while
599599
<code class="docutils literal notranslate"><span class="pre">DeviceType</span></code> specifies the type of targeted devices.
600600
<code class="docutils literal notranslate"><span class="pre">RelativeDeviceNumber</span></code> refers to the number of the device that matches
601-
any other given requirements, starting from <cite>0</cite> to marking the
601+
any other given requirements, starting from 0 to marking the
602602
“first device that matches the requirements”.</p>
603603
<p>Attempting to use a non-conforming string in places where filter selector
604604
string is expected will raise an exception.</p>

pulls/2304/api_reference/dpctl/generated/generated/dpctl.SyclDevice.create_sub_devices.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@
584584
<h1>dpctl.SyclDevice.create_sub_devices<a class="headerlink" href="#dpctl-sycldevice-create-sub-devices" title="Permalink to this heading"></a></h1>
585585
<dl class="py method">
586586
<dt class="sig sig-object py" id="dpctl.SyclDevice.create_sub_devices">
587-
<span class="sig-prename descclassname"><span class="pre">SyclDevice.</span></span><span class="sig-name descname"><span class="pre">create_sub_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">partition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">parition_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclDevice.create_sub_devices" title="Permalink to this definition"></a></dt>
587+
<span class="sig-prename descclassname"><span class="pre">SyclDevice.</span></span><span class="sig-name descname"><span class="pre">create_sub_devices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">partition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">partition_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.SyclDevice.create_sub_devices" title="Permalink to this definition"></a></dt>
588588
<dd><p>Creates a list of sub-devices by partitioning a root device based on the
589589
provided partition specifier.</p>
590590
<p>A partition specifier must be provided using a <code class="docutils literal notranslate"><span class="pre">partition</span></code>

pulls/2304/api_reference/dpctl_cmake.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@
582582
<article role="main" id="furo-main-content">
583583
<section id="cmake-support">
584584
<span id="dpctl-cmake-support"></span><h1>CMake support<a class="headerlink" href="#cmake-support" title="Permalink to this heading"></a></h1>
585-
<p><a class="reference internal" href="dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> comes with the configuration file <cite>dpctl-config.cmake</cite> which is installed
585+
<p><a class="reference internal" href="dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> comes with the configuration file <code class="file docutils literal notranslate"><span class="pre">dpctl-config.cmake</span></code> which is installed
586586
on the <a class="reference external" href="https://cmake.org/cmake/help/latest/command/find_package.html">standard search path CMake uses to search for packages</a>.</p>
587587
<p>To build your extension that leverages <a class="reference internal" href="dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a>, include the following line in your CMake script:</p>
588588
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nb">find_package</span><span class="p">(</span><span class="s2">&quot;Dpctl&quot;</span><span class="w"> </span><span class="s">REQUIRED</span><span class="p">)</span>

0 commit comments

Comments
 (0)