Skip to content

Commit 3b28371

Browse files
committed
Added minor note on missing mmatch function
1 parent 3cb836b commit 3b28371

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Have A Question?
3434
stumpy.motifs
3535
stumpy.match
3636
stumpy.mmotifs
37+
stumpy.mmatch
38+
stumpy.mmatch
3739
stumpy.snippets
3840
stumpy.stimp
3941
stumpy.stimped
@@ -152,6 +154,11 @@ mmotifs
152154

153155
.. autofunction:: stumpy.mmotifs
154156

157+
mmatch
158+
======
159+
160+
This function does not exist. See the :func:`stumpy.match` function, which natively supports multi-dimensional time series inputs.
161+
155162
snippets
156163
========
157164

stumpy/motifs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -414,13 +414,13 @@ def match(
414414
Find all matches of a query ``Q`` in a time series ``T``
415415
416416
The indices of subsequences whose distances to ``Q`` are less than or equal to
417-
``max_distance``, sorted by distance (lowest to highest). Around each occurrence an
417+
``max_distance``, sorted by distance (lowest to highest). Around each occurrence, an
418418
exclusion zone is applied before searching for the next.
419419
420420
Parameters
421421
----------
422422
Q : numpy.ndarray
423-
The query sequence. It doesn't have to be a subsequence of ``T``.
423+
The query sequence. ``Q`` does not have to be a subsequence of ``T``.
424424
425425
T : numpy.ndarray
426426
The time series of interest.

0 commit comments

Comments
 (0)