Skip to content

Commit 8ad3e1c

Browse files
Fix docstring for SyclTimer (#824)
* Fix docstring for SyclTimer * Expanded remark in SyclTimer docstring
1 parent 2abb03c commit 8ad3e1c

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

dpctl/_sycl_timer.py

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,19 @@ class SyclTimer:
4646
sycl_dt, wall_dt = timer.dt
4747
4848
Remark:
49-
The timer synchronizes the queue at the entrance and the
50-
exit of the context.
49+
The timer submits barriers to the queue at the entrance and the
50+
exit of the context and uses profiling information from events
51+
associated with these submissions to perform the timing. Thus
52+
:class:`dpctl.SyclTimer` requires the queue with "enable_profiling"
53+
property. In order to be able to collect the profiling information
54+
the property `dt` ensures that both submitted barriers complete
55+
their execution and thus effectively synchronizing the queue.
5156
5257
Args:
53-
host_timer (callable): A callable such that host_timer() returns current
54-
host time in seconds.
55-
time_scale (int, float): Ratio of the unit of time of interest and
56-
one second.
58+
host_timer (callable): A callable such that host_timer() returns current
59+
host time in seconds.
60+
time_scale (int, float): Ratio of the unit of time of interest and
61+
one second.
5762
"""
5863

5964
def __init__(self, host_timer=timeit.default_timer, time_scale=1):

0 commit comments

Comments
 (0)