Skip to content

Add ModelCheckpoint documentation example #2629

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 4 commits into from
Jul 23, 2022
Merged

Add ModelCheckpoint documentation example #2629

merged 4 commits into from
Jul 23, 2022

Conversation

haochunchang
Copy link
Contributor

Fixes #2622

Description:

  • Add "See Example of Checkpoint" in the score_name of ModelCheckpoint.
  • Change example from code block to actual test code (doctest).

Check list:

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

Comments:

  1. This is my first contribution to ignite, hopefully this PR can help newcomers to know how to use ModelCheckpoint more quickly.
  2. I think the description of ModelCheckpoint handler can mention it is inherited from Checkpoint with convenient DiskSaver and last_checkpoint to use (if my understanding is correct).

@github-actions github-actions bot added the module: handlers Core Handlers module label Jul 21, 2022
@haochunchang haochunchang changed the title Add Model checkpoint documentation example Add ModelCheckpoint documentation example Jul 21, 2022
vfdev-5
vfdev-5 reviewed Jul 21, 2022
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @haochunchang , lgtm !

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Jul 21, 2022

I think the description of ModelCheckpoint handler can mention it is inherited from Checkpoint with convenient DiskSaver and last_checkpoint to use (if my understanding is correct).

Yes, we should mention that if it helps to understand better the API. Thanks!
If you would like to update the PR with this suggestion, feel free

@haochunchang
Copy link
Contributor Author

If you would like to update the PR with this suggestion, feel free

Thanks! I would like to update the PR to let us iterate on it.

@haochunchang haochunchang force-pushed the model-checkpoint-doc-example branch from d1fce1b to 4e04c15 Compare July 23, 2022 03:06
@haochunchang haochunchang requested a review from vfdev-5 July 23, 2022 03:16
vfdev-5
vfdev-5 reviewed Jul 23, 2022
View reviewed changes
vfdev-5
vfdev-5 approved these changes Jul 23, 2022
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Lgtm, thanks @haochunchang

@vfdev-5 vfdev-5 enabled auto-merge (squash) July 23, 2022 08:43
@vfdev-5 vfdev-5 merged commit e911138 into pytorch:master Jul 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vfdev-5 vfdev-5 vfdev-5 approved these changes

Assignees
No one assigned
Labels
module: handlers Core Handlers module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Cannot find ModelCheckpoint score name notes
2 participants
@haochunchang @vfdev-5