Move image gradient (#381)

* move

* format

* docs

* chlog

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

CHANGELOG.md

@@ -19,7 +19,10 @@ 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)):
+- Moved `psnr` and `ssim` from `torchmetrics.functional.regression.*` to `torchmetrics.functional.image.*` ([#382](https://github.com/PyTorchLightning/metrics/pull/382))
+
+
+- Moved `image_gradient` from `torchmetrics.functional.image_gradients` to `torchmetrics.functional.image.gradients` ([#381](https://github.com/PyTorchLightning/metrics/pull/381))
 
 
 ### Deprecated

docs/source/references/functional.rst

@@ -29,24 +29,6 @@ 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
@@ -211,6 +193,29 @@ to_onehot [func]
 .. autofunction:: torchmetrics.utilities.data.to_onehot
  :noindex:
 
+*************
+Image Metrics
+*************
+
+image_gradients [func]
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: torchmetrics.functional.image_gradients
+ :noindex:
+
+
+psnr [func]
+~~~~~~~~~~~
+
+.. autofunction:: torchmetrics.functional.psnr
+ :noindex:
+
+
+ssim [func]
+~~~~~~~~~~~
+
+.. autofunction:: torchmetrics.functional.ssim
+ :noindex:
 
 ******************
 Regression Metrics
@@ -230,13 +235,6 @@ explained_variance [func]
  :noindex:
 
 
-image_gradients [func]
-~~~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: torchmetrics.functional.image_gradients
- :noindex:
-
-
 mean_absolute_error [func]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

torchmetrics/functional/__init__.py

@@ -32,9 +32,9 @@
 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.gradients import image_gradients # 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
 from torchmetrics.functional.regression.explained_variance import explained_variance # noqa: F401

torchmetrics/functional/image/__init__.py

@@ -12,4 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from torchmetrics.functional.image.gradients import image_gradients # noqa: F401
 from torchmetrics.functional.image.psnr import psnr # noqa: F401