Fixed #103 Finished MSTUMP Tutorial

Author: seanlaw

docs/Tutorial_Multidimensional_Motif_Discovery.ipynb

@@ -829,7 +829,7 @@
     "\n",
     "## STUMPED - Distributed STUMP\n",
     "\n",
-    "Alternatively, if you only have access to a cluster of CPUs and your data needs to stay behind your firewall, then `stump` and `gpu_stump` may not be sufficient for your needs. Instead, you can try `stumped`, a distributed and parallel implementation of `stump` that depends on Dask distributed:\n",
+    "Alternatively, if you only have access to a cluster of CPUs and your data needs to stay behind your firewall, then `stump` and `gpu_stump` may not be sufficient for your needs. Instead, you can try `stumped`, a distributed and parallel implementation of `stump` that depends on [Dask distributed](https://distributed.dask.org/en/latest/):\n",
     "\n",
     "```\n",
     "import stumpy\n",

docs/Tutorial_STUMPY_Basics.ipynb

@@ -14,6 +14,7 @@ STUMPY API
     stumpy.stumpi
     stumpy.mstump
     stumpy.mstumped
+    stumpy.subspace
     stumpy.aamp
     stumpy.aamped
     stumpy.gpu_aamp
@@ -70,6 +71,10 @@ mstumped
 
 .. autofunction:: stumpy.mstumped
 
+subspace
+========
+.. autofunction:: stumpy.subspace
+
 aamp
 ====
 

docs/api.rst

@@ -2,7 +2,7 @@
 import os.path
 from .stump import stump  # noqa: F401
 from .stumped import stumped  # noqa: F401
-from .mstump import mstump  # noqa: F401
+from .mstump import mstump, subspace  # noqa: F401
 from .mstumped import mstumped  # noqa: F401
 from .aamp import aamp  # noqa: F401
 from .aamped import aamped  # noqa: F401

stumpy/__init__.py

@@ -192,7 +192,7 @@ def _discretize(a, bins, right=True):
     return np.digitize(a, bins, right=right)
 
 
-def _get_subspace(T, m, subseq_idx, nn_idx, k, include=None, discords=False):
+def subspace(T, m, subseq_idx, nn_idx, k, include=None, discords=False):
     """
     Compute the multi-dimensional matrix profile subspace for a given subseq index and
     its nearest neighbor index

stumpy/mstump.py

@@ -2,15 +2,14 @@
 import numpy.testing as npt
 import pandas as pd
 from stumpy import core, config
-from stumpy import mstump
+from stumpy import mstump, subspace
 from stumpy.mstump import (
     _mstump,
     _multi_mass,
     _query_mstump_profile,
     _get_first_mstump_profile,
     _get_multi_QT,
     _apply_include,
-    _get_subspace,
 )
 import pytest
 import naive
@@ -141,7 +140,7 @@ def test_subspace(T, m):
 
     for k in range(T.shape[0]):
         ref_S = naive.subspace(T, m, motif_idx, nn_idx, k)
-        comp_S = _get_subspace(T, m, motif_idx, nn_idx, k)
+        comp_S = subspace(T, m, motif_idx, nn_idx, k)
         npt.assert_almost_equal(ref_S, comp_S)
 
 
@@ -155,7 +154,7 @@ def test_subspace_include(T, m):
 
             for k in range(T.shape[0]):
                 ref_S = naive.subspace(T, m, motif_idx, nn_idx, k, include)
-                comp_S = _get_subspace(T, m, motif_idx, nn_idx, k, include)
+                comp_S = subspace(T, m, motif_idx, nn_idx, k, include)
                 npt.assert_almost_equal(ref_S, comp_S)
 
 
@@ -166,7 +165,7 @@ def test_subspace_discords(T, m):
 
     for k in range(T.shape[0]):
         ref_S = naive.subspace(T, m, discord_idx, nn_idx, k, discords=True)
-        comp_S = _get_subspace(T, m, discord_idx, nn_idx, k, discords=True)
+        comp_S = subspace(T, m, discord_idx, nn_idx, k, discords=True)
         npt.assert_almost_equal(ref_S, comp_S)
 
 
@@ -182,9 +181,7 @@ def test_subspace_include_discords(T, m):
                 ref_S = naive.subspace(
                     T, m, discord_idx, nn_idx, k, include, discords=True
                 )
-                comp_S = _get_subspace(
-                    T, m, discord_idx, nn_idx, k, include, discords=True
-                )
+                comp_S = subspace(T, m, discord_idx, nn_idx, k, include, discords=True)
                 npt.assert_almost_equal(ref_S, comp_S)