move functional psnr & ssim to image (#382)

* psnr

* ssim

* docs

* chlog

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Moved `psnr` and `ssim` from `torchmetrics.functional.regression.*` to `torchmetrics.functional.image.*` ([#382](https://github.com/PyTorchLightning/metrics/pull/382)):
+
 
 ### Deprecated
 
@@ -33,6 +35,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed restriction that `preds` could not be bigger than `num_classes` to support logit input ([#357](https://github.com/PyTorchLightning/metrics/pull/357))
 
 
+- Removed module `torchmetrics.regression.psnr` and `torchmetrics.regression.ssim` ([#382](https://github.com/PyTorchLightning/metrics/pull/382)):
+
+
 ### Fixed
 
 

docs/source/references/functional.rst

@@ -29,6 +29,24 @@ snr [func]
 .. autofunction:: torchmetrics.functional.snr
  :noindex:
 
+*************
+Image Metrics
+*************
+
+
+psnr [func]
+~~~~~~~~~~~
+
+.. autofunction:: torchmetrics.functional.psnr
+ :noindex:
+
+
+ssim [func]
+~~~~~~~~~~~
+
+.. autofunction:: torchmetrics.functional.ssim
+ :noindex:
+
 
 **********************
 Classification Metrics
@@ -254,13 +272,6 @@ pearson_corrcoef [func]
  :noindex:
 
 
-psnr [func]
-~~~~~~~~~~~
-
-.. autofunction:: torchmetrics.functional.psnr
- :noindex:
-
-
 r2score [func]
 ~~~~~~~~~~~~~~
 
@@ -275,13 +286,6 @@ spearman_corrcoef [func]
  :noindex:
 
 
-ssim [func]
-~~~~~~~~~~~
-
-.. autofunction:: torchmetrics.functional.ssim
- :noindex:
-
-
 symmetric_mean_absolute_percentage_error [func]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/source/references/modules.rst

@@ -322,6 +322,20 @@ KID
 .. autoclass:: torchmetrics.KID
  :noindex:
 
+
+PSNR
+~~~~
+
+.. autoclass:: torchmetrics.PSNR
+ :noindex:
+
+
+SSIM
+~~~~
+
+.. autoclass:: torchmetrics.SSIM
+ :noindex:
+
 ******************
 Regression Metrics
 ******************
@@ -375,13 +389,6 @@ PearsonCorrcoef
  :noindex:
 
 
-PSNR
-~~~~
-
-.. autoclass:: torchmetrics.PSNR
- :noindex:
-
-
 R2Score
 ~~~~~~~
 
@@ -395,13 +402,6 @@ SpearmanCorrcoef
 .. autoclass:: torchmetrics.SpearmanCorrcoef
  :noindex:
 
-
-SSIM
-~~~~
-
-.. autoclass:: torchmetrics.SSIM
- :noindex:
-
 SymmetricMeanAbsolutePercentageError
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

torchmetrics/__init__.py

@@ -38,11 +38,9 @@
  StatScores,
 )
 from torchmetrics.collections import MetricCollection # noqa: F401 E402
-from torchmetrics.image import FID, IS, KID # noqa: F401 E402
+from torchmetrics.image import FID, IS, KID, PSNR, SSIM # noqa: F401 E402
 from torchmetrics.metric import Metric # noqa: F401 E402
 from torchmetrics.regression import ( # noqa: F401 E402
- PSNR,
- SSIM,
  CosineSimilarity,
  ExplainedVariance,
  MeanAbsoluteError,

torchmetrics/functional/__init__.py

@@ -32,6 +32,8 @@
 from torchmetrics.functional.classification.roc import roc # noqa: F401
 from torchmetrics.functional.classification.specificity import specificity # noqa: F401
 from torchmetrics.functional.classification.stat_scores import stat_scores # noqa: F401
+from torchmetrics.functional.image.psnr import psnr # noqa: F401
+from torchmetrics.functional.image.ssim import ssim # noqa: F401
 from torchmetrics.functional.image_gradients import image_gradients # noqa: F401
 from torchmetrics.functional.nlp import bleu_score # noqa: F401
 from torchmetrics.functional.regression.cosine_similarity import cosine_similarity # noqa: F401
@@ -44,10 +46,8 @@
 from torchmetrics.functional.regression.mean_squared_error import mean_squared_error # noqa: F401
 from torchmetrics.functional.regression.mean_squared_log_error import mean_squared_log_error # noqa: F401
 from torchmetrics.functional.regression.pearson import pearson_corrcoef # noqa: F401
-from torchmetrics.functional.regression.psnr import psnr # noqa: F401
 from torchmetrics.functional.regression.r2 import r2_score, r2score # noqa: F401
 from torchmetrics.functional.regression.spearman import spearman_corrcoef # noqa: F401
-from torchmetrics.functional.regression.ssim import ssim # noqa: F401
 from torchmetrics.functional.regression.symmetric_mean_absolute_percentage_error import ( # noqa: F401
  symmetric_mean_absolute_percentage_error,
 )

torchmetrics/functional/image/__init__.py

@@ -0,0 +1,15 @@
+# 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 torchmetrics.functional.image.psnr import psnr # noqa: F401

torchmetrics/functional/regression/__init__.py

@@ -11,6 +11,8 @@
 # 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 torchmetrics.functional.image.psnr import psnr # noqa: F401
+from torchmetrics.functional.image.ssim import ssim # noqa: F401
 from torchmetrics.functional.regression.cosine_similarity import cosine_similarity # noqa: F401
 from torchmetrics.functional.regression.explained_variance import explained_variance # noqa: F401
 from torchmetrics.functional.regression.mean_absolute_error import mean_absolute_error # noqa: F401
@@ -20,7 +22,5 @@
 from torchmetrics.functional.regression.mean_squared_error import mean_squared_error # noqa: F401
 from torchmetrics.functional.regression.mean_squared_log_error import mean_squared_log_error # noqa: F401
 from torchmetrics.functional.regression.pearson import pearson_corrcoef # noqa: F401
-from torchmetrics.functional.regression.psnr import psnr # noqa: F401
 from torchmetrics.functional.regression.r2 import r2_score # noqa: F401
 from torchmetrics.functional.regression.spearman import spearman_corrcoef # noqa: F401
-from torchmetrics.functional.regression.ssim import ssim # noqa: F401

torchmetrics/image/psnr.py

@@ -16,7 +16,7 @@
 import torch
 from torch import Tensor, tensor
 
-from torchmetrics.functional.regression.psnr import _psnr_compute, _psnr_update
+from torchmetrics.functional.image.psnr import _psnr_compute, _psnr_update
 from torchmetrics.metric import Metric
 from torchmetrics.utilities import rank_zero_warn
 

torchmetrics/image/ssim.py

@@ -16,7 +16,7 @@
 import torch
 from torch import Tensor
 
-from torchmetrics.functional.regression.ssim import _ssim_compute, _ssim_update
+from torchmetrics.functional.image.ssim import _ssim_compute, _ssim_update
 from torchmetrics.metric import Metric
 from torchmetrics.utilities import rank_zero_warn
 from torchmetrics.utilities.data import dim_zero_cat

torchmetrics/regression/__init__.py

@@ -18,10 +18,8 @@
 from torchmetrics.regression.mean_squared_error import MeanSquaredError # noqa: F401
 from torchmetrics.regression.mean_squared_log_error import MeanSquaredLogError # noqa: F401
 from torchmetrics.regression.pearson import PearsonCorrcoef # noqa: F401
-from torchmetrics.regression.psnr import PSNR # noqa: F401
 from torchmetrics.regression.r2score import R2Score # noqa: F401
 from torchmetrics.regression.spearman import SpearmanCorrcoef # noqa: F401
-from torchmetrics.regression.ssim import SSIM # noqa: F401
 from torchmetrics.regression.symmetric_mean_absolute_percentage_error import ( # noqa: F401
  SymmetricMeanAbsolutePercentageError,
 )