diff --git a/CHANGELOG.md b/CHANGELOG.md index f16d5d0c260c7..2649abc02d54e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -74,6 +74,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). * `test_percent_check` in favour of `limit_test_batches` - Deprecated `ModelCheckpoint`'s attributes `best` and `kth_best_model` ([#1799](https://github.com/PyTorchLightning/pytorch-lightning/pull/1799)) - Dropped official support/testing for older PyTorch versions <1.3 ([#1917](https://github.com/PyTorchLightning/pytorch-lightning/pull/1917)) +- Deprecated Trainer `proc_rank` in favour of `global_rank` ([#2166](https://github.com/PyTorchLightning/pytorch-lightning/pull/2166), [#2269](https://github.com/PyTorchLightning/pytorch-lightning/pull/2269)) ### Removed diff --git a/pytorch_lightning/trainer/deprecated_api.py b/pytorch_lightning/trainer/deprecated_api.py index 8719f80b9b2bc..6cb160f1d26b2 100644 --- a/pytorch_lightning/trainer/deprecated_api.py +++ b/pytorch_lightning/trainer/deprecated_api.py @@ -104,3 +104,17 @@ def overfit_pct(self, pct): rank_zero_warn("Attribute `train_percent_check` is now set by `overfit_batches` since v0.8.0" " and this method will be removed in v0.10.0", DeprecationWarning) self.overfit_batches = pct + + @property + def proc_rank(self) -> int: + """Back compatibility, will be removed in v0.10.0""" + rank_zero_warn("Attribute `proc_rank` is now set by `global_rank` since v0.8.0" + " and this method will be removed in v0.10.0", DeprecationWarning) + return self.global_rank + + @proc_rank.setter + def proc_rank(self, rank): + """Back compatibility, will be removed in v0.10.0""" + rank_zero_warn("Attribute `proc_rank` is now set by `global_rank` since v0.8.0" + " and this method will be removed in v0.10.0", DeprecationWarning) + self.global_rank = rank diff --git a/tests/test_deprecated.py b/tests/test_deprecated.py index be2fda9c905ba..c2b9295c5b495 100644 --- a/tests/test_deprecated.py +++ b/tests/test_deprecated.py @@ -44,6 +44,12 @@ def test_tbd_remove_in_v0_10_0_trainer(): with pytest.deprecated_call(match='v0.10.0'): assert trainer.test_percent_check == rnd_val + trainer = Trainer() + with pytest.deprecated_call(match='v0.10.0'): + trainer.proc_rank = 0 + with pytest.deprecated_call(match='v0.10.0'): + assert trainer.proc_rank == trainer.global_rank + def test_tbd_remove_in_v0_9_0_trainer(): # test show_progress_bar set by progress_bar_refresh_rate