Skip to content

Commit 0aece98

Browse files
committed
tweak error docstrings
1 parent 5d7ee0e commit 0aece98

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

specparam/measures/gof.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def compute_mean_abs_error(power_spectrum, modeled_spectrum):
7676
Returns
7777
-------
7878
error : float
79-
Computed MAE.
79+
Computed mean absolute error.
8080
"""
8181

8282
error = np.abs(power_spectrum - modeled_spectrum).mean()
@@ -97,7 +97,7 @@ def compute_mean_squared_error(power_spectrum, modeled_spectrum):
9797
Returns
9898
-------
9999
error : float
100-
Computed MSE.
100+
Computed mean squared error.
101101
"""
102102

103103
error = ((power_spectrum - modeled_spectrum) ** 2).mean()
@@ -118,7 +118,7 @@ def compute_root_mean_squared_error(power_spectrum, modeled_spectrum):
118118
Returns
119119
-------
120120
error : float
121-
Computed rMSE.
121+
Computed root mean squared error.
122122
"""
123123

124124
error = np.sqrt(((power_spectrum - modeled_spectrum) ** 2).mean())
@@ -127,7 +127,7 @@ def compute_root_mean_squared_error(power_spectrum, modeled_spectrum):
127127

128128

129129
def compute_median_abs_error(power_spectrum, modeled_spectrum):
130-
"""Calculate the median absolute error between original data and a model fit of that data.
130+
"""Calculate the median absolute error.
131131
132132
Parameters
133133
----------

0 commit comments

Comments
 (0)