wassname/pytorch-lightning
1
0
Fork 0
mirror of https://github.com/wassname/pytorch-lightning.git synced 2026-09-11 12:31:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixed the default value of auto_lr_find in docs (#1854)

Browse Source 
* Fixed the default value of auto_lr_find in docs

* Update lr_finder.rst

Co-authored-by: William Falcon <waf2107@columbia.edu>
This commit is contained in:
Subodh Dahal
2020-05-17 10:59:46 -04:00
committed by GitHub
co-authored by William Falcon
parent 76f905f902
commit 6dc381a806
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/lr_finder.rst
+5 -5
View File
@@ -22,19 +22,19 @@ Warnings:
- 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 Lightnings build-in LR finder
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
with ``Trainer(auto_lr_find=True)``. When ``.fit(model)`` is called, the LR finder
will automatically be 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=True)
# default: no automatic learning rate finder
trainer = Trainer(auto_lr_find=False)
When the ``lr`` or ``learning_rate`` key in hparams exists, this flag sets your learning_rate.
In both cases, if the respective fields are not found, an error will be thrown.