Merge branch 'master' into r2_move_error

torchmetrics/functional/regression/r2.py

@@ -121,13 +121,13 @@ def r2_score(
     r"""
     Computes r2 score also known as `coefficient of determination`_:
 
-    .. math:: R^2 = 1 - \frac{SS_res}{SS_tot}
+    .. math:: R^2 = 1 - \frac{SS_{res}}{SS_{tot}}
 
-    where :math:`SS_res=\sum_i (y_i - f(x_i))^2` is the sum of residual squares, and
-    :math:`SS_tot=\sum_i (y_i - \bar{y})^2` is total sum of squares. Can also calculate
+    where :math:`SS_{res}=\sum_i (y_i - f(x_i))^2` is the sum of residual squares, and
+    :math:`SS_{tot}=\sum_i (y_i - \bar{y})^2` is total sum of squares. Can also calculate
     adjusted r2 score given by
 
-    .. math:: R^2_adj = 1 - \frac{(1-R^2)(n-1)}{n-k-1}
+    .. math:: R^2_{adj} = 1 - \frac{(1-R^2)(n-1)}{n-k-1}
 
     where the parameter :math:`k` (the number of independent regressors) should
     be provided as the ``adjusted`` argument.

torchmetrics/regression/r2.py

@@ -24,13 +24,13 @@ class R2Score(Metric):
     r"""
     Computes r2 score also known as `coefficient of determination`_:
 
-    .. math:: R^2 = 1 - \frac{SS_res}{SS_tot}
+    .. math:: R^2 = 1 - \frac{SS_{res}}{SS_{tot}}
 
-    where :math:`SS_res=\sum_i (y_i - f(x_i))^2` is the sum of residual squares, and
-    :math:`SS_tot=\sum_i (y_i - \bar{y})^2` is total sum of squares. Can also calculate
+    where :math:`SS_{res}=\sum_i (y_i - f(x_i))^2` is the sum of residual squares, and
+    :math:`SS_{tot}=\sum_i (y_i - \bar{y})^2` is total sum of squares. Can also calculate
     adjusted r2 score given by
 
-    .. math:: R^2_adj = 1 - \frac{(1-R^2)(n-1)}{n-k-1}
+    .. math:: R^2_{adj} = 1 - \frac{(1-R^2)(n-1)}{n-k-1}
 
     where the parameter :math:`k` (the number of independent regressors) should
     be provided as the `adjusted` argument.