Skip to content

Updated doctests for Engine.interrupt() and Engine.terminate() #2688

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

Jump to bottom
Merged
merged 3 commits into from
Sep 2, 2022
Merged

Updated doctests for Engine.interrupt() and Engine.terminate() #2688

merged 3 commits into from
Sep 2, 2022

Conversation

vfdev-5
Copy link
Collaborator

@vfdev-5 vfdev-5 commented Sep 2, 2022 •
edited
Loading

Description:

  • Updated doctests for Engine.interrupt() and Engine.terminate()
  • Fixed doctest warning in ignite/handlers/state_param_scheduler.py

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 docs module: engine Engine module labels Sep 2, 2022
@vfdev-5 vfdev-5 changed the title Updated docstring for Engine.interrupt() Updated doctests for Engine.interrupt() and Engine.terminate() Sep 2, 2022
vfdev-5
vfdev-5 commented Sep 2, 2022
View reviewed changes
ignite/handlers/state_param_scheduler.py
param_scheduler = MultiStepStateScheduler(
param_name="param", initial_value=1, gamma=0.9, milestones=[3, 6, 9, 12]
param_name="param", initial_value=1, gamma=0.9, milestones=[3, 6, 9, 12], create_new=True
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed warning in doctest

@vfdev-5 vfdev-5 merged commit c12ad57 into pytorch:master Sep 2, 2022
@vfdev-5 vfdev-5 deleted the update-docs-engine-interrupt branch September 2, 2022 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs module: engine Engine module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@vfdev-5