From cce55b6cd3fb53dcded30c493cff2cc023a0cdbc Mon Sep 17 00:00:00 2001 From: Benjamin Krala <56834877+KralaBenjamin@users.noreply.github.com> Date: Thu, 1 Sep 2022 16:06:28 +0200 Subject: [PATCH] Precise description of reload_dataloaders_every_n_epochs (#14245) --- docs/source-pytorch/common/trainer.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source-pytorch/common/trainer.rst b/docs/source-pytorch/common/trainer.rst index 53148c9fab..049bbf9418 100644 --- a/docs/source-pytorch/common/trainer.rst +++ b/docs/source-pytorch/common/trainer.rst @@ -1232,12 +1232,15 @@ reload_dataloaders_every_n_epochs | -Set to a positive integer to reload dataloaders every n epochs. +Set to a positive integer to reload dataloaders every n epochs from your currently used data source. +DataSource can be a ``LightningModule`` or a ``LightningDataModule``. + .. code-block:: python # if 0 (default) train_loader = model.train_dataloader() + # or if using data module: datamodule.train_dataloader() for epoch in epochs: for batch in train_loader: ... @@ -1246,9 +1249,12 @@ Set to a positive integer to reload dataloaders every n epochs. for epoch in epochs: if not epoch % reload_dataloaders_every_n_epochs: train_loader = model.train_dataloader() + # or if using data module: datamodule.train_dataloader() for batch in train_loader: ... +The pseudocode applies also to the ``val_dataloader``. + .. _replace-sampler-ddp: replace_sampler_ddp