Skip to content

Commit a117f0b

Browse files
author
github-actions[doc-deploy-bot]
committed
Docs for pull request 2281
1 parent 8e62b21 commit a117f0b

File tree

545 files changed

+189719
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

545 files changed

+189719
-0
lines changed

pulls/2281/_modules/dpctl.html

Lines changed: 758 additions & 0 deletions
Large diffs are not rendered by default.

pulls/2281/_modules/dpctl/_device_selection.html

Lines changed: 711 additions & 0 deletions
Large diffs are not rendered by default.

pulls/2281/_modules/dpctl/_sycl_timer.html

Lines changed: 899 additions & 0 deletions
Large diffs are not rendered by default.

pulls/2281/_modules/dpctl/enum_types.html

Lines changed: 749 additions & 0 deletions
Large diffs are not rendered by default.

pulls/2281/_modules/dpctl/utils/_intel_device_info.html

Lines changed: 726 additions & 0 deletions
Large diffs are not rendered by default.

pulls/2281/_modules/dpctl/utils/_onetrace_context.html

Lines changed: 703 additions & 0 deletions
Large diffs are not rendered by default.

pulls/2281/_modules/index.html

Lines changed: 627 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _dpctl_constants:
2+
3+
Constants
4+
=========
5+
6+
The following constants are defined in :py:mod:`dpctl`:
7+
8+
.. currentmodule:: dpctl
9+
10+
.. autodata:: device_type
11+
12+
.. autodata:: backend_type
13+
14+
.. autodata:: event_status_type
15+
16+
.. autodata:: global_mem_cache_type
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.. _filter_selector_string:
2+
3+
Filter Selector String
4+
======================
5+
6+
Filter selector string is a way to refer to unpartitioned SYCL devices
7+
proposed in :oneapi_filter_selection:`sycl_ext_oneapi_filter_selector <>`
8+
extension to SYCL standard.
9+
10+
This document captures aspects of the referenced document relevant
11+
to :mod:`dpctl`.
12+
13+
A filter selector string defines one or more filters, which must be
14+
separated using ``","`` character. A filter is specified as a
15+
triple of the form:
16+
17+
.. code-block:: text
18+
19+
Backend:DeviceType:RelativeDeviceNumber
20+
21+
Every element of the triple is optional, but a filter must contain at
22+
least one component.
23+
24+
``Backend`` specifies the desired backend of targeted devices, while
25+
``DeviceType`` specifies the type of targeted devices.
26+
``RelativeDeviceNumber`` refers to the number of the device that matches
27+
any other given requirements, starting from `0` to marking the
28+
"first device that matches the requirements".
29+
30+
Attempting to use a non-conforming string in places where filter selector
31+
string is expected will raise an exception.
32+
33+
Supported values for ``Backend`` are:
34+
35+
.. list-table::
36+
37+
* - cuda
38+
- opencl
39+
- level_zero
40+
- hip
41+
42+
Supported values for ``DeviceType`` are:
43+
44+
.. list-table::
45+
46+
* - accelerator
47+
- cpu
48+
- gpu
49+
50+
Filter selector strings can be used as arguments to constructors of
51+
:py:class:`dpctl.SyclDevice`, :py:class:`dpctl.SyclContext`,
52+
:py:class:`dpctl.SyclPlatform`, or :py:class:`dpctl.SyclQueue`
53+
classes.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
dpctl.SyclContext
2+
=================
3+
4+
.. currentmodule:: dpctl
5+
6+
.. autoclass:: SyclContext
7+
8+
9+
10+
.. rubric:: Methods
11+
12+
.. autosummary::
13+
:toctree: generated
14+
15+
~SyclContext.addressof_ref
16+
~SyclContext.get_devices
17+
18+
19+
20+
21+
22+
.. rubric:: Attributes
23+
24+
.. autosummary::
25+
:toctree: generated
26+
27+
~SyclContext.device_count
28+
29+

0 commit comments

Comments
 (0)