117 lines
3.8 KiB
ReStructuredText
Executable File
117 lines
3.8 KiB
ReStructuredText
Executable File
.. testsetup:: *
|
|
|
|
from pytorch_lightning.trainer.trainer import Trainer
|
|
from pytorch_lightning.core.lightning import LightningModule
|
|
|
|
.. _lr_finder:
|
|
|
|
Learning Rate Finder
|
|
--------------------
|
|
|
|
For training deep neural networks, selecting a good learning rate is essential
|
|
for both better performance and faster convergence. Even optimizers such as
|
|
`Adam` that are self-adjusting the learning rate can benefit from more optimal
|
|
choices.
|
|
|
|
To reduce the amount of guesswork concerning choosing a good initial learning
|
|
rate, a `learning rate finder` can be used. As described in this `paper <https://arxiv.org/abs/1506.01186>`_
|
|
a learning rate finder does a small run where the learning rate is increased
|
|
after each processed batch and the corresponding loss is logged. The result of
|
|
this is a `lr` vs. `loss` plot that can be used as guidance for choosing a optimal
|
|
initial lr.
|
|
|
|
.. warning::
|
|
For the moment, this feature only works with models having a single optimizer.
|
|
LR support for DDP is not implemented yet, it is comming soon.
|
|
|
|
----------
|
|
|
|
Using Lightning's built-in LR finder
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
In the most basic use case, this feature can be enabled during trainer construction
|
|
with ``Trainer(auto_lr_find=True)``. When ``.fit(model)`` is called, the LR finder
|
|
will automatically run before any training is done. The ``lr`` that is found
|
|
and used will be written to the console and logged together with all other
|
|
hyperparameters of the model.
|
|
|
|
.. testcode::
|
|
|
|
# default: no automatic learning rate finder
|
|
trainer = Trainer(auto_lr_find=False)
|
|
|
|
This flag sets your learning rate which can be accessed via ``self.lr`` or ``self.learning_rate``.
|
|
|
|
.. testcode::
|
|
|
|
class LitModel(LightningModule):
|
|
|
|
def __init__(self, learning_rate):
|
|
self.learning_rate = learning_rate
|
|
|
|
def configure_optimizers(self):
|
|
return Adam(self.parameters(), lr=(self.lr or self.learning_rate))
|
|
|
|
# finds learning rate automatically
|
|
# sets hparams.lr or hparams.learning_rate to that learning rate
|
|
trainer = Trainer(auto_lr_find=True)
|
|
|
|
To use an arbitrary value set it as auto_lr_find
|
|
|
|
.. testcode::
|
|
|
|
# to set to your own hparams.my_value
|
|
trainer = Trainer(auto_lr_find='my_value')
|
|
|
|
Under the hood, when you call fit it runs the learning rate finder before actually calling fit.
|
|
|
|
.. code-block:: python
|
|
|
|
# when you call .fit() this happens
|
|
# 1. find learning rate
|
|
# 2. actually run fit
|
|
trainer.fit(model)
|
|
|
|
If you want to inspect the results of the learning rate finder before doing any
|
|
actual training or just play around with the parameters of the algorithm, this
|
|
can be done by invoking the ``lr_find`` method of the trainer. A typical example
|
|
of this would look like
|
|
|
|
.. code-block:: python
|
|
|
|
model = MyModelClass(hparams)
|
|
trainer = Trainer()
|
|
|
|
# Run learning rate finder
|
|
lr_finder = trainer.lr_find(model)
|
|
|
|
# Results can be found in
|
|
lr_finder.results
|
|
|
|
# Plot with
|
|
fig = lr_finder.plot(suggest=True)
|
|
fig.show()
|
|
|
|
# Pick point based on plot, or get suggestion
|
|
new_lr = lr_finder.suggestion()
|
|
|
|
# update hparams of the model
|
|
model.hparams.lr = new_lr
|
|
|
|
# Fit model
|
|
trainer.fit(model)
|
|
|
|
The figure produced by ``lr_finder.plot()`` should look something like the figure
|
|
below. It is recommended to not pick the learning rate that achives the lowest
|
|
loss, but instead something in the middle of the sharpest downward slope (red point).
|
|
This is the point returned py ``lr_finder.suggestion()``.
|
|
|
|
.. figure:: /_images/trainer/lr_finder.png
|
|
|
|
The parameters of the algorithm can be seen below.
|
|
|
|
.. autoclass:: pytorch_lightning.trainer.lr_finder.TrainerLRFinderMixin
|
|
:members: lr_find
|
|
:noindex:
|
|
:exclude-members: _run_lr_finder_internally, save_checkpoint, restore
|