Skip to content

Commit 98dbca2

Browse files
author
Diptorup Deb
committed
Add a stub for queues to the user manual.
1 parent 0e59572 commit 98dbca2

File tree

4 files changed

+25
-4
lines changed

4 files changed

+25
-4
lines changed

docs/docfiles/user_guides/UserManual.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
User Manual
55
###########
66

7+
Table of contents
8+
+++++++++++++++++
9+
710
.. toctree::
811
:maxdepth: 3
912

docs/docfiles/user_guides/manual/dpctl/intro.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,12 @@ The user guide introduces the core features of dpctl and the underlying
2626
concepts. The guide is meant primarily for users of the Python package. Library
2727
and native extension developers should refer to the programmer's guide.
2828

29-
Table of contents
30-
+++++++++++++++++
31-
3229
.. toctree::
3330
:maxdepth: 2
31+
:caption: Table of Contents
3432

3533
basic_concepts
3634
device_selection
3735
platforms
3836
devices
37+
queues

docs/docfiles/user_guides/manual/dpctl/platforms.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _querying_platforms:
1+
.. _platforms:
22

33
########
44
Platform
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _queues:
2+
3+
#####
4+
Queue
5+
#####
6+
7+
A queue is used to specify a device and a specific set of features of that
8+
device on which a task is scheduled. The :class:`dpctl.SyclQueue` class
9+
represents a queue and abstracts the :sycl_queue:`sycl::queue <>` SYCL runtime
10+
class.
11+
12+
Types of Queues
13+
---------------
14+
15+
Creating a New Queue
16+
--------------------
17+
18+
Profiling a Task Submitted to a Queue
19+
-------------------------------------

0 commit comments

Comments
 (0)