Fixed bug in finding multi-dimensional discords

Author: seanlaw

docs/Tutorial_Multidimensional_Motif_Discovery.ipynb

@@ -620,19 +620,19 @@
     "\n",
     "```\n",
     "mps, indices = stumpy.mstump(df, m, discords=True)\n",
-    "motifs_idx = np.argsort(mps, axis=1)[:, :2]\n",
+    "discords_idx = np.argsort(-mps, axis=1)[:, :2]\n",
     "k = 2\n",
-    "S = stumpy.subspace(df, m, motifs_idx[k][0], indices[k][motifs_idx[k][0]], k, discords=True)\n",
+    "S = stumpy.subspace(df, m, discords_idx[k][0], indices[k][discords_idx[k][0]], k, discords=True)\n",
     "```\n",
     "\n",
-    "Instead of returning the smallest average distance, this returns the largest average distance across $k$ dimensions. This ability to return discords is unique to STUMPY and was not published in the original paper. Also note that it is possible to include specific dimensions and search for discords at the same time:\n",
+    "Instead of returning the smallest average distance, this returns the largest average distance across $k$ dimensions. However, note that we use `-mps` (i.e., multiply `mps` by `-1.0`) before sorting in order to focus on discords. This ability to return discords is unique to STUMPY and was not published in the original paper. Also note that it is possible to include specific dimensions and search for discords at the same time:\n",
     "\n",
     "\n",
     "```\n",
     "mps, indices = stumpy.mstump(df, m, include=[0, 1], discords=True)\n",
-    "motifs_idx = np.argsort(mps, axis=1)[:, :2]\n",
+    "discords_idx = np.argsort(-mps, axis=1)[:, :2]\n",
     "k = 2\n",
-    "S = stumpy.subspace(df, m, motifs_idx[k][0], indices[k][motifs_idx[k][0]], k, include=[0, 1], discords=True)\n",
+    "S = stumpy.subspace(df, m, discords_idx[k][0], indices[k][discords_idx[k][0]], k, include=[0, 1], discords=True)\n",
     "```\n",
     "\n",
     "In this case, the dimensions listed in `include` are honored first and then all subsequent dimensions are sorted by their largest average distance across $k$ dimensions."
@@ -672,7 +672,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.6"
+   "version": "3.9.7"
   }
  },
  "nbformat": 4,