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

Merged
vfdev-5 merged 4 commits into from
Jul 23, 2022
Merged

Add ModelCheckpoint documentation example #2629

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0d0570f
Add see examples in checkpoint
haochunchang Jul 21, 2022
4e04c15
Change example to testcode
haochunchang Jul 21, 2022
1c3e406
Mention Checkpoint and last_checkpoint in ModelCheckpoint description
haochunchang Jul 23, 2022
2d7c3d1
Update ignite/handlers/checkpoint.py
vfdev-5 Jul 23, 2022
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
21 changes: 13 additions & 8 deletions ignite/handlers/checkpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,8 +850,10 @@ def remove(self, filename: str) -> None:


class ModelCheckpoint(Checkpoint):
"""ModelCheckpoint handler can be used to periodically save objects to disk only. If needed to store checkpoints to
"""ModelCheckpoint handler is a :class:`~ignite.handlers.checkpoint.Checkpoint` handler that can be used
to periodically save objects to disk only. If needed to store checkpoints to
another storage type, please consider :class:`~ignite.handlers.checkpoint.Checkpoint`.
It also provides `last_checkpoint` attribute to show the last saved checkpoint.

This handler expects two arguments:

Expand Down Expand Up @@ -879,7 +881,7 @@ class ModelCheckpoint(Checkpoint):
:class:`~ignite.engine.engine.Engine` object, and return a score (`float`). Objects with highest scores
will be retained.
score_name: if ``score_function`` not None, it is possible to store its value using
`score_name`. See Notes for more details.
`score_name`. See Examples of :class:`~ignite.handlers.checkpoint.Checkpoint` for more details.
n_saved: Number of objects that should be kept on disk. Older files will be removed. If set to
`None`, all objects are kept.
atomic: If True, objects are serialized to a temporary file, and then moved to final
Expand Down Expand Up @@ -909,21 +911,24 @@ class ModelCheckpoint(Checkpoint):
with :class:`~ignite.handlers.checkpoint.Checkpoint`

Examples:
.. code-block:: python
.. testcode:: python

import os
from ignite.engine import Engine, Events
from ignite.handlers import ModelCheckpoint
from torch import nn
trainer = Engine(lambda engine, batch: None)
handler = ModelCheckpoint('/tmp/models', 'myprefix', n_saved=2, create_dir=True)
handler = ModelCheckpoint('/tmp/models', 'myprefix', n_saved=2, create_dir=True, require_empty=False)
model = nn.Linear(3, 3)
trainer.add_event_handler(Events.EPOCH_COMPLETED(every=2), handler, {'mymodel': model})
trainer.run([0, 1, 2, 3, 4], max_epochs=6)
os.listdir('/tmp/models')
# ['myprefix_mymodel_20.pt', 'myprefix_mymodel_30.pt']
handler.last_checkpoint
# ['/tmp/models/myprefix_mymodel_30.pt']
print(sorted(os.listdir('/tmp/models')))
print(handler.last_checkpoint)

.. testoutput:: python

['myprefix_mymodel_20.pt', 'myprefix_mymodel_30.pt']
/tmp/models/myprefix_mymodel_30.pt
"""

def __init__(
Expand Down