minor tweaks in documenation of mse and mae

cjekel · Aug 6, 2022 · 83dd839 · 83dd839
1 parent 79e5ed5
commit 83dd839
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/docs/similaritymeasures.html b/docs/similaritymeasures.html
@@ -910,7 +910,7 @@ <h1 class="title">Module <code>similaritymeasures.similaritymeasures</code></h1>
 
 def mae(exp_data, num_data):
  &#34;&#34;&#34;
- Compute the Mean Absolute distance.
+ Compute the Mean Absolute Error (MAE).
 
  This computes the mean of absolute values of distances between two curves.
  Each curve must have the same number of data points and the same dimension.
@@ -935,9 +935,9 @@ <h1 class="title">Module <code>similaritymeasures.similaritymeasures</code></h1>
 
 def mse(exp_data, num_data):
  &#34;&#34;&#34;
- Compute the Mean Squared distance.
+ Compute the Mean Squared Error (MAE).
 
- This computes the mean of Sqaured distances between two curves.
+ This computes the mean of sqaured distances between two curves.
  Each curve must have the same number of data points and the same dimension.
 
  Parameters
@@ -1934,7 +1934,7 @@ <h2 id="returns">Returns</h2>
 <span>def <span class="ident">mae</span></span>(<span>exp_data, num_data)</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Compute the Mean Absolute distance.</p>
+<div class="desc"><p>Compute the Mean Absolute Error (MAE).</p>
 <p>This computes the mean of absolute values of distances between two curves.
 Each curve must have the same number of data points and the same dimension.</p>
 <h2 id="parameters">Parameters</h2>
@@ -1957,7 +1957,7 @@ <h2 id="returns">Returns</h2>
 </summary>
 <pre><code class="python">def mae(exp_data, num_data):
  &#34;&#34;&#34;
- Compute the Mean Absolute distance.
+ Compute the Mean Absolute Error (MAE).
 
  This computes the mean of absolute values of distances between two curves.
  Each curve must have the same number of data points and the same dimension.
@@ -2080,8 +2080,8 @@ <h2 id="notes">Notes</h2>
 <span>def <span class="ident">mse</span></span>(<span>exp_data, num_data)</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Compute the Mean Squared distance.</p>
-<p>This computes the mean of Sqaured distances between two curves.
+<div class="desc"><p>Compute the Mean Squared Error (MAE).</p>
+<p>This computes the mean of sqaured distances between two curves.
 Each curve must have the same number of data points and the same dimension.</p>
 <h2 id="parameters">Parameters</h2>
 <dl>
@@ -2103,9 +2103,9 @@ <h2 id="returns">Returns</h2>
 </summary>
 <pre><code class="python">def mse(exp_data, num_data):
  &#34;&#34;&#34;
- Compute the Mean Squared distance.
+ Compute the Mean Squared Error (MAE).
 
- This computes the mean of Sqaured distances between two curves.
+ This computes the mean of sqaured distances between two curves.
  Each curve must have the same number of data points and the same dimension.
 
  Parameters

diff --git a/similaritymeasures/similaritymeasures.py b/similaritymeasures/similaritymeasures.py
@@ -882,7 +882,7 @@ def dtw_path(d):
 
 def mae(exp_data, num_data):
  """
- Compute the Mean Absolute distance.
+ Compute the Mean Absolute Error (MAE).
 
  This computes the mean of absolute values of distances between two curves.
  Each curve must have the same number of data points and the same dimension.
@@ -907,9 +907,9 @@ def mae(exp_data, num_data):
 
 def mse(exp_data, num_data):
  """
- Compute the Mean Squared distance.
+ Compute the Mean Squared Error (MAE).
 
- This computes the mean of Sqaured distances between two curves.
+ This computes the mean of sqaured distances between two curves.
  Each curve must have the same number of data points and the same dimension.
 
  Parameters