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

Improve relevance table function documentation #781

Merged
merged 3 commits into from
Dec 23, 2020
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions tsfresh/feature_selection/relevance.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,16 @@ def calculate_relevance_table(

:return: A pandas.DataFrame with each column of the input DataFrame X as index with information on the significance
of this particular feature. The DataFrame has the columns
"Feature",
"feature",
"type" (binary, real or const),
"p_value" (the significance of this feature as a p-value, lower means more significant)
"relevant" (True if the Benjamini Hochberg procedure rejected the null hypothesis [the feature is
not relevant] for this feature)
not relevant] for this feature).
If problem is `multiclass` with n classes, the DataFrame will contain n
joclement marked this conversation as resolved.
Show resolved Hide resolved
columns named "p_value_CLASSID" instead of the "p_value" column.
`CLASSID` refers here to the different values set in `y`.
There will also be n columns named `relevant_CLASSID`, indicating whether
the feature is relevant for that class.
:rtype: pandas.DataFrame
"""

Expand Down