Unverified Commit 24f78acb authored by Kirthi Shankar Sivamani's avatar Kirthi Shankar Sivamani Committed by GitHub
Browse files

[PyTorch] Update doc for checkpoint API (#695)



Update checkpoint API doc
Signed-off-by: default avatarKirthi Shankar Sivamani <ksivamani@nvidia.com>
parent 509ab0b0
...@@ -491,12 +491,6 @@ def checkpoint( ...@@ -491,12 +491,6 @@ def checkpoint(
produced (e.g. due to global state), then the checkpointed version won't produced (e.g. due to global state), then the checkpointed version won't
be numerically equivalent. be numerically equivalent.
.. warning::
The tuple :attr:`args` must contain only tensors (or :attr:`None`) in order to comply with
PyTorch's :attr:`save_for_backward` method. :attr:`function` must be callable to produce
valid outputs with the inputs :attr:`args` and :attr:`kwargs`.
.. warning:: .. warning::
`use_reentrant=False` does not support early stopping, and will execute the entire forward `use_reentrant=False` does not support early stopping, and will execute the entire forward
pass for the checkpointed module when recomputing activations in the backward pass. pass for the checkpointed module when recomputing activations in the backward pass.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment