diff --git a/docs/source/handlers.rst b/docs/source/handlers.rst index d7392e546916..42545fefbfe8 100644 --- a/docs/source/handlers.rst +++ b/docs/source/handlers.rst @@ -26,3 +26,5 @@ Complete list of handlers :members: .. autoclass:: TerminateOnNan + +.. autofunction:: global_step_from_engine diff --git a/ignite/handlers/checkpoint.py b/ignite/handlers/checkpoint.py index 3090b8eac5f3..f3c419ee9dfb 100644 --- a/ignite/handlers/checkpoint.py +++ b/ignite/handlers/checkpoint.py @@ -66,7 +66,7 @@ def remove(self, filename: str) -> None: class Checkpoint(Serializable): """Checkpoint handler can be used to periodically save and load objects which have attribute - ``state_dict`/`load_state_dict``. This class can use specific save handlers to store on the disk or a cloud + ``state_dict/load_state_dict``. This class can use specific save handlers to store on the disk or a cloud storage, etc. The Checkpoint handler (if used with :class:`~ignite.handlers.DiskSaver`) also handles automatically moving data on TPU to CPU before writing the checkpoint.