lightning/tests/tests_pytorch/loops/test_utilities.py

62 lines
2.2 KiB
Python

# Copyright The PyTorch Lightning team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from unittest.mock import Mock
import pytest
import torch
from pytorch_lightning.loops.utilities import _extract_hiddens, _set_sampler_epoch
from pytorch_lightning.utilities.exceptions import MisconfigurationException
def test_extract_hiddens():
# tbptt not enabled, no hiddens return
training_step_output = 1 # anything
hiddens = _extract_hiddens(training_step_output, 0)
assert hiddens is None
# tbptt enabled, hiddens return
hiddens = torch.tensor(321.12, requires_grad=True)
training_step_output = {"hiddens": hiddens}
hiddens = _extract_hiddens(training_step_output, 2)
assert "hiddens" in training_step_output
assert not hiddens.requires_grad
# tbptt not enabled, hiddens return
with pytest.raises(MisconfigurationException, match='returned "hiddens" .* but `truncated_bptt_steps` is disabled'):
_extract_hiddens(training_step_output, 0)
# tbptt enabled, no hiddens return
with pytest.raises(MisconfigurationException, match="enabled `truncated_bptt_steps` but did not `return"):
_extract_hiddens(None, 1)
def test_set_sampler_epoch():
# No samplers
dataloader = Mock()
dataloader.sampler = None
dataloader.batch_sampler = None
_set_sampler_epoch(dataloader, 55)
# set_epoch not callable
dataloader = Mock()
dataloader.sampler.set_epoch = None
dataloader.batch_sampler.set_epoch = None
_set_sampler_epoch(dataloader, 55)
# set_epoch callable
dataloader = Mock()
_set_sampler_epoch(dataloader, 55)
dataloader.sampler.set_epoch.assert_called_once_with(55)
dataloader.batch_sampler.set_epoch.assert_called_once_with(55)