Using the k parameter with STUMPI

[jimacDS]

On the documentation for stumpi, there is a parameter k, that is supposed to be able to set:

"The number of top k smallest distances used to construct the matrix profile. Note that this will increase the total computational time and memory usage when k > 1."

However, when trying to set k=2, I receive the error:

TypeError: aampi.__init__() got an unexpected keyword argument 'k'

Has this been deprecated

[seanlaw]

@jimacDS Welcome to the STUMPY community and thank you for your question.

Has this been deprecated

Actually, it's the opposite. Our docs usually reflect any changes in our development branch and so k is currently only available if you install STUMPY from source. This parameter was only added recently and will be available in our upcoming release.

In the meantime, you can install from source by doing something like:

$ python -m pip install git+https://github.com/TDAmeritrade/stumpy.git

Sorry for the confusion!

[jimacDS]

Thanks Sean!

[tholds]

@seanlaw, I was also confused by the API docs (coincidentally, when trying to pass k to stumpy.stump). There are a number of issues which might be worth looking at:

1. stumpy.readthedocs.io redirects to stumpy.readthedocs.io/en/latest/ and there is no mention of, or link to, the stable release documentation https://stumpy.readthedocs.io/en/stable/.
2. The page title for stumpy.readthedocs.io/en/latest/ refers to the stable version, 1.11.1 (see image below)
3. This is inconsistent with other packages (notably NumPy, Pandas and SciPy, which direct users to docs for the stable version by default, clearly identify the relevant version and provide a way to select other versions.
4. Both the README and the stable docs, provide install instructions for the stable release (pip / conda), but include hyperlinks to documentation that direct the user to the latest docs (potentially inconsistent with the version they have installed). See index.html#how-to-use-stumpy for an example.

[seanlaw]

@tholds Apologies for the inconvenience. Would you be willing to help us sort this out? I haven't had an opportunity to think through how to best manage/correct this behavior and we could use the help. I guess "stable" should really be tied to a precise release and, maybe, there is a way to hide/remove "latest".