Skip to content

Commit 77ff4ab

Browse files
author
Diptorup Deb
authored
Updates to API docs prior to 0.8.0 release. (#473)
1 parent 414f0a6 commit 77ff4ab

File tree

9 files changed

+126
-28
lines changed

9 files changed

+126
-28
lines changed

‎docs/docfiles/dpctl_pyapi/SyclContext.rst‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,20 @@ dpctl.SyclContext
2424
Detail
2525
======
2626

27+
Attributes
28+
----------
29+
30+
.. autoattribute:: dpctl.SyclContext.device_count
31+
32+
2733
Private methods
2834
---------------
2935

30-
.. autoclassmembers:: dpctl.SyclContext
31-
:noindex:
32-
:private-members: _get_capsule
36+
.. autofunction:: dpctl.SyclContext._get_capsule
3337

3438

3539
Public methods
3640
--------------
3741

38-
.. autoclassmembers:: dpctl.SyclContext
39-
:noindex:
40-
:members:
41-
:undoc-members:
42+
.. autofunction:: dpctl.SyclContext.addressof_ref
43+
.. autofunction:: dpctl.SyclContext.get_devices

‎docs/docfiles/dpctl_pyapi/SyclDevice.rst‎

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,64 @@ dpctl.SyclDevice
1919
Detail
2020
======
2121

22+
Attributes
23+
----------
24+
25+
.. autoattribute:: dpctl.SyclDevice.backend
26+
.. autoattribute:: dpctl.SyclDevice.default_selector_score
27+
.. autoattribute:: dpctl.SyclDevice.device_type
28+
.. autoattribute:: dpctl.SyclDevice.driver_version
29+
.. autoattribute:: dpctl.SyclDevice.filter_string
30+
.. autoattribute:: dpctl.SyclDevice.has_aspect_accelerator
31+
.. autoattribute:: dpctl.SyclDevice.has_aspect_cpu
32+
.. autoattribute:: dpctl.SyclDevice.has_aspect_custom
33+
.. autoattribute:: dpctl.SyclDevice.has_aspect_fp16
34+
.. autoattribute:: dpctl.SyclDevice.has_aspect_fp64
35+
.. autoattribute:: dpctl.SyclDevice.has_aspect_gpu
36+
.. autoattribute:: dpctl.SyclDevice.has_aspect_host
37+
.. autoattribute:: dpctl.SyclDevice.has_aspect_image
38+
.. autoattribute:: dpctl.SyclDevice.has_aspect_int64_base_atomics
39+
.. autoattribute:: dpctl.SyclDevice.has_aspect_int64_extended_atomics
40+
.. autoattribute:: dpctl.SyclDevice.has_aspect_online_compiler
41+
.. autoattribute:: dpctl.SyclDevice.has_aspect_online_linker
42+
.. autoattribute:: dpctl.SyclDevice.has_aspect_queue_profiling
43+
.. autoattribute:: dpctl.SyclDevice.has_aspect_usm_device_allocations
44+
.. autoattribute:: dpctl.SyclDevice.has_aspect_usm_host_allocations
45+
.. autoattribute:: dpctl.SyclDevice.has_aspect_usm_restricted_shared_allocations
46+
.. autoattribute:: dpctl.SyclDevice.has_aspect_usm_shared_allocations
47+
.. autoattribute:: dpctl.SyclDevice.has_aspect_usm_system_allocator
48+
.. autoattribute:: dpctl.SyclDevice.image_2d_max_height
49+
.. autoattribute:: dpctl.SyclDevice.image_2d_max_width
50+
.. autoattribute:: dpctl.SyclDevice.image_3d_max_depth
51+
.. autoattribute:: dpctl.SyclDevice.image_3d_max_height
52+
.. autoattribute:: dpctl.SyclDevice.image_3d_max_width
53+
.. autoattribute:: dpctl.SyclDevice.is_accelerator
54+
.. autoattribute:: dpctl.SyclDevice.is_cpu
55+
.. autoattribute:: dpctl.SyclDevice.is_gpu
56+
.. autoattribute:: dpctl.SyclDevice.is_host
57+
.. autoattribute:: dpctl.SyclDevice.max_compute_units
58+
.. autoattribute:: dpctl.SyclDevice.max_num_sub_groups
59+
.. autoattribute:: dpctl.SyclDevice.max_read_image_args
60+
.. autoattribute:: dpctl.SyclDevice.max_work_group_size
61+
.. autoattribute:: dpctl.SyclDevice.max_work_item_dims
62+
.. autoattribute:: dpctl.SyclDevice.max_work_item_sizes
63+
.. autoattribute:: dpctl.SyclDevice.max_write_image_args
64+
.. autoattribute:: dpctl.SyclDevice.name
65+
.. autoattribute:: dpctl.SyclDevice.parent_device
66+
.. autoattribute:: dpctl.SyclDevice.preferred_vector_width_char
67+
.. autoattribute:: dpctl.SyclDevice.preferred_vector_width_double
68+
.. autoattribute:: dpctl.SyclDevice.preferred_vector_width_float
69+
.. autoattribute:: dpctl.SyclDevice.preferred_vector_width_half
70+
.. autoattribute:: dpctl.SyclDevice.preferred_vector_width_int
71+
.. autoattribute:: dpctl.SyclDevice.preferred_vector_width_long
72+
.. autoattribute:: dpctl.SyclDevice.preferred_vector_width_short
73+
.. autoattribute:: dpctl.SyclDevice.sub_group_independent_forward_progress
74+
.. autoattribute:: dpctl.SyclDevice.vendor
75+
2276
Public methods
2377
--------------
2478

25-
.. autoclassmembers:: dpctl.SyclDevice
26-
:noindex:
27-
:members:
28-
:undoc-members:
79+
.. autofunction:: dpctl.SyclDevice.addressof_ref
80+
.. autofunction:: dpctl.SyclDevice.create_sub_devices
81+
.. autofunction:: dpctl.SyclDevice.get_filter_string
82+
.. autofunction:: dpctl.SyclDevice.print_device_info

‎docs/docfiles/dpctl_pyapi/SyclEvent.rst‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ dpctl.SyclEvent
55
###############
66

77
.. autoclass:: dpctl.SyclEvent
8-
:members:
9-
:inherited-members:
10-
:undoc-members:
8+
9+
.. rubric:: Public methods:
10+
11+
.. autoautosummary:: dpctl.SyclEvent
12+
:methods:
13+
14+
15+
Detail
16+
======
17+
18+
.. autofunction:: dpctl.SyclEvent.addressof_ref
19+
.. autofunction:: dpctl.SyclEvent.wait

‎docs/docfiles/dpctl_pyapi/SyclPlatform.rst‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,33 @@ dpctl.SyclPlatform
77

88
.. autoclass:: dpctl.SyclPlatform
99

10+
.. rubric:: Attributes:
11+
12+
.. autoautosummary:: dpctl.SyclPlatform
13+
:attributes:
14+
15+
.. rubric:: Private methods:
16+
17+
.. autoautosummary:: dpctl.SyclPlatform
18+
:private_methods:
19+
20+
.. rubric:: Public methods:
21+
22+
.. autoautosummary:: dpctl.SyclPlatform
23+
:methods:
1024

1125
Detail
1226
======
1327

28+
Attributes
29+
----------
30+
31+
.. autoattribute:: dpctl.SyclPlatform.backend
32+
.. autoattribute:: dpctl.SyclPlatform.name
33+
.. autoattribute:: dpctl.SyclPlatform.vendor
34+
.. autoattribute:: dpctl.SyclPlatform.version
35+
1436
Public methods
1537
--------------
1638

17-
.. autoclassmembers:: dpctl.SyclPlatform
18-
:noindex:
19-
:members:
20-
:undoc-members:
39+
.. autofunction:: dpctl.SyclPlatform.print_platform_info

‎docs/docfiles/dpctl_pyapi/SyclQueue.rst‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,28 @@ dpctl.SyclQueue
2424
Detail
2525
======
2626

27+
Attributes
28+
----------
29+
30+
.. autoattribute:: dpctl.SyclQueue.is_in_order
31+
.. autoattribute:: dpctl.SyclQueue.sycl_context
32+
.. autoattribute:: dpctl.SyclQueue.sycl_device
33+
2734
Private methods
2835
---------------
2936

30-
.. autoclassmembers:: dpctl.SyclQueue
31-
:noindex:
32-
:private-members: _get_capsule
33-
:undoc-members:
37+
.. autofunction:: dpctl.SyclQueue._get_capsule
38+
3439

3540
Public methods
3641
--------------
3742

38-
.. autoclassmembers:: dpctl.SyclQueue
39-
:noindex:
40-
:members:
41-
:undoc-members:
43+
.. autofunction:: dpctl.SyclQueue.addressof_ref
44+
.. autofunction:: dpctl.SyclQueue.get_sycl_backend
45+
.. autofunction:: dpctl.SyclQueue.get_sycl_context
46+
.. autofunction:: dpctl.SyclQueue.get_sycl_device
47+
.. autofunction:: dpctl.SyclQueue.mem_advise
48+
.. autofunction:: dpctl.SyclQueue.memcpy
49+
.. autofunction:: dpctl.SyclQueue.prefetch
50+
.. autofunction:: dpctl.SyclQueue.submit
51+
.. autofunction:: dpctl.SyclQueue.wait

‎dpctl/_sycl_context.pyx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ cdef class _SyclContext:
7676

7777
cdef class SyclContext(_SyclContext):
7878
"""
79+
SyclContext(arg=None)
7980
Python class representing ``cl::sycl::context``. There are multiple
8081
ways to create a :class:`dpctl.SyclContext` object:
8182

‎dpctl/_sycl_device.pyx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,8 @@ cdef str _device_type_to_filter_string_part(_device_type DTy):
163163

164164

165165
cdef class SyclDevice(_SyclDevice):
166-
""" Python equivalent for cl::sycl::device class.
166+
""" SyclDevice(arg=None)
167+
Python equivalent for cl::sycl::device class.
167168
168169
There are two ways of creating a SyclDevice instance:
169170

‎dpctl/_sycl_platform.pyx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ cdef class _SyclPlatform:
6868

6969

7070
cdef class SyclPlatform(_SyclPlatform):
71-
""" Python class representing ``cl::sycl::platform`` class.
71+
""" SyclPlatform(self, arg=None)
72+
Python class representing ``cl::sycl::platform`` class.
7273
7374
SyclPlatform() - create platform selected by sycl::default_selector
7475
SyclPlatform(filter_selector) - create platform selected by filter

‎dpctl/_sycl_queue.pyx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ cdef class _SyclQueue:
170170

171171
cdef class SyclQueue(_SyclQueue):
172172
"""
173+
SyclQueue(*args, **kwargs)
173174
Python class representing ``cl::sycl::queue``. There are multiple
174175
ways to create a :class:`dpctl.SyclQueue` object:
175176

0 commit comments

Comments
 (0)