[ENH] Fixes Issue Improve `_check_params` method in `kmeans.py` and `kmedoids.py` #2682

tanishy7777 · 2025-03-23T15:21:24Z

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Adds an else statement in _check_params for both kmeans.py and kmedoids.py. Also adds build initialization documentation.

Does your contribution introduce a new dependency? If yes, which one?

Any other comments?

PR checklist

For all contributions

I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.

For new estimators and functions

I've added the estimator/function to the online API documentation.
(OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.

For developers with write access

(OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

aeon-actions-bot · 2025-03-23T15:21:48Z

Thank you for contributing to `aeon`

I have added the following labels to this PR based on the title: [ $\color{#FEF1BE}{\textsf{enhancement}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#4011F3}{\textsf{clustering}}$ ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

Run pre-commit checks for all files
Run mypy typecheck tests
Run all pytest tests and configurations
Run all notebook example tests
Run numba-disabled codecov tests
Stop automatic pre-commit fixes (always disabled for drafts)
Disable numba cache loading
Push an empty commit to re-run CI checks

MatthewMiddlehurst · 2025-04-04T16:46:41Z

aeon/clustering/_k_medoids.py

+    def _incorrect_params(self) -> str:
+        return (
+            f"The value provided for init: {self.init} is "
+            f"invalid. The following are a list of valid init algorithms "
+            f"strings: random, kmedoids++, first, build. You can also pass a "
+            f"np.ndarray of size (n_clusters, n_channels, n_timepoints)"
+        )


dont do this, just has a variable with the string if needed to avoid repetition.

got it will make the changes

dont do this, just has a variable with the string if needed to avoid repetition.

I have pushed the changes, though I am not sure why I am getting the errors for some of the github actions. The only change I have made is adding some strings.

I do not see a variable used? the message just appears to be duplicated now.

I do not see a variable used? the message just appears to be duplicated now.

Will add

I do not see a variable used? the message just appears to be duplicated now.

I have made the changes

tanishy7777 · 2025-04-09T10:58:25Z

@MatthewMiddlehurst I wasn't sure if there is any other ways to deal with this other than rebasing and force-with-lease
Is this approach ok?

I did this to move my latest commit 499ba8b on top of the commit history as readthedocs and some pytest tests were failing as they were not able to find my commit in the tree.

Now the tests are passing.

I ran the following commands:

git checkout improve_check_params
git fetch origin
git rebase origin/main
git push --force-with-lease

MatthewMiddlehurst · 2025-04-11T17:17:09Z

I do not know, i cannot see an error any more due to the force push.

tanishy7777 · 2025-04-11T17:59:23Z

I do not know, i cannot see an error any more due to the force push.

I was just wondering if force pushing is fine in this case? Or would that be a problem?
And if there is a alternative way we could have handled this in?

MatthewMiddlehurst · 2025-04-14T10:30:53Z

I do not know enough about the issue or why it happens, not looked into it. See #2723

MatthewMiddlehurst · 2025-04-14T10:33:07Z

aeon/clustering/_k_medoids.py

+        first k time series as centroids. Build [1] greedily selects the k medoids
+        by first selecting the medoid that minimizes the sum of distances
+        to all other points(this point is the most centrally located) and then
+        iteratively selects the next k-1 medoids that maximizes the decrease in sum
+        of distances of all other points to their respective medoids selected so far.


Is this the original method used in the paper?

Is this the original method used in the paper?

Yes, this is the "BUILD" phase as stated in the paper

tanishy7777 requested review from chrisholder and TonyBagnall as code owners March 23, 2025 15:21

aeon-actions-bot bot added clustering Clustering package enhancement New feature, improvement request or other non-bug code enhancement labels Mar 23, 2025

tanishy7777 changed the title ~~[ENH] Improves _check_params method in kmeans.py and kmedoids.py~~ [ENH] Fixes Issue Improve _check_params method in kmeans.py and kmedoids.py Mar 23, 2025

MatthewMiddlehurst reviewed Apr 4, 2025

View reviewed changes

tanishy7777 and others added 6 commits April 9, 2025 15:28

Improves _check_params

60bd7b5

removes function and adds a var

3031c43

minor changes

ced27d8

minor changes

9fe291e

minor changes

2419d97

line endings to LF

edea320

tanishy7777 force-pushed the improve_check_params branch from 499ba8b to edea320 Compare April 9, 2025 10:00

tanishy7777 and others added 3 commits April 11, 2025 23:43

use variable instead of duplicating strings

dad826f

Merge branch 'main' into improve_check_params

bc7d0a5

Merge branch 'main' into improve_check_params

0685fa7

MatthewMiddlehurst reviewed Apr 14, 2025

View reviewed changes

Merge branch 'main' into improve_check_params

211cb13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENH] Fixes Issue Improve `_check_params` method in `kmeans.py` and `kmedoids.py` #2682

[ENH] Fixes Issue Improve `_check_params` method in `kmeans.py` and `kmedoids.py` #2682

tanishy7777 commented Mar 23, 2025 •

edited

Loading

aeon-actions-bot bot commented Mar 23, 2025

MatthewMiddlehurst Apr 4, 2025

tanishy7777 Apr 5, 2025

tanishy7777 Apr 9, 2025 •

edited

Loading

MatthewMiddlehurst Apr 11, 2025

tanishy7777 Apr 11, 2025

tanishy7777 Apr 13, 2025

tanishy7777 commented Apr 9, 2025 •

edited

Loading

MatthewMiddlehurst commented Apr 11, 2025

tanishy7777 commented Apr 11, 2025 •

edited

Loading

MatthewMiddlehurst commented Apr 14, 2025

MatthewMiddlehurst Apr 14, 2025

tanishy7777 Apr 15, 2025

[ENH] Fixes Issue Improve _check_params method in kmeans.py and kmedoids.py #2682

Are you sure you want to change the base?

[ENH] Fixes Issue Improve _check_params method in kmeans.py and kmedoids.py #2682

Conversation

tanishy7777 commented Mar 23, 2025 • edited Loading

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Does your contribution introduce a new dependency? If yes, which one?

Any other comments?

PR checklist

For all contributions

For new estimators and functions

For developers with write access

aeon-actions-bot bot commented Mar 23, 2025

Thank you for contributing to aeon

PR CI actions

MatthewMiddlehurst Apr 4, 2025

Choose a reason for hiding this comment

tanishy7777 Apr 5, 2025

Choose a reason for hiding this comment

tanishy7777 Apr 9, 2025 • edited Loading

Choose a reason for hiding this comment

MatthewMiddlehurst Apr 11, 2025

Choose a reason for hiding this comment

tanishy7777 Apr 11, 2025

Choose a reason for hiding this comment

tanishy7777 Apr 13, 2025

Choose a reason for hiding this comment

tanishy7777 commented Apr 9, 2025 • edited Loading

MatthewMiddlehurst commented Apr 11, 2025

tanishy7777 commented Apr 11, 2025 • edited Loading

MatthewMiddlehurst commented Apr 14, 2025

MatthewMiddlehurst Apr 14, 2025

Choose a reason for hiding this comment

tanishy7777 Apr 15, 2025

Choose a reason for hiding this comment

[ENH] Fixes Issue Improve `_check_params` method in `kmeans.py` and `kmedoids.py` #2682

[ENH] Fixes Issue Improve `_check_params` method in `kmeans.py` and `kmedoids.py` #2682

tanishy7777 commented Mar 23, 2025 •

edited

Loading

Thank you for contributing to `aeon`

tanishy7777 Apr 9, 2025 •

edited

Loading

tanishy7777 commented Apr 9, 2025 •

edited

Loading

tanishy7777 commented Apr 11, 2025 •

edited

Loading