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

Doc fixes #2471

wants to merge 2 commits into from

Conversation

FarehaNousheen
Copy link
Contributor

@FarehaNousheen FarehaNousheen commented Feb 16, 2022

Fixes #2157

Description:

Check list:

  • New tests are added (if a new feature is added)
  • New doc strings: description and/or example code are in RST format
  • Documentation is updated (if required)

@github-actions github-actions bot added the module: handlers Core Handlers module label Feb 16, 2022
@vfdev-5
Copy link
Collaborator

vfdev-5 commented May 2, 2022

@FarehaNousheen can you reformat the code using: run_code_style.bat fmt ?

@@ -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.

@FarehaNousheen
Copy link
Contributor Author

FarehaNousheen commented May 3, 2022 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: handlers Core Handlers module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Timer's misleading behaviour when epoch completion time calculated
2 participants