From 6dc381a80653606f60a8360713f5ecd058d1086b Mon Sep 17 00:00:00 2001 From: Subodh Dahal Date: Sun, 17 May 2020 16:59:46 +0200 Subject: [PATCH] Fixed the default value of auto_lr_find in docs (#1854) * Fixed the default value of auto_lr_find in docs * Update lr_finder.rst Co-authored-by: William Falcon --- docs/source/lr_finder.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/lr_finder.rst b/docs/source/lr_finder.rst index cb687511..b92088fc 100755 --- a/docs/source/lr_finder.rst +++ b/docs/source/lr_finder.rst @@ -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.