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

Fix iterable dataset docs (#1342)

This commit is contained in:
Ethan Harris 2020-04-02 16:51:43 +01:00 committed by GitHub
parent 28242f02d1
commit ddb59130f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/sequences.rst
View File

@ -49,10 +49,10 @@ Iterable Datasets
Lightning supports using IterableDatasets as well as map-style Datasets. IterableDatasets provide a more natural
option when using sequential data.
.. note:: When using an IterableDataset you must set the val_check_interval to an int (specifying the number of training
batches to run before validation) when initializing the Trainer even when there is no validation logic in place.
.. note:: When using an IterableDataset you must set the val_check_interval to 1.0 (the default) or to an int
(specifying the number of training batches to run before validation) when initializing the Trainer.
This is due to the fact that the IterableDataset does not have a __len__ and Lightning requires this to calculate
the default validation interval.
the validation interval when val_check_interval is less than one.
.. code-block:: python
@ -74,4 +74,4 @@ option when using sequential data.
return dataloader
# Set val_check_interval
trainer = pl.Trainer(val_check_interval=1000)
trainer = pl.Trainer()