Feature calculator return type documentation

blue-yonder / tsfresh

Automatic extraction of relevant features from time series:

http://tsfresh.readthedocs.io

MIT License

8.45k stars 1.21k forks source link

Feature calculator return type documentation #1062

Closed dilwong closed 6 months ago

dilwong commented 9 months ago

This isn't a bug, but more of a documentation issue. According to the docs, as well as in the docstrings for the functions in tsfresh.feature_extraction.feature_calculators, the documented return type for feature calculators of fctype=combiner appears to be incorrect. For example, see agg_linear_trend that claims to return a pandas Series, or augmented_dickey_fuller that claims to return a float.

nils-braun commented 8 months ago

Very good observation @dilwong (and sorry for the late response). Would you like to do a PR to fix this (or at least some of them)?

dilwong commented 7 months ago

Ok sure, I submitted PR #1070 for this.