Updated class docstrings

Author: seanlaw

stumpy/floss.py

@@ -305,7 +305,7 @@ def fluss(I, L, n_regimes, excl_factor=5, custom_iac=None):
 
 class floss:
     """
-    Compute the Fast Low-cost Online Semantic Segmentation (FLOSS) for
+    A class to compute the Fast Low-cost Online Semantic Segmentation (FLOSS) for
     streaming data
 
     Parameters

stumpy/gpu_stimp.py

@@ -15,7 +15,7 @@
 )
 class gpu_stimp(_stimp):
     """
-    Compute the Pan Matrix Profile with with one or more GPU devices
+    A class to compute the Pan Matrix Profile with with one or more GPU devices
 
     This is based on the SKIMP algorithm.
 

stumpy/scrump.py

@@ -649,7 +649,7 @@ def prescrump(
 )
 class scrump:
     """
-    Compute an approximate z-normalized matrix profile
+    A class to ompute an approximate z-normalized matrix profile
 
     This is a convenience wrapper around the Numba JIT-compiled parallelized
     `_stump` function which computes the matrix profile according to SCRIMP.

stumpy/stimp.py

@@ -382,7 +382,7 @@ def M_(self):
 )
 class stimp(_stimp):
     """
-    Compute the Pan Matrix Profile
+    A class to compute the Pan Matrix Profile
 
     This is based on the SKIMP algorithm.
 
@@ -551,7 +551,7 @@ def __init__(
 )
 class stimped(_stimp):
     """
-    Compute the Pan Matrix Profile with a distributed dask/ray cluster
+    A class to compute the Pan Matrix Profile with a distributed dask/ray cluster
 
     This is based on the SKIMP algorithm.
 

stumpy/stumpi.py

@@ -17,7 +17,7 @@
 )
 class stumpi:
     """
-    Compute an incremental z-normalized matrix profile for streaming data
+    A class to compute an incremental z-normalized matrix profile for streaming data
 
     This is based on the on-line STOMPI and STAMPI algorithms.