Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature calculator return type documentation #1062

Closed
dilwong opened this issue Feb 4, 2024 · 2 comments · Fixed by #1070
Closed

Feature calculator return type documentation #1062

dilwong opened this issue Feb 4, 2024 · 2 comments · Fixed by #1070
Labels

Comments

@dilwong
Copy link
Contributor

dilwong commented Feb 4, 2024

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.

@dilwong dilwong added the bug label Feb 4, 2024
@nils-braun
Copy link
Collaborator

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 added a commit to dilwong/tsfresh that referenced this issue Apr 21, 2024
Corrected docstrings of fctype=combiner feature calculators to have the correct return type.
@dilwong
Copy link
Contributor Author

dilwong commented Apr 21, 2024

Ok sure, I submitted PR #1070 for this.

dilwong added a commit to dilwong/tsfresh that referenced this issue Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants