diff --git a/dpctl/_sycl_timer.py b/dpctl/_sycl_timer.py index ac3e3814dd..05098bd837 100644 --- a/dpctl/_sycl_timer.py +++ b/dpctl/_sycl_timer.py @@ -46,14 +46,19 @@ class SyclTimer: sycl_dt, wall_dt = timer.dt Remark: - The timer synchronizes the queue at the entrance and the - exit of the context. + The timer submits barriers to the queue at the entrance and the + exit of the context and uses profiling information from events + associated with these submissions to perform the timing. Thus + :class:`dpctl.SyclTimer` requires the queue with "enable_profiling" + property. In order to be able to collect the profiling information + the property `dt` ensures that both submitted barriers complete + their execution and thus effectively synchronizing the queue. Args: - host_timer (callable): A callable such that host_timer() returns current - host time in seconds. - time_scale (int, float): Ratio of the unit of time of interest and - one second. + host_timer (callable): A callable such that host_timer() returns current + host time in seconds. + time_scale (int, float): Ratio of the unit of time of interest and + one second. """ def __init__(self, host_timer=timeit.default_timer, time_scale=1):