Skip to content

Commit

Permalink
Fix iterable dataset docs (#1342)
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanwharris committed Apr 2, 2020
1 parent 28242f0 commit ddb5913
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/source/sequences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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()

0 comments on commit ddb5913

Please sign in to comment.