Skip to content
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.

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

Doc fixes #2471

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion ignite/handlers/timing.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ class Timer:
Note:
When using ``Timer(average=True)`` do not forget to call ``timer.step()`` every time an event occurs. See
the examples below.

Note:
Timer if attached to measure single epoch time, it can also record the time of all handlers attached prior to Timer. To obtain the actual time taken for the epoch completion, handlers will have to be rearranged.
Copy link
Collaborator

@vfdev-5 vfdev-5 May 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Timer if attached to measure single epoch time, it can also record the time of all handlers attached prior to Timer. To obtain the actual time taken for the epoch completion, handlers will have to be rearranged.
If ``Timer`` is attached to measure single epoch time, it can also record the time of all handlers attached prior to it. To obtain the actual time taken for the epoch completion, handlers have to be rearranged.

Examples:
Measuring total time of the epoch:

Expand Down