From 1c81ba3032a0dd9802f9d04f1ceef6a5e7a9025e Mon Sep 17 00:00:00 2001 From: Sean Law Date: Mon, 15 Jun 2020 09:58:14 -0400 Subject: [PATCH] Adjusted docstrings --- stumpy/floss.py | 6 +++--- stumpy/scrump.py | 10 ++++++---- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/stumpy/floss.py b/stumpy/floss.py index 0a498e4cf..6a692a8fd 100644 --- a/stumpy/floss.py +++ b/stumpy/floss.py @@ -356,8 +356,8 @@ class floss(object): ------- update(t) Ingress a new data point, `t`, onto the time series, `T`, followed by egressing - a oldest single data point from `T`. Then, update the corrected arc curve (CAC) - and the matrix profile. + the oldest single data point from `T`. Then, update the 1-dimensional corrected + arc curve (CAC_1D) and the matrix profile. Notes ----- @@ -463,7 +463,7 @@ def __init__( def update(self, t): """ Ingress a new data point, `t`, onto the time series, `T`, followed by egressing - a oldest single data point from `T`. Then, update the 1-dimensional corrected + the oldest single data point from `T`. Then, update the 1-dimensional corrected arc curve (CAC_1D) and the matrix profile. Parameters diff --git a/stumpy/scrump.py b/stumpy/scrump.py index 2aad66078..2dcde2471 100644 --- a/stumpy/scrump.py +++ b/stumpy/scrump.py @@ -612,8 +612,9 @@ class scrump(object): Methods ------- update() - Update the matrix profile and matrix profile indices by computing additional - (as defined by `percentage`) new distances that make up the full distance matrix + Update the matrix profile and the matrix profile indices by computing + additional new distances (limited by `percentage`) that make up the full + distance matrix. Notes ----- @@ -747,8 +748,9 @@ def __init__( def update(self): """ - Update the matrix profile and matrix profile indices by computing additional - (as defined by `percentage`) new distances that make up the full distance matrix + Update the matrix profile and the matrix profile indices by computing + additional new distances (limited by `percentage`) that make up the full + distance matrix. """ if self._chunk <= self._n_chunks: orders_ranges = _get_orders_ranges(