Skip to content

Commit

Permalink
Add deprecation path for the old Callback module (Lightning-AI#13031)
Browse files Browse the repository at this point in the history
  • Loading branch information
rohitgr7 authored and ashleve committed May 19, 2022
1 parent 711ccba commit e21750a
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Deprecated `pytorch_lightning.loggers.base.LightningLoggerBase` in favor of `pytorch_lightning.loggers.logger.Logger`, and deprecated `pytorch_lightning.loggers.base` in favor of `pytorch_lightning.loggers.logger` ([#120148](https://github.com/PyTorchLightning/pytorch-lightning/pull/12014))


- Deprecated `pytorch_lightning.callbacks.base.Callback` in favor of `pytorch_lightning.callbacks.callback.Callback` ([#13031](https://github.com/PyTorchLightning/pytorch-lightning/pull/13031))


- Deprecated `num_processes`, `gpus`, `tpu_cores,` and `ipus` from the `Trainer` constructor in favor of using the `accelerator` and `devices` arguments ([#11040](https://github.com/PyTorchLightning/pytorch-lightning/pull/11040))

Expand Down
27 changes: 27 additions & 0 deletions pytorch_lightning/callbacks/base.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# 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 typing import Any

from pytorch_lightning.callbacks.callback import Callback as NewCallback
from pytorch_lightning.utilities import rank_zero_deprecation


class Callback(NewCallback):
def __init__(self, *args: Any, **kwargs: Any) -> None:
rank_zero_deprecation(
"pytorch_lightning.callbacks.base.Callback has been deprecated in v1.7"
" and will be removed in v1.9."
" Use the equivalent class from the pytorch_lightning.callbacks.callback.Callback class instead."
)
super().__init__(*args, **kwargs)
9 changes: 9 additions & 0 deletions tests/deprecated_api/test_remove_1-9.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,12 @@ def test_lightningCLI_seed_everything_default_to_None_deprecation_warning():
"and will be removed in v1.9. Set it to `False` instead."
):
LightningCLI(LightningModule, run=False, seed_everything_default=None)


def test_old_callback_path():
from pytorch_lightning.callbacks.base import Callback

with pytest.deprecated_call(
match="pytorch_lightning.callbacks.base.Callback has been deprecated in v1.7" " and will be removed in v1.9."
):
Callback()

0 comments on commit e21750a

Please sign in to comment.