lightning/tests/test_deprecated.py

189 lines
7.8 KiB
Python

"""Test deprecated functionality which will be removed in vX.Y.Z"""
import sys
import pytest
from pytorch_lightning import Trainer
import tests.base.utils as tutils
from tests.base import EvalModelTemplate
def _soft_unimport_module(str_module):
# once the module is imported e.g with parsing with pytest it lives in memory
if str_module in sys.modules:
del sys.modules[str_module]
def test_tbd_remove_in_v0_8_0_module_imports():
_soft_unimport_module("pytorch_lightning.logging.comet_logger")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.logging.comet_logger import CometLogger # noqa: F811
_soft_unimport_module("pytorch_lightning.logging.mlflow_logger")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.logging.mlflow_logger import MLFlowLogger # noqa: F811
_soft_unimport_module("pytorch_lightning.logging.test_tube_logger")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.logging.test_tube_logger import TestTubeLogger # noqa: F811
_soft_unimport_module("pytorch_lightning.pt_overrides.override_data_parallel")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.pt_overrides.override_data_parallel import ( # noqa: F811
LightningDataParallel, LightningDistributedDataParallel)
_soft_unimport_module("pytorch_lightning.overrides.override_data_parallel")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.overrides.override_data_parallel import ( # noqa: F811
LightningDataParallel, LightningDistributedDataParallel)
_soft_unimport_module("pytorch_lightning.core.model_saving")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.core.model_saving import ModelIO # noqa: F811
_soft_unimport_module("pytorch_lightning.core.root_module")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.core.root_module import LightningModule # noqa: F811
_soft_unimport_module("pytorch_lightning.root_module.decorators")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.root_module.decorators import data_loader # noqa: F811
_soft_unimport_module("pytorch_lightning.root_module.grads")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.root_module.grads import GradInformation # noqa: F811
_soft_unimport_module("pytorch_lightning.root_module.hooks")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.root_module.hooks import ModelHooks # noqa: F811
_soft_unimport_module("pytorch_lightning.root_module.memory")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.root_module.memory import ModelSummary # noqa: F811
_soft_unimport_module("pytorch_lightning.root_module.model_saving")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.root_module.model_saving import ModelIO # noqa: F811
_soft_unimport_module("pytorch_lightning.root_module.root_module")
with pytest.deprecated_call(match='v0.8.0'):
from pytorch_lightning.root_module.root_module import LightningModule # noqa: F811
def test_tbd_remove_in_v0_8_0_trainer():
mapping_old_new = {
'gradient_clip': 'gradient_clip_val',
'nb_gpu_nodes': 'num_nodes',
'max_nb_epochs': 'max_epochs',
'min_nb_epochs': 'min_epochs',
'nb_sanity_val_steps': 'num_sanity_val_steps',
'default_save_path': 'default_root_dir',
}
# skip 0 since it may be interested as False
kwargs = {k: (i + 1) for i, k in enumerate(mapping_old_new)}
trainer = Trainer(**kwargs)
for attr_old in mapping_old_new:
attr_new = mapping_old_new[attr_old]
with pytest.deprecated_call(match='v0.8.0'):
_ = getattr(trainer, attr_old)
assert kwargs[attr_old] == getattr(trainer, attr_old), \
'Missing deprecated attribute "%s"' % attr_old
assert kwargs[attr_old] == getattr(trainer, attr_new), \
'Wrongly passed deprecated argument "%s" to attribute "%s"' % (attr_old, attr_new)
def test_tbd_remove_in_v0_9_0_trainer():
# test show_progress_bar set by progress_bar_refresh_rate
with pytest.deprecated_call(match='v0.9.0'):
trainer = Trainer(progress_bar_refresh_rate=0, show_progress_bar=True)
assert not getattr(trainer, 'show_progress_bar')
with pytest.deprecated_call(match='v0.9.0'):
trainer = Trainer(progress_bar_refresh_rate=50, show_progress_bar=False)
assert getattr(trainer, 'show_progress_bar')
def test_tbd_remove_in_v0_9_0_module_imports():
_soft_unimport_module("pytorch_lightning.core.decorators")
with pytest.deprecated_call(match='v0.9.0'):
from pytorch_lightning.core.decorators import data_loader # noqa: F811
data_loader(print)
_soft_unimport_module("pytorch_lightning.logging.comet")
with pytest.deprecated_call(match='v0.9.0'):
from pytorch_lightning.logging.comet import CometLogger # noqa: F402
_soft_unimport_module("pytorch_lightning.logging.mlflow")
with pytest.deprecated_call(match='v0.9.0'):
from pytorch_lightning.logging.mlflow import MLFlowLogger # noqa: F402
_soft_unimport_module("pytorch_lightning.logging.neptune")
with pytest.deprecated_call(match='v0.9.0'):
from pytorch_lightning.logging.neptune import NeptuneLogger # noqa: F402
_soft_unimport_module("pytorch_lightning.logging.test_tube")
with pytest.deprecated_call(match='v0.9.0'):
from pytorch_lightning.logging.test_tube import TestTubeLogger # noqa: F402
_soft_unimport_module("pytorch_lightning.logging.wandb")
with pytest.deprecated_call(match='v0.9.0'):
from pytorch_lightning.logging.wandb import WandbLogger # noqa: F402
class ModelVer0_6(EvalModelTemplate):
# todo: this shall not be needed while evaluate asks for dataloader explicitly
def val_dataloader(self):
return self.dataloader(train=False)
def validation_step(self, batch, batch_idx, *args, **kwargs):
return {'val_loss': 0.6}
def validation_end(self, outputs):
return {'val_loss': 0.6}
def test_dataloader(self):
return self.dataloader(train=False)
def test_end(self, outputs):
return {'test_loss': 0.6}
class ModelVer0_7(EvalModelTemplate):
# todo: this shall not be needed while evaluate asks for dataloader explicitly
def val_dataloader(self):
return self.dataloader(train=False)
def validation_step(self, batch, batch_idx, *args, **kwargs):
return {'val_loss': 0.7}
def validation_end(self, outputs):
return {'val_loss': 0.7}
def test_dataloader(self):
return self.dataloader(train=False)
def test_end(self, outputs):
return {'test_loss': 0.7}
def test_tbd_remove_in_v1_0_0_model_hooks():
hparams = EvalModelTemplate.get_default_hparams()
model = ModelVer0_6(hparams)
with pytest.deprecated_call(match='v1.0'):
trainer = Trainer(logger=False)
trainer.test(model)
assert trainer.callback_metrics == {'test_loss': 0.6}
with pytest.deprecated_call(match='v1.0'):
trainer = Trainer(logger=False)
# TODO: why `dataloder` is required if it is not used
result = trainer._evaluate(model, dataloaders=[[None]], max_batches=1)
assert result == {'val_loss': 0.6}
model = ModelVer0_7(hparams)
with pytest.deprecated_call(match='v1.0'):
trainer = Trainer(logger=False)
trainer.test(model)
assert trainer.callback_metrics == {'test_loss': 0.7}
with pytest.deprecated_call(match='v1.0'):
trainer = Trainer(logger=False)
# TODO: why `dataloder` is required if it is not used
result = trainer._evaluate(model, dataloaders=[[None]], max_batches=1)
assert result == {'val_loss': 0.7}