RMSE metric: documentation improved (#154)

gyrdym · Sep 17, 2020 · 4127052 · 4127052
1 parent c9e063c
commit 4127052
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,10 @@
 # Changelog
 
+## 15.2.3
+- Documentation for RMSE metric improved
+
 ## 15.2.2
-- Documentation for MAPE metrics improved
+- Documentation for MAPE metric improved
 
 ## 15.2.1
 - `classificationMetrics` constant list added

diff --git a/lib/src/metric/metric_type.dart b/lib/src/metric/metric_type.dart
@@ -4,10 +4,10 @@ enum MetricType {
   /// is:
   ///
   ///
-  /// ![{\mbox{Score}}={\frac{1}{n}}\sum_{{t=1}}^{n}\left|{\frac{Y_{t}-\widehat{Y}_{t}}{Y_{t}}}\right|](https://latex.codecogs.com/gif.latex?%7B%5Cmbox%7BScore%7D%7D%3D%7B%5Cfrac%7B1%7D%7Bn%7D%7D%5Csum_%7B%7Bt%3D1%7D%7D%5E%7Bn%7D%5Cleft%7C%7B%5Cfrac%7BY_%7Bt%7D-%5Cwidehat%7BY%7D_%7Bt%7D%7D%7BY_%7Bt%7D%7D%7D%5Cright%7C)
+  /// ![{\mbox{Score}}={\frac{1}{n}}\sum_{{t=1}}^{n}\left|{\frac{y_{t}-\widehat{y}_{t}}{y_{t}}}\right|](https://latex.codecogs.com/gif.latex?%7B%5Cmbox%7BScore%7D%7D%3D%7B%5Cfrac%7B1%7D%7Bn%7D%7D%5Csum_%7B%7Bt%3D1%7D%7D%5E%7Bn%7D%5Cleft%7C%7B%5Cfrac%7By_%7Bt%7D-%5Cwidehat%7By%7D_%7Bt%7D%7D%7By_%7Bt%7D%7D%7D%5Cright%7C)
   ///
   ///
-  /// where Y - original value, Y with hat - predicted one
+  /// where y - original value, y with hat - predicted one
   /// 
   ///
   /// The less the score produced by the metric, the better the prediction's
@@ -17,8 +17,17 @@ enum MetricType {
   /// can produce scores which are greater than 1.
   mape,
 
-  /// Root mean squared error, a regression metric. The less the score produced
-  /// by the metric, the better the prediction's quality is. The metric produces
+  /// Root mean squared error (RMSE), a regression metric. The formula is:
+  ///
+  ///
+  /// ![{\mbox{Score}}=\sqrt{\frac{1}{n}\sum_{{t=1}}^{n}({\widehat{y}_{t} - y_{t}})^2}](https://latex.codecogs.com/gif.latex?%7B%5Cmbox%7BScore%7D%7D%3D%5Csqrt%7B%5Cfrac%7B1%7D%7Bn%7D%5Csum_%7B%7Bt%3D1%7D%7D%5E%7Bn%7D%28%7B%5Cwidehat%7By%7D_%7Bt%7D%20-%20y_%7Bt%7D%7D%29%5E2%7D)
+  ///
+  ///
+  ///  where `y` is an original value, `y` with hat - predicted one
+  ///
+  ///
+  /// The less the score
+  /// produced by the metric, the better the prediction's quality is. The metric produces
   /// scores within the range [0, +Infinity]
   rmse,
 

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: ml_algo
 description: Machine learning algorithms, Machine learning models performance evaluation functionality
-version: 15.2.2
+version: 15.2.3
 homepage: https://github.com/gyrdym/ml_algo
 
 environment: