Skip to content

Commit 286e2dd

Browse files
author
github-actions[doc-deploy-bot]
committed
Docs backfilled for 0.22.0.
1 parent 590f8d9 commit 286e2dd

543 files changed

Lines changed: 188117 additions & 0 deletions

File tree

Some content is hidden

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

0.22.0/_modules/dpctl.html

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

0.22.0/_modules/dpctl/_device_selection.html

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

0.22.0/_modules/dpctl/enum_types.html

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

0.22.0/_modules/dpctl/utils/_intel_device_info.html

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

0.22.0/_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+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
dpctl.SyclContextCreationError
2+
==============================
3+
4+
.. currentmodule:: dpctl
5+
6+
.. autoexception:: SyclContextCreationError
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
dpctl.SyclDevice
2+
================
3+
4+
.. currentmodule:: dpctl
5+
6+
.. autoclass:: SyclDevice
7+
8+
9+
10+
.. rubric:: Methods
11+
12+
.. autosummary::
13+
:toctree: generated
14+
15+
~SyclDevice.addressof_ref
16+
~SyclDevice.can_access_peer
17+
~SyclDevice.component_devices
18+
~SyclDevice.create_sub_devices
19+
~SyclDevice.disable_peer_access
20+
~SyclDevice.enable_peer_access
21+
~SyclDevice.get_device_id
22+
~SyclDevice.get_filter_string
23+
~SyclDevice.get_unpartitioned_parent_device
24+
~SyclDevice.print_device_info
25+
26+
27+
28+
29+
30+
.. rubric:: Attributes
31+
32+
.. autosummary::
33+
:toctree: generated
34+
35+
~SyclDevice.backend
36+
~SyclDevice.composite_device
37+
~SyclDevice.default_selector_score
38+
~SyclDevice.device_type
39+
~SyclDevice.driver_version
40+
~SyclDevice.filter_string
41+
~SyclDevice.global_mem_cache_line_size
42+
~SyclDevice.global_mem_cache_size
43+
~SyclDevice.global_mem_cache_type
44+
~SyclDevice.global_mem_size
45+
~SyclDevice.has_aspect_accelerator
46+
~SyclDevice.has_aspect_atomic64
47+
~SyclDevice.has_aspect_cpu
48+
~SyclDevice.has_aspect_custom
49+
~SyclDevice.has_aspect_emulated
50+
~SyclDevice.has_aspect_fp16
51+
~SyclDevice.has_aspect_fp64
52+
~SyclDevice.has_aspect_gpu
53+
~SyclDevice.has_aspect_host_debuggable
54+
~SyclDevice.has_aspect_image
55+
~SyclDevice.has_aspect_is_component
56+
~SyclDevice.has_aspect_is_composite
57+
~SyclDevice.has_aspect_online_compiler
58+
~SyclDevice.has_aspect_online_linker
59+
~SyclDevice.has_aspect_queue_profiling
60+
~SyclDevice.has_aspect_usm_atomic_host_allocations
61+
~SyclDevice.has_aspect_usm_atomic_shared_allocations
62+
~SyclDevice.has_aspect_usm_device_allocations
63+
~SyclDevice.has_aspect_usm_host_allocations
64+
~SyclDevice.has_aspect_usm_shared_allocations
65+
~SyclDevice.has_aspect_usm_system_allocations
66+
~SyclDevice.image_2d_max_height
67+
~SyclDevice.image_2d_max_width
68+
~SyclDevice.image_3d_max_depth
69+
~SyclDevice.image_3d_max_height
70+
~SyclDevice.image_3d_max_width
71+
~SyclDevice.is_accelerator
72+
~SyclDevice.is_cpu
73+
~SyclDevice.is_gpu
74+
~SyclDevice.local_mem_size
75+
~SyclDevice.max_clock_frequency
76+
~SyclDevice.max_compute_units
77+
~SyclDevice.max_mem_alloc_size
78+
~SyclDevice.max_num_sub_groups
79+
~SyclDevice.max_read_image_args
80+
~SyclDevice.max_work_group_size
81+
~SyclDevice.max_work_item_dims
82+
~SyclDevice.max_work_item_sizes
83+
~SyclDevice.max_work_item_sizes1d
84+
~SyclDevice.max_work_item_sizes2d
85+
~SyclDevice.max_work_item_sizes3d
86+
~SyclDevice.max_write_image_args
87+
~SyclDevice.name
88+
~SyclDevice.native_vector_width_char
89+
~SyclDevice.native_vector_width_double
90+
~SyclDevice.native_vector_width_float
91+
~SyclDevice.native_vector_width_half
92+
~SyclDevice.native_vector_width_int
93+
~SyclDevice.native_vector_width_long
94+
~SyclDevice.native_vector_width_short
95+
~SyclDevice.parent_device
96+
~SyclDevice.partition_max_sub_devices
97+
~SyclDevice.preferred_vector_width_char
98+
~SyclDevice.preferred_vector_width_double
99+
~SyclDevice.preferred_vector_width_float
100+
~SyclDevice.preferred_vector_width_half
101+
~SyclDevice.preferred_vector_width_int
102+
~SyclDevice.preferred_vector_width_long
103+
~SyclDevice.preferred_vector_width_short
104+
~SyclDevice.profiling_timer_resolution
105+
~SyclDevice.sub_group_independent_forward_progress
106+
~SyclDevice.sub_group_sizes
107+
~SyclDevice.sycl_platform
108+
~SyclDevice.vendor
109+
110+

0 commit comments

Comments
 (0)