search

TDAmeritrade / stumpy

STUMPY is a powerful and scalable Python library for modern time series analysis
https://stumpy.readthedocs.io/en/latest/
Other
3.67k stars 320 forks source link

Parameter `T_subseq_isconstant` in `core.process_isconstant` should be set to `None` as default #1013

Closed NimaSarajpoor closed 4 months ago

NimaSarajpoor commented 4 months ago

The docstring says:

T_subseq_isconstant : numpy.ndarray, function, or list, default None

However, the parameter is not set to None.

https://github.com/TDAmeritrade/stumpy/blob/3077d0ddfb315464321dc86f8ec3bf2cab9ce3b1/stumpy/core.py#L4224-L4244

seanlaw commented 4 months ago

@NimaSarajpoor Perhaps we should update the docstring and remove , default None?

NimaSarajpoor commented 4 months ago

This function returns T_subseq_isconstant and thus, it may make sense to allow users to only pass T and m (and nothing else) if they want to capture constant subsequences.

So, I think we just set it to None as default. What do you think?

seanlaw commented 4 months ago

@NimaSarajpoor That sounds fine. Change it and run the tests again to see if anything breaks