Skip to content

Add note about returning None #5578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 20, 2021
Merged

Add note about returning None #5578

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca427b4
Add note about returning None
carmocca Jan 19, 2021
b0cb3c9
Apply suggestions from code review
Borda Jan 19, 2021
8c0da9b
Merge branch 'master' into docs/5577
carmocca Jan 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions pytorch_lightning/core/lightning.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,8 +463,11 @@ def training_step(self, *args, **kwargs):
Any of.

- :class:`~torch.Tensor` - The loss tensor
- `dict` - A dictionary. Can include any keys, but must include the key 'loss'
- `None` - Training will skip to the next batch
- ``dict`` - A dictionary. Can include any keys, but must include the key ``'loss'``
- ``None`` - Training will skip to the next batch

Note:
Returning ``None`` is currently not supported for multi-GPU or TPU, or with 16-bit precision enabled.

In this step you'd normally do the forward pass and calculate the loss for a batch.
You can also do fancier things like multiple forward passes or something model specific.
Expand Down Expand Up @@ -639,7 +642,7 @@ def validation_step(self, *args, **kwargs):
Any of.

- Any object or value
- `None` - Validation will skip to the next batch
- ``None`` - Validation will skip to the next batch

.. code-block:: python

Expand Down Expand Up @@ -824,7 +827,7 @@ def test_step(self, *args, **kwargs):
Any of.

- Any object or value
- `None` - Testing will skip to the next batch
- ``None`` - Testing will skip to the next batch

.. code-block:: python

Expand Down