Issue#809 fix docstrings in benchmarking #2646
Conversation
adityagh006
requested review from
baraline,
TonyBagnall,
MatthewMiddlehurst,
hadifawaz1999 and
dguijo
as code owners
aeon-actions-bot
bot
added
benchmarking
Thank you for contributing to
|
adityagh006
force-pushed
the
issue#809-fix-docstrings-in-benchmarking
branch
from
872e65f to
b949e59
Compare
|
|
||
| Returns | ||
| ------- | ||
| float | ||
| ``float`` | ||
| Threshold such that there are at least `k` anomalous ranges. |
| `y_true` : array-like of shape (n_samples,) | ||
| Ground truth target labels. | ||
| y_pred : array-like of shape (n_samples,) | ||
| `y_pred` : array-like of shape (n_samples,) | ||
| Cluster labels to evaluate. | ||
|
|
||
| Returns | ||
| ------- | ||
| score : float | ||
| `score` : float |
There was a problem hiding this comment.
Ticks on variable names and not on types, inconsistent with the rest.
| "clustering", "regression". Not case-sensitive. | ||
| as_list: boolean, default=False | ||
| If True, returns a list instead of a dataframe. | ||
| `task`: str, default="classification" |
There was a problem hiding this comment.
ticks on variable name, inconsistent with the rest
|
|
||
| Returns | ||
| ------- | ||
| data: pd.DataFrame or list | ||
| Standardised name as defined by NAME_ALIASES. | ||
| `data`: pd.DataFrame or list |
There was a problem hiding this comment.
ticks on variable name and not on types, inconsistent with the rest
| @@ -251,39 +251,43 @@ def get_estimator_results( | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| estimators : str ot list of str | |||
| `estimators` : str ot list of str | |||
There was a problem hiding this comment.
ticks on variable name and not on types, inconsistent with the rest
| include_missing is true. | ||
| num_resamples : int or None, default=None | ||
| ``include_missing`` is ``true``. | ||
| `num_resamples` : int or None, default=None |
There was a problem hiding this comment.
ticks on variable name and not on types, inconsistent with the rest
| datasets : list of or None, default=1 | ||
| ``get_available_estimators``, ``aeon.benchmarking.results_loading.NAME_ALIASES`` | ||
| or the directory at path for valid options. | ||
| `datasets` : list of or None, default=1 |
There was a problem hiding this comment.
ticks on variable name and not on types, inconsistent with the rest
| `task` : str, default="classification" | ||
| Should be one of ``aeon.benchmarking.results_loading.VALID_TASK_TYPES``. i.e. | ||
| `"classification"`, `"clustering"`, `"regression"`. | ||
| `measure` : str, default="accuracy" | ||
| Should be one of | ||
| `aeon.benchmarking.results_loading.VALID_RESULT_MEASURES[task]`. | ||
| Dependent on the task, i.e. for classification, `"accuracy"`, `"auroc"`, | ||
| `"balacc"` and regression, `"mse"`, `"mae"`, `"r2"`. | ||
| `remove_dataset_modifiers`: bool, default=False |
There was a problem hiding this comment.
ticks on variable name and not on types, inconsistent with the rest
| path : str, default="https://timeseriesclassification.com/results/ReferenceResults/" | ||
| i.e. a loaded result row for `"Dataset_eq"` will be converted to | ||
| just `"Dataset"`. | ||
| `path` : str, |
There was a problem hiding this comment.
ticks on variable name and not on types, inconsistent with the rest
| `results`: 2D numpy array | ||
| Array of scores. Each column is a results for a classifier, each row a dataset. | ||
| names: list of str | ||
| `names`: list of str |
There was a problem hiding this comment.
ticks on variable name and not on types, inconsistent with the rest
Fixes #809
This PR updates and corrects the docstrings for various benchmarking functions in the Aeon toolkit. The changes improve clarity, consistency, and adherence to documentation standards. The updated files include:
1.thresholding.py
2.clustering.py
3.segmentation.py
4.published_results.py
5.resampling.py
6.results_loaders.py
7.stats.py
No new dependencies. These changes improve documentation readability, making it easier for developers and users to understand function behavior and expected inputs/outputs. Updated docstrings for benchmarking functions, verified formatting and consistency with existing documentation, and ensured the PR title follows the required format: issue#809-fix-docstrings-in-benchmarking.