Skip to content

Commit 2604713

Browse files
author
Diptorup Deb
committed
Fixes to the platforms rst file.
1 parent dc7d3a3 commit 2604713

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

docs/docfiles/urls.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
.. _Section 4.6: https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes
77
.. _SYCL 2020 spec: https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html
8-
.. _sycl platform: https://sycl.readthedocs.io/en/latest/iface/platform.html
8+
.. _sycl::platform: https://sycl.readthedocs.io/en/latest/iface/platform.html
99
.. _sycl device: https://sycl.readthedocs.io/en/latest/iface/device.html
1010
.. _sycl queue: https://sycl.readthedocs.io/en/latest/iface/queue.html
1111
.. _sycl event: https://sycl.readthedocs.io/en/latest/iface/event.html

docs/docfiles/user_guides/manual/platforms.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@
44
Platform
55
########
66

7-
A platform abstracts one or more XPU that is connected to the host and that can
8-
be used for computation. The platforms queryable using dpctl depends on the
9-
device drivers that are installed on a system. A single driver may control
10-
multiple physical XPU, thus a platform may also consist of multiple XPUs.
11-
127
In dpctl, the class :class:`dpctl.SyclPlatform` represents a platform and
13-
abstracts the `sycl platform`_ SYCL runtime class.
8+
abstracts the `sycl::platform`_ SYCL runtime class. A platform abstracts one or
9+
more XPU that is connected to the host and that can be used for computation. The
10+
platforms queryable using dpctl depends on the device drivers that are installed
11+
on a system. A single driver may control multiple physical XPU, thus a platform
12+
may also consist of multiple XPUs.
1413

1514
The platforms available on a system can be queried using the
1615
:func:`dpctl.lsplatform` function. In addition, as illustrated in the following
1716
example it is possible to print out metadata about a platform.
1817

1918
.. literalinclude:: ../../../../examples/python/lsplatform.py
2019
:language: python
21-
:start-after: #START
22-
:end-before: #END
20+
:start-after: # START
21+
:end-before: # END
2322

2423
The example is can be executed as follows:
2524

@@ -35,4 +34,4 @@ The possible output for the example may be:
3534
The verbosity for the output can be controlled using the ``verbosity``
3635
keyword argument. Refer :func:`dpctl.lsplatform`.
3736

38-
.. include:: ../../../urls.rst
37+
.. include:: ../../urls.rst

0 commit comments

Comments
 (0)