Skip to content

Commit 499d503

Browse files
thepooonsrohitgr7SkafteNicki
authored
fix typos in validation_step and test_step docs (#5438)
* fixed docs in lightning.py * few more Co-authored-by: Rohit Gupta <[email protected]> Co-authored-by: Nicki Skafte <[email protected]>
1 parent f1e28d1 commit 499d503

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

pytorch_lightning/core/lightning.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -621,14 +621,14 @@ def validation_step(self, *args, **kwargs):
621621
for val_batch in val_data:
622622
out = validation_step(val_batch)
623623
val_outs.append(out)
624-
validation_epoch_end(val_outs)
624+
validation_epoch_end(val_outs)
625625
626626
Args:
627627
batch (:class:`~torch.Tensor` | (:class:`~torch.Tensor`, ...) | [:class:`~torch.Tensor`, ...]):
628628
The output of your :class:`~torch.utils.data.DataLoader`. A tensor, tuple or list.
629629
batch_idx (int): The index of this batch
630630
dataloader_idx (int): The index of the dataloader that produced this batch
631-
(only if multiple val datasets used)
631+
(only if multiple val dataloaders used)
632632
633633
Return:
634634
Any of.
@@ -677,11 +677,11 @@ def validation_step(self, batch, batch_idx):
677677
# log the outputs!
678678
self.log_dict({'val_loss': loss, 'val_acc': val_acc})
679679
680-
If you pass in multiple val datasets, validation_step will have an additional argument.
680+
If you pass in multiple val dataloaders, :meth:`validation_step` will have an additional argument.
681681
682682
.. code-block:: python
683683
684-
# CASE 2: multiple validation datasets
684+
# CASE 2: multiple validation dataloaders
685685
def validation_step(self, batch, batch_idx, dataloader_idx):
686686
# dataloader_idx tells you which dataset this is.
687687
@@ -813,7 +813,7 @@ def test_step(self, *args, **kwargs):
813813
The output of your :class:`~torch.utils.data.DataLoader`. A tensor, tuple or list.
814814
batch_idx (int): The index of this batch.
815815
dataloader_idx (int): The index of the dataloader that produced this batch
816-
(only if multiple test datasets used).
816+
(only if multiple test dataloaders used).
817817
818818
Return:
819819
Any of.
@@ -853,17 +853,17 @@ def test_step(self, batch, batch_idx):
853853
# log the outputs!
854854
self.log_dict({'test_loss': loss, 'test_acc': test_acc})
855855
856-
If you pass in multiple validation datasets, :meth:`test_step` will have an additional
856+
If you pass in multiple test dataloaders, :meth:`test_step` will have an additional
857857
argument.
858858
859859
.. code-block:: python
860860
861-
# CASE 2: multiple test datasets
861+
# CASE 2: multiple test dataloaders
862862
def test_step(self, batch, batch_idx, dataloader_idx):
863863
# dataloader_idx tells you which dataset this is.
864864
865865
Note:
866-
If you don't need to validate you don't need to implement this method.
866+
If you don't need to test you don't need to implement this method.
867867
868868
Note:
869869
When the :meth:`test_step` is called, the model has been put in eval mode and

0 commit comments

Comments
 (0)