[DOC] Update Partitional clustering notebook

[Akhil-Jasson]

I have addressed issue #1805 by updating the partitional_clustering notebook to include all the supported distance metrics.

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

• 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.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[aeon-actions-bot]

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
I have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$ ]. 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

[Akhil-Jasson]

Hi @MatthewMiddlehurst @TonyBagnall,
I hope you're doing well! I’ve submitted a PR and would appreciate it if you could take a look at it whenever you have the time. Please let me know if there are any changes or improvements needed.

Thanks in advance for your feedback!

[review-notebook-app]

View / edit / reply to this conversation on ReviewNB

TonyBagnall commented on 2025-01-14T08:56:08Z
----------------------------------------------------------------

not sure if it is just reviewnb, but Squared and ADTW seem to be on the same line

[TonyBagnall]

thanks, could you just check the line break for ADTW?

[Akhil-Jasson]

Hi @TonyBagnall , I’ve double-checked the code and JSON structure, and everything seems fine. Here’s the relevant snippet for reference:

"<ul>\n",
" <li>K-means, K-medoids supported distances:\n",
" <ul>\n",
" <li>Euclidean - parameter string 'euclidean'</li>\n",
" <li>Manhattan - parameter string 'manhattan'</li>\n",
" <li>Minkowski - parameter string 'minkowski'</li>\n",
" <li>Soft DTW - parameter string 'soft_dtw'</li>\n",
" <li>Shift Scale - parameter string 'shift_scale'</li>\n",
" <li>Squared - parameter string 'squared'</li>\n",
" <li>ADTW - parameter string 'adtw'</li>\n",
" <li>DTW - parameter string 'dtw'</li>\n",
" <li>DDTW - parameter string 'ddtw'</li>\n",
" <li>WDTW - parameter string 'wdtw'</li>\n",
" <li>WDDTW - parameter string 'wddtw'</li>\n",
" <li>LCSS - parameter string 'lcss'</li>\n",
" <li>ERP - parameter string 'erp'</li>\n",
" <li>EDR - parameter string 'edr'</li>\n",
" <li>MSM - parameter string 'msm'</li>\n",
" <li>TWE - parameter string 'twe'</li>\n",
" <li>SBD - parameter string 'sbd'</li>\n",
" </ul>\n",
" </li>\n",
"</ul>\n"

The line break for ADTW looks correct here, but I noticed that in ReviewNB, there are formatting issues where some items appear on the same line as others. I’m not sure why this discrepancy is happening, as the code itself appears fine. Please let me know if you think there’s another aspect I should check!

[baraline]

Hi @Akhil-Jasson, if you check on the docs (https://aeon-toolkit--2483.org.readthedocs.build/en/2483/examples/clustering/partitional_clustering.html) you'll see that there is an html tag floating around after the listing in 1.2 Assignment using a distance measure. Might be what Tony was referring to.

[Akhil-Jasson]

Hi @baraline, thank you for pointing this out! If I’m not mistaken, the additional HTML tag you mentioned does not appear in my PR. I’ve reviewed the code, and everything seems to be correctly formatted on my end. Please let me know if there’s anything specific I might have missed!

[baraline]

Was mentioning the </li> tag not a line break as Tony discussed my bad !

You see this one too right ?

[Akhil-Jasson]

No problem, @baraline! Yes, I assume the additional tag is still present in the main branch.

[baraline]

You are right, it is from the main branch and not your PR, could you also correct it while at it ? After that I think we'll be good to go

[Akhil-Jasson]

Thanks for confirming, @baraline! I’ve already corrected the issue in my PR. Let me know if there’s anything else you’d like me to address!

[baraline]

It is still present in your PR. You can see it on the generated docs at https://aeon-toolkit--2483.org.readthedocs.build/en/2483/examples/clustering/partitional_clustering.html.

[Akhil-Jasson]

Hi @baraline, Thanks a lot for pointing it out! I'm currently unable to identify the reason why the extra tag is appearing. I'll go through the entire notebook thoroughly to investigate further. If anyone happens to identify the cause, I would greatly appreciate the help!

[baraline]

The only thing I would see causing this is <!-- --> around the li tag here.

It's weird as it doesn't appear when looking at the notebook directly, but when looking at the docs it appear ... If removing the <!-- --> doesn't solve it I think we can move forward with the PR and raise a small issue to keep track of it.

[Akhil-Jasson]

I had added the comment tag while trying to figure out the issue, but it wasn’t present in the earlier commits. I’ll go ahead and remove the comment tag now.

[Akhil-Jasson]

Hi @baraline, great news, the additional tag seems to have disappeared! While I’m not entirely sure how it resolved itself, the tags were added later as part of my attempt to identify the issue. I’m glad it’s sorted now. Thanks a lot for your help!

[baraline]

Our mistery tag still remains on the generated docs, so I'm as clueless as you are ... As the problem doesn't come from your PR as it exists on the main branch, I'll raise an issue about it. The line breaks Tony mentioned don't appear on the generated docs either, probably a reviewNB issue ?
The other additions are looking good, so we good to go, thanks !

Requested change are due to an issue on ReviewNB and don't appear on the generated docs

[Akhil-Jasson]

Hi @baraline, thank you for merging the PR and for your support throughout the process!

I wanted to share that I’m planning to apply for GSoC this year, and I really enjoy working with Aeon!
Are there any particular issues or areas you’d recommend I focus on to contribute further?

[Akhil-Jasson]

@all-contributors please add @Akhil-Jasson for docs

[allcontributors]

@Akhil-Jasson

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[Akhil-Jasson]

@all-contributors please add @Akhil-Jasson for docs

[allcontributors]

@Akhil-Jasson

I've put up a pull request to add @Akhil-Jasson! 🎉