Skip to content

Optimization docs #6907

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 14 commits into from
Apr 19, 2021
Merged

Optimization docs #6907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8058a81
.
akihironitta Apr 8, 2021
4477f46
.
akihironitta Apr 11, 2021
05b6304
Fix link to the section
akihironitta Apr 11, 2021
cf30741
Fix link to the section
akihironitta Apr 11, 2021
1627da4
Consistent indent
akihironitta Apr 11, 2021
43e8ee6
Update docs
akihironitta Apr 13, 2021
6e9bd4e
Apply suggestions from code review
akihironitta Apr 15, 2021
29f70c0
Add note for optimizer.optimizer
akihironitta Apr 15, 2021
5d6bb27
.
akihironitta Apr 16, 2021
e0b3633
Update hooks
akihironitta Apr 16, 2021
4512334
Update closure docstring
akihironitta Apr 16, 2021
eb9ecc3
Update optimizer methods
akihironitta Apr 16, 2021
715bb2c
Update optimizer
akihironitta Apr 16, 2021
23803e3
Remove manopt + grad clipping (by @flukeskywalker)
akihironitta Apr 17, 2021
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
22 changes: 13 additions & 9 deletions docs/source/common/lightning_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,12 @@ log_dict
.. automethod:: pytorch_lightning.core.lightning.LightningModule.log_dict
:noindex:

manual_backward
~~~~~~~~~~~~~~~

.. automethod:: pytorch_lightning.core.lightning.LightningModule.manual_backward
:noindex:

print
~~~~~

Expand Down Expand Up @@ -916,7 +922,10 @@ True if using Automatic Mixed Precision (AMP)

automatic_optimization
~~~~~~~~~~~~~~~~~~~~~~
When set to ``False``, Lightning does not automate the optimization process. This means you are responsible for handling your optimizers. However, we do take care of precision and any accelerators used.
When set to ``False``, Lightning does not automate the optimization process. This means you are responsible for handling
your optimizers. However, we do take care of precision and any accelerators used.

See :ref:`manual optimization<common/optimizers:Manual optimization>` for details.

.. code-block:: python

Expand All @@ -931,7 +940,9 @@ When set to ``False``, Lightning does not automate the optimization process. Thi
self.manual_backward(loss)
opt.step()

This is recommended only if using 2+ optimizers AND if you know how to perform the optimization procedure properly. Note that automatic optimization can still be used with multiple optimizers by relying on the ``optimizer_idx`` parameter. Manual optimization is most useful for research topics like reinforcement learning, sparse coding, and GAN research.
This is recommended only if using 2+ optimizers AND if you know how to perform the optimization procedure properly. Note
that automatic optimization can still be used with multiple optimizers by relying on the ``optimizer_idx`` parameter.
Manual optimization is most useful for research topics like reinforcement learning, sparse coding, and GAN research.

.. code-block:: python

Expand Down Expand Up @@ -1086,13 +1097,6 @@ get_progress_bar_dict
.. automethod:: pytorch_lightning.core.lightning.LightningModule.get_progress_bar_dict
:noindex:

manual_backward
~~~~~~~~~~~~~~~

.. automethod:: pytorch_lightning.core.lightning.LightningModule.manual_backward
:noindex:


on_after_backward
~~~~~~~~~~~~~~~~~

Expand Down
Loading