v1.9.1

Author: seanlaw

CHANGELOG.md

@@ -1,3 +1,38 @@
+# 2021-07-20    [ 1.9.0 ]:
+--------------------------
+* bugfixes
+  - Fixed scenarios where n_chunks == 0 in _get_array_ranges and fixed empty input array edge case
+* features
+  - Added `normalize` to `core.mass`
+  - Added motif discovery (`stumpy.motifs` and `stumpy.match`)
+  - Added snippets for identifying regimes (`stumpy.snippets`)
+  - Added pan matrix profile (`stumpy.stimp`, `stumpy.stimped`, `stumpy.gpu_stimp`)
+  - Added `excl_zone` parameter to config.py (`config.STUMPY_EXCL_ZONE_DENOM`)
+* tasks
+  - Aggregate or Refactor Dask Unit Tests
+  - Added script for testing latest Numba release candidate
+  - Converted bash scripts to [[ ... ]] construct
+  - Updated Python class declaration
+  - Updated to RTD to PyData Sphinx Theme
+  - Updated conda installation environment
+  - Refactored test files and added check to ensure that naive implementations always come ahead of tests
+* documentation
+  - Corrected binder badges to point to "main"
+  - Updated tutorial to discover motif/discord indices
+  - Added missing docstrings and fixed minor typos
+  - Added missing logo file and favicon to _static directory
+  - Updated source installation instructions
+  - Added instructions for Apple M1 chip
+  - Updated Contributor guide
+  - Added include/discords tutorial example to subspace
+  - Added bonus content on interpreting the columns of a matrix profile
+  - Added syntax highlighting to tutorials
+  - Replaced matplotlib params with style file
+  - Added Annotation Vectors Tutorial
+  - Added Binder links to top of tutorials
+  - Added introduction to Snippets Tutorial
+
+
 # 2021-02-04    [ 1.8.0 ]:
 --------------------------
 * bugfixes

README.rst

@@ -57,6 +57,8 @@ STUMPY is a powerful and scalable library that efficiently computes something ca
 * streaming (on-line) data
 * fast approximate matrix profiles
 * time series chains (temporally ordered set of subsequence patterns)
+* snippets for summarizing long time series
+* pan matrix profiles for selecting the best subsequence window size(s)
 * `and more ... <https://www.cs.ucr.edu/~eamonn/100_Time_Series_Data_Mining_Questions__with_Answers.pdf>`__
 
 Whether you are an academic, data scientist, software developer, or time series enthusiast, STUMPY is straightforward to install and our goal is to allow you to get to your time series insights faster. See `documentation <https://stumpy.readthedocs.io/en/latest/>`__ for more information.

docs/Tutorial_The_Matrix_Profile.ipynb

@@ -328,6 +328,22 @@
     "distance_profile[zone_start : zone_end] = np.inf\n",
     "```\n",
     "\n",
+    "Finally, it is very uncommon for users to need to change the default exclusion zone. However, in exceptionally rare cases, the exclusion zone can be changed globally in STUMPY through the `config.STUMPY_EXCL_ZONE_DENOM` parameter where all exclusion zones are computed as `i ± int(np.ceil(m / config.STUMPY_EXCL_ZONE_DENOM))`:\n",
+    "\n",
+    "```\n",
+    "import stumpy\n",
+    "from stumpy import config\n",
+    "\n",
+    "config.STUMPY_EXCL_ZONE_DENOM = 4  # The exclusion zone is i ± int(np.ceil(m / 4)) and is the same as the default setting\n",
+    "mp = stumpy.stump(T, m)\n",
+    "\n",
+    "config.STUMPY_EXCL_ZONE_DENOM = 1  # The exclusion zone is i ± m\n",
+    "mp = stumpy.stump(T, m)\n",
+    "\n",
+    "config.STUMPY_EXCL_ZONE_DENOM = np.inf  # The exclusion zone is i ± 0 and is the same as applying no exclusion zone\n",
+    "mp = stumpy.stump(T, m)\n",
+    "```\n",
+    "\n",
     "## Resources\n",
     "\n",
     "\n",
@@ -339,7 +355,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -353,7 +369,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.9"
+   "version": "3.9.6"
   }
  },
  "nbformat": 4,

docs/api.rst

@@ -29,6 +29,9 @@ STUMPY API
     stumpy.motifs
     stumpy.match
     stumpy.snippets
+    stumpy.stimp
+    stumpy.stimped
+    stumpy.gpu_stimp
 
 stump
 =====
@@ -138,3 +141,18 @@ snippets
 ========
 
 .. autofunction:: stumpy.snippets
+
+stimp
+=====
+
+.. autofunction:: stumpy.stimp
+
+stimped
+=======
+
+.. autofunction:: stumpy.stimped
+
+gpu_stimp
+=========
+
+.. autofunction:: stumpy.gpu_stimp

setup.py

@@ -28,7 +28,7 @@ def get_extras_require():
 
 configuration = {
     "name": "stumpy",
-    "version": "1.8.0",
+    "version": "1.9.1",
     "python_requires=": ">=3.6",
     "author": "Sean M. Law",
     "author_email": "seanmylaw@gmail.com",