Skip to content

[docs] add missing function in handlers docs #1463

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
merged 5 commits into from
Nov 14, 2020
Merged

[docs] add missing function in handlers docs #1463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f2ba0a4
Update setup.cfg
Oct 24, 2020
24669e6
Merge remote-tracking branch 'upstream/master'
Nov 11, 2020
571a130
Merge remote-tracking branch 'upstream/master'
Nov 12, 2020
b995b69
Merge remote-tracking branch 'upstream/master'
Nov 14, 2020
d563a81
[docs] missing function in handlers docs
Nov 14, 2020
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
2 changes: 2 additions & 0 deletions docs/source/handlers.rst
View file
Open in desktop
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
View file
Open in desktop
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