Skip to content

Commit 22f39d8

Browse files
Expanded remark in SyclTimer docstring
1 parent a1cf19b commit 22f39d8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

dpctl/_sycl_timer.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,13 @@ 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:
5358
host_timer (callable): A callable such that host_timer() returns current

0 commit comments

Comments
 (0)