Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
apex
Commits
f5cd5ae9
Commit
f5cd5ae9
authored
Mar 26, 2019
by
Michael Carilli
Browse files
Minor docstring updates
parent
e7f19560
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
8 deletions
+9
-8
apex/amp/handle.py
apex/amp/handle.py
+9
-8
No files found.
apex/amp/handle.py
View file @
f5cd5ae9
...
@@ -37,7 +37,7 @@ def scale_loss(loss,
...
@@ -37,7 +37,7 @@ def scale_loss(loss,
unscaled. The direct ``.grad`` attributes of any FP16
unscaled. The direct ``.grad`` attributes of any FP16
model params will remain scaled after context manager exit.
model params will remain scaled after context manager exit.
This subtlety affects gradient clipping. See "Gradient clipping" under
This subtlety affects gradient clipping. See "Gradient clipping" under
`Advanced
use cases
`_ for best practices.
`Advanced
Amp Usage
`_ for best practices.
Args:
Args:
loss(Tensor): Typically a scalar Tensor. The ``scaled_loss`` that the context
loss(Tensor): Typically a scalar Tensor. The ``scaled_loss`` that the context
...
@@ -48,16 +48,17 @@ def scale_loss(loss,
...
@@ -48,16 +48,17 @@ def scale_loss(loss,
model(torch.nn.Module, optional, default=None): Currently unused, reserved to enable future
model(torch.nn.Module, optional, default=None): Currently unused, reserved to enable future
optimizations.
optimizations.
delay_unscale(bool, default=False): Don't unscale the gradients or perform model->master
delay_unscale(bool, default=False): Don't unscale the gradients or perform model->master
gradient copies on context manager exit.
"
Advanced
use cases"
illustrates
gradient copies on context manager exit.
`
Advanced
Amp Usage`_
illustrates
situations where this is necessary.
situations where this is necessary.
.. warning::If ``True``, ``optimizer.step()`` cannot be
.. warning::
called yet after context manager exit, and must wait for another, later backward context
If ``delay_unscale`` is ``True`` for a given backward pass, ``optimizer.step()`` cannot be
manager invocation with ``delay_unscale`` left to False.
called yet after context manager exit, and must wait for another, later backward context
See `Advanced use cases`_ for examples.
manager invocation with ``delay_unscale`` left to False.
See `Advanced Amp Usage`_ for examples.
.. _`Advanced
use cases
`:
.. _`Advanced
Amp Usage
`:
https://nvidia.github.io/apex/a
mp.html#advanced-use-cases
https://nvidia.github.io/apex/a
dvanced.html
"""
"""
if
not
_amp_state
.
opt_properties
.
enabled
:
if
not
_amp_state
.
opt_properties
.
enabled
:
yield
loss
yield
loss
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment