wassname/pytorch-lightning
1
0
Fork 0
mirror of https://github.com/wassname/pytorch-lightning.git synced 2026-09-09 11:32:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
William Falcon
2019-10-01 06:38:10 -04:00
parent fbc2cfd513
commit 133d6b3ec1
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/LightningModule/RequiredTrainerInterface.md
+4 -1
View File
@@ -168,7 +168,8 @@ def training_step(self, batch, batch_nb, optimizer_idx):
@pl.data_loader @pl.data_loader
def train_dataloader(self) def train_dataloader(self)
``` ```
Called by lightning during training loop. Make sure to use the @pl.data_loader decorator, this ensures not calling this function until the data are needed. Called by lightning during training loop. Make sure to use the @pl.data_loader decorator, this ensures not calling this function until the data are needed.
If you want to change the data during every epoch DON'T use the data_loader decorator.
##### Return ##### Return
PyTorch DataLoader PyTorch DataLoader
@@ -572,6 +573,7 @@ def val_dataloader(self)
If you don't need a validation dataset and a validation_step, you don't need to implement this method. If you don't need a validation dataset and a validation_step, you don't need to implement this method.
Called by lightning during validation loop. Make sure to use the @pl.data_loader decorator, this ensures not calling this function until the data are needed. Called by lightning during validation loop. Make sure to use the @pl.data_loader decorator, this ensures not calling this function until the data are needed.
If you want to change the data during every epoch DON'T use the data_loader decorator.
##### Return ##### Return
PyTorch DataLoader or list of PyTorch Dataloaders. PyTorch DataLoader or list of PyTorch Dataloaders.
@@ -611,6 +613,7 @@ def test_dataloader(self)
If you don't need a test dataset and a test_step, you don't need to implement this method. If you don't need a test dataset and a test_step, you don't need to implement this method.
Called by lightning during test loop. Make sure to use the @pl.data_loader decorator, this ensures not calling this function until the data are needed. Called by lightning during test loop. Make sure to use the @pl.data_loader decorator, this ensures not calling this function until the data are needed.
If you want to change the data during every epoch DON'T use the data_loader decorator.
##### Return ##### Return
PyTorch DataLoader PyTorch DataLoader