Skip to content

[DOC] Added Examples and Detailed Explanation for Segmentation Algorithms #2552

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 2 commits into
base: main
Choose a base branch
from

Conversation

sumana-2705
Copy link
Contributor

Reference Issues/PRs

Fixes #2239

What does this implement/fix? Explain your changes.

This PR implements examples and detailed explanations for Segmentation Algorithms in AEON. These additions help users understand how to apply these segmentation techniques to time-series data.

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

No

Any other comments?

please review these changes, so I can get feedback on the structure and clarity. This will help me understand how to contribute additional segmentation algorithms.

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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@aeon-actions-bot aeon-actions-bot bot added documentation Improvements or additions to documentation examples Example notebook related labels Feb 20, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].
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

@sumana-2705
Copy link
Contributor Author

Hello @SebastianSchmidl @MatthewMiddlehurst @TonyBagnall

Please review the PR and suggest me if changes required

@MatthewMiddlehurst
Copy link
Member

Hi @sumana-2705, please ensure the notebook passes the unit testing.

@MatthewMiddlehurst
Copy link
Member

I do not think these show enough to be useful to users to be honest. Notebooks for individual algorithms should at least be as detailed as the CLASP one. The hidalgo one is a candidate for removal if it is not improved TBH.

There are still improvements that can be made to the segmentation examples i.e. there is not much general information on how to use segmenters like in the classification or clustering notebooks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation examples Example notebook related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update the segmentation notebook
2 participants