Update deprecation method to refer to utility function

Lightning-AI · Jul 22, 2021 · f7c5025 · f7c5025
1 parent bb2ce62
commit f7c5025
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/pytorch_lightning/core/lightning.py b/pytorch_lightning/core/lightning.py
@@ -1971,7 +1971,8 @@ def model_size(self) -> float:
             Will be removed in v1.6.0
         """
         rank_zero_deprecation(
-            'The `LightningModule.model_size` property was deprecated in v1.4 and will be removed in v1.6.'
+            'The `LightningModule.model_size` property was deprecated in v1.4 and will be removed in v1.6. Please '
+            'use the get_model_size method under utilities/model_helpers.py'
         )
 
         tmp_name = f"{uuid.uuid4().hex}.pt"

diff --git a/tests/deprecated_api/test_remove_1-6.py b/tests/deprecated_api/test_remove_1-6.py
@@ -326,5 +326,8 @@ def test_v1_6_0_deprecated_hpc_load(tmpdir):
 
 def test_v1_6_0_deprecated_model_size():
     model = BoringModel()
-    with pytest.deprecated_call(match="The `LightningModule.model_size` property was deprecated in v1.4 and will be removed in v1.6."):
+    with pytest.deprecated_call(
+        match="The `LightningModule.model_size` property was deprecated in v1.4 and will be removed in v1.6. "
+        "Please use the get_model_size method under utilities/model_helpers.py"
+    ):
         _ = model.model_size