docs

Lightning-AI · Jul 16, 2021 · 4d14cab · 4d14cab
1 parent 9d2b4cd
commit 4d14cab
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 35 deletions.
diff --git a/docs/source/references/functional.rst b/docs/source/references/functional.rst
@@ -30,6 +30,20 @@ snr [func]
  :noindex:
 
 
+psnr [func]
+~~~~~~~~~~~
+
+.. autofunction:: torchmetrics.functional.psnr
+ :noindex:
+
+
+ssim [func]
+~~~~~~~~~~~
+
+.. autofunction:: torchmetrics.functional.ssim
+ :noindex:
+
+
 **********************
 Classification Metrics
 **********************
@@ -114,10 +128,10 @@ iou [func]
 .. autofunction:: torchmetrics.functional.iou
  :noindex:
 
-kldivergence [func]
-~~~~~~~~~~~~~~~~~~~
+kl_divergence [func]
+~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: torchmetrics.functional.kldivergence
+.. autofunction:: torchmetrics.functional.kl_divergence
  :noindex:
 
 matthews_corrcoef [func]
@@ -127,7 +141,7 @@ matthews_corrcoef [func]
  :noindex:
 
 roc [func]
-~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~
 
 .. autofunction:: torchmetrics.functional.roc
  :noindex:
@@ -254,17 +268,10 @@ pearson_corrcoef [func]
  :noindex:
 
 
-psnr [func]
-~~~~~~~~~~~
-
-.. autofunction:: torchmetrics.functional.psnr
- :noindex:
-
-
-r2score [func]
-~~~~~~~~~~~~~~
+r2_score [func]
+~~~~~~~~~~~~~~~
 
-.. autofunction:: torchmetrics.functional.r2score
+.. autofunction:: torchmetrics.functional.r2_score
  :noindex:
 
 
@@ -275,13 +282,6 @@ spearman_corrcoef [func]
  :noindex:
 
 
-ssim [func]
-~~~~~~~~~~~
-
-.. autofunction:: torchmetrics.functional.ssim
- :noindex:
-
-
 ***
 NLP
 ***

diff --git a/docs/source/references/modules.rst b/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
 ~~~~~~~
 
@@ -396,13 +403,6 @@ SpearmanCorrcoef
  :noindex:
 
 
-SSIM
-~~~~
-
-.. autoclass:: torchmetrics.SSIM
- :noindex:
-
-
 
 *********
 Retrieval