From 236c1378f94a7f9d2e1e205035d4d76733c8f4c9 Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Thu, 14 May 2020 17:06:03 +0200 Subject: [PATCH] docs dpp warn (#1835) * add warn * Apply suggestions from code review --- docs/source/lr_finder.rst | 4 +++- docs/source/training_tricks.rst | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/source/lr_finder.rst b/docs/source/lr_finder.rst index c20472bfc0..cb6875117e 100755 --- a/docs/source/lr_finder.rst +++ b/docs/source/lr_finder.rst @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/training_tricks.rst b/docs/source/training_tricks.rst index 76f41acea4..b748465eec 100644 --- a/docs/source/training_tricks.rst +++ b/docs/source/training_tricks.rst @@ -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.