Fixed docstrings and API docstrings

Author: seanlaw

docs/api.rst

@@ -36,7 +36,7 @@ stumped
 
 .. autofunction:: stumpy.stumped
 
-gpu-stump
+gpu_stump
 =========
 
 .. autofunction:: stumpy.gpu_stump(T_A, m, T_B=None, ignore_trivial=True, device_id=0, normalize=True)
@@ -98,7 +98,7 @@ ostinatoed
 gpu_ostinato
 ============
 
-.. autofunction:: gpu_ostinato(Ts, m, device_id=0, normalize=True)
+.. autofunction:: stumpy.gpu_ostinato(Ts, m, device_id=0, normalize=True)
 
 mpdist
 ======

stumpy/chains.py

@@ -11,6 +11,9 @@ def atsc(IL, IR, j):
     """
     Compute the anchored time series chain (ATSC)
 
+    Note that since the matrix profile indices, `IL` and `IR`, are pre-computed,
+    this function is agnostic to subsequence normalization.
+
     Parameters
     ----------
     IL : ndarray
@@ -53,6 +56,9 @@ def allc(IL, IR):
     """
     Compute the all-chain set (ALLC)
 
+    Note that since the matrix profile indices, `IL` and `IR`, are pre-computed,
+    this function is agnostic to subsequence normalization.
+
     Parameters
     ----------
     IL : ndarray

stumpy/stumpi.py

@@ -10,8 +10,9 @@
 @core.non_normalized(aampi)
 class stumpi(object):
     """
-    Compute an incremental z-normalized matrix profile for streaming data. This
-    is based on the on-line STOMPI and STAMPI algorithms.
+    Compute an incremental z-normalized matrix profile for streaming data
+
+    This is based on the on-line STOMPI and STAMPI algorithms.
 
     Parameters
     ----------