Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add note in LightningCLI docs that `--optimizer` must be given for `--lr_scheduler` to work (#17552)

This commit is contained in:
Jakub Kaczmarzyk 2023-05-04 07:35:05 -04:00 committed by GitHub
parent e0f335809d
commit ebbd1169d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source-pytorch/cli/lightning_cli_intermediate_2.rst
View File

@ -193,13 +193,15 @@ Standard learning rate schedulers from ``torch.optim.lr_scheduler`` work out of
.. code:: bash .. code:: bash
python main.py fit --lr_scheduler CosineAnnealingLR python main.py fit --optimizer=Adam --lr_scheduler CosineAnnealingLR
Please note that ``--optimizer`` must be added for ``--lr_scheduler`` to have an effect.
If the scheduler you want needs other arguments, add them via the CLI (no need to change your code)! If the scheduler you want needs other arguments, add them via the CLI (no need to change your code)!
.. code:: bash .. code:: bash
python main.py fit --lr_scheduler=ReduceLROnPlateau --lr_scheduler.monitor=epoch python main.py fit --optimizer=Adam --lr_scheduler=ReduceLROnPlateau --lr_scheduler.monitor=epoch
Furthermore, any custom subclass of ``torch.optim.lr_scheduler.LRScheduler`` can be used as learning rate scheduler: Furthermore, any custom subclass of ``torch.optim.lr_scheduler.LRScheduler`` can be used as learning rate scheduler:
@ -224,7 +226,7 @@ Now you can choose between any learning rate scheduler at runtime:
.. code:: bash .. code:: bash
# LitLRScheduler # LitLRScheduler
python main.py fit --lr_scheduler LitLRScheduler python main.py fit --optimizer=Adam --lr_scheduler LitLRScheduler
---- ----