Add mean error metric (#203)

* Add mean error metric * Update docstring remove rmse * Update docstring * precomit * Add me to init and create docs * iResort * Comments fixed Co-authored-by: ahuang11 <[email protected]>
xarray-contrib · Oct 7, 2020 · 5252261 · 5252261
1 parent e0c9667
commit 5252261
Show file tree

Hide file tree

Showing 57 changed files with 194 additions and 59 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,12 @@ Changelog History
 xskillscore v0.0.19 (2020-XX-XX)
 --------------------------------
 
+Features
+~~~~~~~~
+- Added mean error
+  :py:func:`~xskillscore.me`. (:issue:`202`, :pr:`200`)
+  `Andrew Huang`_
+
 Internal Changes
 ~~~~~~~~~~~~~~~~
 - Added Python 3.7 and Python 3.8 to the CI. Use the latest version of Python 3

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -31,6 +31,7 @@ Distance Metrics
 .. autosummary::
     :toctree: api/
 
+    me
     rmse
     mse
     mae

diff --git a/docs/source/api/xskillscore.Contingency.accuracy.rst b/docs/source/api/xskillscore.Contingency.accuracy.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.accuracy
+.. automethod:: Contingency.accuracy
diff --git a/docs/source/api/xskillscore.Contingency.bias_score.rst b/docs/source/api/xskillscore.Contingency.bias_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.bias_score
+.. automethod:: Contingency.bias_score
diff --git a/docs/source/api/xskillscore.Contingency.correct_negatives.rst b/docs/source/api/xskillscore.Contingency.correct_negatives.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.correct_negatives
+.. automethod:: Contingency.correct_negatives
diff --git a/docs/source/api/xskillscore.Contingency.equit_threat_score.rst b/docs/source/api/xskillscore.Contingency.equit_threat_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.equit_threat_score
+.. automethod:: Contingency.equit_threat_score
diff --git a/docs/source/api/xskillscore.Contingency.false_alarm_rate.rst b/docs/source/api/xskillscore.Contingency.false_alarm_rate.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.false_alarm_rate
+.. automethod:: Contingency.false_alarm_rate
diff --git a/docs/source/api/xskillscore.Contingency.false_alarm_ratio.rst b/docs/source/api/xskillscore.Contingency.false_alarm_ratio.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.false_alarm_ratio
+.. automethod:: Contingency.false_alarm_ratio
diff --git a/docs/source/api/xskillscore.Contingency.false_alarms.rst b/docs/source/api/xskillscore.Contingency.false_alarms.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.false_alarms
+.. automethod:: Contingency.false_alarms
diff --git a/docs/source/api/xskillscore.Contingency.gerrity_score.rst b/docs/source/api/xskillscore.Contingency.gerrity_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.gerrity_score
+.. automethod:: Contingency.gerrity_score
diff --git a/docs/source/api/xskillscore.Contingency.heidke_score.rst b/docs/source/api/xskillscore.Contingency.heidke_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.heidke_score
+.. automethod:: Contingency.heidke_score
diff --git a/docs/source/api/xskillscore.Contingency.hit_rate.rst b/docs/source/api/xskillscore.Contingency.hit_rate.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.hit_rate
+.. automethod:: Contingency.hit_rate
diff --git a/docs/source/api/xskillscore.Contingency.hits.rst b/docs/source/api/xskillscore.Contingency.hits.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.hits
+.. automethod:: Contingency.hits
diff --git a/docs/source/api/xskillscore.Contingency.misses.rst b/docs/source/api/xskillscore.Contingency.misses.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.misses
+.. automethod:: Contingency.misses
diff --git a/docs/source/api/xskillscore.Contingency.odds_ratio.rst b/docs/source/api/xskillscore.Contingency.odds_ratio.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.odds_ratio
+.. automethod:: Contingency.odds_ratio
diff --git a/docs/source/api/xskillscore.Contingency.odds_ratio_skill_score.rst b/docs/source/api/xskillscore.Contingency.odds_ratio_skill_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.odds_ratio_skill_score
+.. automethod:: Contingency.odds_ratio_skill_score
diff --git a/docs/source/api/xskillscore.Contingency.peirce_score.rst b/docs/source/api/xskillscore.Contingency.peirce_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.peirce_score
+.. automethod:: Contingency.peirce_score
diff --git a/docs/source/api/xskillscore.Contingency.rst b/docs/source/api/xskillscore.Contingency.rst
@@ -47,4 +47,4 @@
       ~Contingency.observations
       ~Contingency.table
 
-
+
diff --git a/docs/source/api/xskillscore.Contingency.success_ratio.rst b/docs/source/api/xskillscore.Contingency.success_ratio.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.success_ratio
+.. automethod:: Contingency.success_ratio
diff --git a/docs/source/api/xskillscore.Contingency.table.rst b/docs/source/api/xskillscore.Contingency.table.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autoproperty:: Contingency.table
+.. autoproperty:: Contingency.table
diff --git a/docs/source/api/xskillscore.Contingency.threat_score.rst b/docs/source/api/xskillscore.Contingency.threat_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. automethod:: Contingency.threat_score
+.. automethod:: Contingency.threat_score
diff --git a/docs/source/api/xskillscore.brier_score.rst b/docs/source/api/xskillscore.brier_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: brier_score
+.. autofunction:: brier_score
diff --git a/docs/source/api/xskillscore.crps_ensemble.rst b/docs/source/api/xskillscore.crps_ensemble.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: crps_ensemble
+.. autofunction:: crps_ensemble
diff --git a/docs/source/api/xskillscore.crps_gaussian.rst b/docs/source/api/xskillscore.crps_gaussian.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: crps_gaussian
+.. autofunction:: crps_gaussian
diff --git a/docs/source/api/xskillscore.crps_quadrature.rst b/docs/source/api/xskillscore.crps_quadrature.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: crps_quadrature
+.. autofunction:: crps_quadrature
diff --git a/docs/source/api/xskillscore.discrimination.rst b/docs/source/api/xskillscore.discrimination.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: discrimination
+.. autofunction:: discrimination
diff --git a/docs/source/api/xskillscore.effective_sample_size.rst b/docs/source/api/xskillscore.effective_sample_size.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: effective_sample_size
+.. autofunction:: effective_sample_size
diff --git a/docs/source/api/xskillscore.mae.rst b/docs/source/api/xskillscore.mae.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: mae
+.. autofunction:: mae
diff --git a/docs/source/api/xskillscore.mape.rst b/docs/source/api/xskillscore.mape.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: mape
+.. autofunction:: mape
diff --git a/docs/source/api/xskillscore.me.rst b/docs/source/api/xskillscore.me.rst
@@ -0,0 +1,6 @@
+xskillscore.me
+================
+
+.. currentmodule:: xskillscore
+
+.. autofunction:: me
diff --git a/docs/source/api/xskillscore.median_absolute_error.rst b/docs/source/api/xskillscore.median_absolute_error.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: median_absolute_error
+.. autofunction:: median_absolute_error
diff --git a/docs/source/api/xskillscore.mse.rst b/docs/source/api/xskillscore.mse.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: mse
+.. autofunction:: mse
diff --git a/docs/source/api/xskillscore.pearson_r.rst b/docs/source/api/xskillscore.pearson_r.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: pearson_r
+.. autofunction:: pearson_r
diff --git a/docs/source/api/xskillscore.pearson_r_eff_p_value.rst b/docs/source/api/xskillscore.pearson_r_eff_p_value.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: pearson_r_eff_p_value
+.. autofunction:: pearson_r_eff_p_value
diff --git a/docs/source/api/xskillscore.pearson_r_p_value.rst b/docs/source/api/xskillscore.pearson_r_p_value.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: pearson_r_p_value
+.. autofunction:: pearson_r_p_value
diff --git a/docs/source/api/xskillscore.r2.rst b/docs/source/api/xskillscore.r2.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: r2
+.. autofunction:: r2
diff --git a/docs/source/api/xskillscore.rank_histogram.rst b/docs/source/api/xskillscore.rank_histogram.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: rank_histogram
+.. autofunction:: rank_histogram
diff --git a/docs/source/api/xskillscore.reliability.rst b/docs/source/api/xskillscore.reliability.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: reliability
+.. autofunction:: reliability
diff --git a/docs/source/api/xskillscore.rmse.rst b/docs/source/api/xskillscore.rmse.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: rmse
+.. autofunction:: rmse
diff --git a/docs/source/api/xskillscore.rps.rst b/docs/source/api/xskillscore.rps.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: rps
+.. autofunction:: rps
diff --git a/docs/source/api/xskillscore.sign_test.rst b/docs/source/api/xskillscore.sign_test.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: sign_test
+.. autofunction:: sign_test
diff --git a/docs/source/api/xskillscore.smape.rst b/docs/source/api/xskillscore.smape.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: smape
+.. autofunction:: smape
diff --git a/docs/source/api/xskillscore.spearman_r.rst b/docs/source/api/xskillscore.spearman_r.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: spearman_r
+.. autofunction:: spearman_r
diff --git a/docs/source/api/xskillscore.spearman_r_eff_p_value.rst b/docs/source/api/xskillscore.spearman_r_eff_p_value.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: spearman_r_eff_p_value
+.. autofunction:: spearman_r_eff_p_value
diff --git a/docs/source/api/xskillscore.spearman_r_p_value.rst b/docs/source/api/xskillscore.spearman_r_p_value.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: spearman_r_p_value
+.. autofunction:: spearman_r_p_value
diff --git a/docs/source/api/xskillscore.threshold_brier_score.rst b/docs/source/api/xskillscore.threshold_brier_score.rst
@@ -3,4 +3,4 @@
 
 .. currentmodule:: xskillscore
 
-.. autofunction:: threshold_brier_score
+.. autofunction:: threshold_brier_score
diff --git a/docs/source/quick-start.ipynb b/docs/source/quick-start.ipynb
@@ -69,6 +69,7 @@
     "\n",
     "### Distance-Based\n",
     "\n",
+    "* Mean Error (`me`)\n",
     "* Root Mean Squared Error (`rmse`)\n",
     "* Mean Squared Error (`mse`)\n",
     "* Mean Absolute Error (`mae`)\n",

diff --git a/xskillscore/__init__.py b/xskillscore/__init__.py
@@ -8,6 +8,7 @@
     effective_sample_size,
     mae,
     mape,
+    me,
     median_absolute_error,
     mse,
     pearson_r,

diff --git a/xskillscore/core/accessor.py b/xskillscore/core/accessor.py
@@ -4,6 +4,7 @@
     effective_sample_size,
     mae,
     mape,
+    me,
     median_absolute_error,
     mse,
     pearson_r,
@@ -84,6 +85,11 @@ def spearman_r_eff_p_value(self, a, b, *args, **kwargs):
         b = self._in_ds(b)
         return spearman_r_eff_p_value(a, b, *args, **kwargs)
 
+    def me(self, a, b, *args, **kwargs):
+        a = self._in_ds(a)
+        b = self._in_ds(b)
+        return me(a, b, *args, **kwargs)
+
     def rmse(self, a, b, *args, **kwargs):
         a = self._in_ds(a)
         b = self._in_ds(b)
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,6 +31,7 @@ Distance Metrics @@
     .. autosummary::
         :toctree: api/
+        me
         rmse
         mse
         mae
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,4 +3,4 @@

		.. currentmodule:: xskillscore

		.. automethod:: Contingency.accuracy
		.. automethod:: Contingency.accuracy
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,4 +47,4 @@
		~Contingency.observations
		~Contingency.table