Skip to content

Use Note in SyclTimer docstring #1596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 18, 2024
Merged

Use Note in SyclTimer docstring #1596

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b5754d
Use Note in SyclTimer docstring
oleksandr-pavlyk Mar 18, 2024
335b9f0
Fixed sentence structure per PR review
oleksandr-pavlyk Mar 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions dpctl/_sycl_timer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@ class SyclTimer:
# retrieve elapsed times in milliseconds
wall_dt, device_dt = timer.dt

Remark:
Note:
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.
property. In order to be able to collect the profiling information,
the `dt` property ensures that both submitted barriers complete their
execution and thus effectively synchronizes the queue.

Args:
host_timer (callable): A callable such that host_timer() returns current
Expand Down