docs dpp warn (#1835)

* add warn

* Apply suggestions from code review
This commit is contained in:
Jirka Borovec
2020-05-14 11:06:03 -04:00
committed by GitHub
parent 88f816ed06
commit 236c1378f9
2 changed files with 6 additions and 2 deletions
+3 -1
View File
@@ -18,7 +18,9 @@ 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.
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+3 -1
View File
@@ -71,7 +71,7 @@ a binary search.
.. warning::
Due to these contrains, this features does *NOT* work when passing dataloaders directly
Due to these constraints, this features does *NOT* work when passing dataloaders directly
to `.fit()`.
The scaling algorithm has a number of parameters that the user can control by
@@ -107,3 +107,5 @@ The algorithm in short works by:
.. autoclass:: pytorch_lightning.trainer.training_tricks.TrainerTrainingTricksMixin
:members: scale_batch_size
:noindex:
.. warning:: Batch size finder is not supported for DDP yet, it is coming soon.