Skip to content

Commit

Permalink
[docs] add missing function in handlers docs (#1463)
Browse files Browse the repository at this point in the history
* Update setup.cfg

* [docs] missing function in handlers docs
  • Loading branch information
Jeff Yang authored Nov 14, 2020
1 parent 60ab827 commit efccf29
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/source/handlers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ Complete list of handlers
:members:

.. autoclass:: TerminateOnNan

.. autofunction:: global_step_from_engine
2 changes: 1 addition & 1 deletion ignite/handlers/checkpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit efccf29

Please sign in to comment.