refactor: pyDeprecate (#745)

* deprecate: class
* deprecate: function
* cleaning

Author: Borda

requirements.txt

@@ -1,3 +1,4 @@
 numpy>=1.17.2
 torch>=1.3.1
+pyDeprecate==0.3.*
 packaging

torchmetrics/audio/pit.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Dict, Optional
-from warnings import warn
 
+from deprecate import deprecated, void
 from torch import Tensor, tensor
 
 from torchmetrics.functional.audio.pit import permutation_invariant_training
@@ -137,6 +137,7 @@ class PIT(PermutationInvariantTraining):
         Signal Process. ICASSP, IEEE, New Orleans, LA, 2017: pp. 241–245. https://doi.org/10.1109/ICASSP.2017.7952154.
     """
 
+    @deprecated(target=PermutationInvariantTraining, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         metric_func: Callable,
@@ -147,10 +148,4 @@ def __init__(
         dist_sync_fn: Optional[Callable[[Tensor], Tensor]] = None,
         **kwargs: Dict[str, Any],
     ) -> None:
-        warn(
-            "`PIT` was renamed to `PermutationInvariantTraining` in v0.7 and it will be removed in v0.8",
-            DeprecationWarning,
-        )
-        super().__init__(
-            metric_func, eval_func, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn, **kwargs
-        )
+        void(metric_func, eval_func, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn, **kwargs)

torchmetrics/audio/sdr.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Optional
-from warnings import warn
 
+from deprecate import deprecated, void
 from torch import Tensor, tensor
 
 from torchmetrics.functional.audio.sdr import scale_invariant_signal_distortion_ratio, signal_distortion_ratio
@@ -173,6 +173,7 @@ class SDR(SignalDistortionRatio):
         tensor(-11.6051)
     """
 
+    @deprecated(target=SignalDistortionRatio, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         use_cg_iter: Optional[int] = None,
@@ -184,9 +185,7 @@ def __init__(
         process_group: Optional[Any] = None,
         dist_sync_fn: Optional[Callable[[Tensor], Tensor]] = None,
     ) -> None:
-        warn("`SDR` was renamed to `SignalDistortionRatio` in v0.7 and it will be removed in v0.8", DeprecationWarning)
-
-        super().__init__(
+        void(
             use_cg_iter,
             filter_length,
             zero_mean,

torchmetrics/audio/si_sdr.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Optional
-from warnings import warn
 
+from deprecate import deprecated, void
 from torch import Tensor
 
 from torchmetrics.audio.sdr import ScaleInvariantSignalDistortionRatio
@@ -32,6 +32,7 @@ class SI_SDR(ScaleInvariantSignalDistortionRatio):
         tensor(18.4030)
     """
 
+    @deprecated(target=ScaleInvariantSignalDistortionRatio, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         zero_mean: bool = False,
@@ -40,8 +41,4 @@ def __init__(
         process_group: Optional[Any] = None,
         dist_sync_fn: Optional[Callable[[Tensor], Tensor]] = None,
     ) -> None:
-        warn(
-            "`SI_SDR` was renamed to `ScaleInvariantSignalDistortionRatio` in v0.7 and it will be removed in v0.8",
-            DeprecationWarning,
-        )
-        super().__init__(zero_mean, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)
+        void(zero_mean, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)

torchmetrics/audio/si_snr.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Optional
-from warnings import warn
 
+from deprecate import deprecated, void
 from torch import Tensor
 
 from torchmetrics.audio.snr import ScaleInvariantSignalNoiseRatio
@@ -32,15 +32,12 @@ class SI_SNR(ScaleInvariantSignalNoiseRatio):
         tensor(15.0918)
     """
 
+    @deprecated(target=ScaleInvariantSignalNoiseRatio, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         compute_on_step: bool = True,
         dist_sync_on_step: bool = False,
         process_group: Optional[Any] = None,
         dist_sync_fn: Optional[Callable[[Tensor], Tensor]] = None,
     ) -> None:
-        warn(
-            "`SI_SNR` was renamed to `ScaleInvariantSignalNoiseRatio` in v0.7 and it will be removed in v0.8",
-            DeprecationWarning,
-        )
-        super().__init__(compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)
+        void(compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)

torchmetrics/audio/snr.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Optional
-from warnings import warn
 
+from deprecate import deprecated, void
 from torch import Tensor, tensor
 
 from torchmetrics.functional.audio.snr import scale_invariant_signal_noise_ratio, snr
@@ -125,6 +125,7 @@ class SNR(SignalNoiseRatio):
 
     """
 
+    @deprecated(target=SignalNoiseRatio, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         zero_mean: bool = False,
@@ -133,8 +134,7 @@ def __init__(
         process_group: Optional[Any] = None,
         dist_sync_fn: Optional[Callable[[Tensor], Tensor]] = None,
     ) -> None:
-        warn("`SNR` was renamed to `SignalNoiseRatio` in v0.7 and it will be removed in v0.8", DeprecationWarning)
-        super().__init__(zero_mean, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)
+        void(zero_mean, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)
 
 
 class ScaleInvariantSignalNoiseRatio(Metric):

torchmetrics/classification/f_beta.py

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Optional
-from warnings import warn
 
 import torch
+from deprecate import deprecated, void
 from torch import Tensor
 
 from torchmetrics.classification.stat_scores import StatScores
@@ -188,6 +188,7 @@ class FBeta(FBetaScore):
         tensor(0.3333)
     """
 
+    @deprecated(target=FBetaScore, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         num_classes: Optional[int] = None,
@@ -203,20 +204,19 @@ def __init__(
         process_group: Optional[Any] = None,
         dist_sync_fn: Callable = None,
     ) -> None:
-        warn("`FBeta` was renamed to `FBetaScore` in v0.7 and it will be removed in v0.8", DeprecationWarning)
-        super().__init__(
-            num_classes=num_classes,
-            beta=beta,
-            threshold=threshold,
-            average=average,
-            mdmc_average=mdmc_average,
-            ignore_index=ignore_index,
-            top_k=top_k,
-            multiclass=multiclass,
-            compute_on_step=compute_on_step,
-            dist_sync_on_step=dist_sync_on_step,
-            process_group=process_group,
-            dist_sync_fn=dist_sync_fn,
+        void(
+            num_classes,
+            beta,
+            threshold,
+            average,
+            mdmc_average,
+            ignore_index,
+            top_k,
+            multiclass,
+            compute_on_step,
+            dist_sync_on_step,
+            process_group,
+            dist_sync_fn,
         )
 
 
@@ -363,9 +363,7 @@ class F1(F1Score):
         tensor(0.3333)
     """
 
-    is_differentiable = False
-    higher_is_better = True
-
+    @deprecated(target=F1Score, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         num_classes: Optional[int] = None,
@@ -380,17 +378,16 @@ def __init__(
         process_group: Optional[Any] = None,
         dist_sync_fn: Callable = None,
     ) -> None:
-        warn("`F1` was renamed to `F1Score` in v0.7 and it will be removed in v0.8", DeprecationWarning)
-        super().__init__(
-            num_classes=num_classes,
-            threshold=threshold,
-            average=average,
-            mdmc_average=mdmc_average,
-            ignore_index=ignore_index,
-            top_k=top_k,
-            multiclass=multiclass,
-            compute_on_step=compute_on_step,
-            dist_sync_on_step=dist_sync_on_step,
-            process_group=process_group,
-            dist_sync_fn=dist_sync_fn,
+        void(
+            num_classes,
+            threshold,
+            average,
+            mdmc_average,
+            ignore_index,
+            top_k,
+            multiclass,
+            compute_on_step,
+            dist_sync_on_step,
+            process_group,
+            dist_sync_fn,
         )

torchmetrics/classification/hinge.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Optional, Union
-from warnings import warn
 
+from deprecate import deprecated, void
 from torch import Tensor, tensor
 
 from torchmetrics.functional.classification.hinge import MulticlassMode, _hinge_compute, _hinge_update
@@ -154,6 +154,7 @@ class Hinge(HingeLoss):
 
     """
 
+    @deprecated(target=HingeLoss, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         squared: bool = False,
@@ -163,5 +164,4 @@ def __init__(
         process_group: Optional[Any] = None,
         dist_sync_fn: Callable = None,
     ) -> None:
-        warn("`Hinge` was renamed to `HingeLoss` in v0.7 and it will be removed in v0.8", DeprecationWarning)
-        super().__init__(squared, multiclass_mode, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)
+        void(squared, multiclass_mode, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)

torchmetrics/classification/iou.py

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Optional
-from warnings import warn
 
 import torch
+from deprecate import deprecated, void
 
 from torchmetrics.classification.jaccard import JaccardIndex
 
@@ -37,6 +37,7 @@ class IoU(JaccardIndex):
 
     """
 
+    @deprecated(target=JaccardIndex, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         num_classes: int,
@@ -48,14 +49,13 @@ def __init__(
         dist_sync_on_step: bool = False,
         process_group: Optional[Any] = None,
     ) -> None:
-        warn("`IoU` was renamed to `JaccardIndex` in v0.7 and it will be removed in v0.8", DeprecationWarning)
-        super().__init__(
-            num_classes=num_classes,
-            ignore_index=ignore_index,
-            absent_score=absent_score,
-            threshold=threshold,
-            reduction=reduction,
-            compute_on_step=compute_on_step,
-            dist_sync_on_step=dist_sync_on_step,
-            process_group=process_group,
+        void(
+            num_classes,
+            ignore_index,
+            absent_score,
+            threshold,
+            reduction,
+            compute_on_step,
+            dist_sync_on_step,
+            process_group,
         )

torchmetrics/classification/matthews_corrcoef.py

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from typing import Any, Callable, Optional
-from warnings import warn
 
 import torch
+from deprecate import deprecated, void
 from torch import Tensor
 
 from torchmetrics.functional.classification.matthews_corrcoef import (
@@ -126,6 +126,7 @@ class MatthewsCorrcoef(MatthewsCorrCoef):
         Renamed in favor of :class:`torchmetrics.MatthewsCorrCoef`. Will be removed in v0.8.
     """
 
+    @deprecated(target=MatthewsCorrCoef, deprecated_in="0.7", remove_in="0.8")
     def __init__(
         self,
         num_classes: int,
@@ -135,8 +136,4 @@ def __init__(
         process_group: Optional[Any] = None,
         dist_sync_fn: Callable = None,
     ) -> None:
-        warn(
-            "`MatthewsCorrcoef` was renamed to `MatthewsCorrCoef` in v0.7 and it will be removed in v0.8",
-            DeprecationWarning,
-        )
-        super().__init__(num_classes, threshold, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)
+        void(num_classes, threshold, compute_on_step, dist_sync_on_step, process_group, dist_sync_fn)

torchmetrics/functional/audio/pit.py

@@ -16,6 +16,7 @@
 from warnings import warn
 
 import torch
+from deprecate import deprecated, void
 from torch import Tensor
 
 from torchmetrics.utilities.checks import _check_same_shape
@@ -178,13 +179,12 @@ def permutation_invariant_training(
     return best_metric, best_perm
 
 
+@deprecated(target=permutation_invariant_training, deprecated_in="0.7", remove_in="0.8")
 def pit(
     preds: torch.Tensor, target: torch.Tensor, metric_func: Callable, eval_func: str = "max", **kwargs: Dict[str, Any]
 ) -> Tuple[Tensor, Tensor]:
     """Permutation invariant training. The ``pit`` implements the famous Permutation Invariant Training method.
 
-    [1] in speech separation field in order to calculate audio metrics in a permutation invariant way.
-
     .. deprecated:: v0.7
         Use :func:`torchmetrics.functional.permutation_invariant_training`. Will be removed in v0.8.
 
@@ -202,15 +202,8 @@ def pit(
         >>> pit_permutate(preds, best_perm)
         tensor([[[-0.0579,  0.3560, -0.9604],
                  [-0.1719,  0.3205,  0.2951]]])
-
-    Reference:
-        [1]	`Permutation Invariant Training of Deep Models`_
     """
-    warn(
-        "`pit` was renamed to `permutation_invariant_training` in v0.7 and it will be removed in v0.8",
-        DeprecationWarning,
-    )
-    return permutation_invariant_training(preds, target, metric_func, eval_func, **kwargs)
+    return void(preds, target, metric_func, eval_func, **kwargs)
 
 
 def pit_permutate(preds: Tensor, perm: Tensor) -> Tensor: