Commit ab520f82 authored by Deyu Fu's avatar Deyu Fu
Browse files

update fusedadam docstring

parent ebcd7f08
...@@ -13,7 +13,8 @@ class FusedAdam(torch.optim.Optimizer): ...@@ -13,7 +13,8 @@ class FusedAdam(torch.optim.Optimizer):
* Fusion of the Adam update's elementwise operations * Fusion of the Adam update's elementwise operations
* A multi-tensor apply launch that batches the elementwise updates applied to all the model's parameters into one or a few kernel launches. * A multi-tensor apply launch that batches the elementwise updates applied to all the model's parameters into one or a few kernel launches.
:class:`apex.optimizers.FusedAdam` may be used as a drop-in replacement for ``torch.optim.Adam``:: :class:`apex.optimizers.FusedAdam` may be used as a drop-in replacement for ``torch.optim.AdamW``,
or ``torch.optim.Adam`` with ``adam_w_mode=False``::
opt = apex.optimizers.FusedAdam(model.parameters(), lr = ....) opt = apex.optimizers.FusedAdam(model.parameters(), lr = ....)
... ...
......
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