Skip to content

[DOC] Changed SummaryClusterer's summary_stat from "percentiles" to "quantiles" #2778

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions aeon/classification/feature_based/_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ class SummaryClassifier(BaseClassifier):

Parameters
----------
summary_stats : ["default", "percentiles", "bowley", "tukey"], default="default"
summary_stats : ["default", "quantiles", "bowley", "tukey"], default="default"
The summary statistics to compute.
The options are as follows, with float denoting the percentile value extracted
from the series:
- "default": mean, std, min, max, 0.25, 0.5, 0.75
- "percentiles": 0.215, 0.887, 0.25, 0.5, 0.75, 0.9113, 0.9785
- "quantiles": 0.0215, 0.0887, 0.25, 0.5, 0.75, 0.9113, 0.9785
- "bowley": min, max, 0.1, 0.25, 0.5, 0.75, 0.9
- "tukey": min, max, 0.125, 0.25, 0.5, 0.75, 0.875
estimator : sklearn classifier, default=None
Expand Down
4 changes: 2 additions & 2 deletions aeon/clustering/feature_based/_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ class SummaryClusterer(BaseClusterer):

Parameters
----------
summary_stats : ["default", "percentiles", "bowley", "tukey"], default="default"
summary_stats : ["default", "quantiles", "bowley", "tukey"], default="default"
The summary statistics to compute.
The options are as follows, with float denoting the percentile value extracted
from the series:
- "default": mean, std, min, max, 0.25, 0.5, 0.75
- "percentiles": 0.215, 0.887, 0.25, 0.5, 0.75, 0.9113, 0.9785
- "quantiles": 0.0215, 0.0887, 0.25, 0.5, 0.75, 0.9113, 0.9785
- "bowley": min, max, 0.1, 0.25, 0.5, 0.75, 0.9
- "tukey": min, max, 0.125, 0.25, 0.5, 0.75, 0.875
estimator : sklearn clusterer, default=None
Expand Down
4 changes: 2 additions & 2 deletions aeon/regression/feature_based/_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ class SummaryRegressor(BaseRegressor):

Parameters
----------
summary_stats : ["default", "percentiles", "bowley", "tukey"], default="default"
summary_stats : ["default", "quantiles", "bowley", "tukey"], default="default"
The summary statistics to compute.
The options are as follows, with float denoting the percentile value extracted
from the series:
- "default": mean, std, min, max, 0.25, 0.5, 0.75
- "percentiles": 0.215, 0.887, 0.25, 0.5, 0.75, 0.9113, 0.9785
- "quantiles": 0.0215, 0.0887, 0.25, 0.5, 0.75, 0.9113, 0.9785
- "bowley": min, max, 0.1, 0.25, 0.5, 0.75, 0.9
- "tukey": min, max, 0.125, 0.25, 0.5, 0.75, 0.875
estimator : sklearn regressor, default=None
Expand Down