aeon
aeon copied to clipboard
[DOC] Added more prominent examples of using aeon with sklearn
PR Description for Issue #1921
Pull Request Title:
[DOC] Added more prominent examples of using aeon with sklearn
Reference Issues/PRs
Fixes #1921
What does this implement/fix?
This PR enhances the sklearn_distances.ipynb notebook by:
- Improving clarity and visibility of aeon’s integration with sklearn.
- Adding structured markdown explanations for:
- Data formatting
- Regression using kNN with DTW distance
- Classification using kNN with DTW distance
- Clustering using k-Means with DTW distance
- Cross-validation with sklearn models
- Ensuring examples align with a "Getting Started for sklearn Users" approach.
- Cleaning redundant steps to make the examples more concise.
Does your contribution introduce a new dependency?
No new dependencies were introduced.
Any other comments?
This aims to make aeon’s usage in sklearn workflows more accessible and well-documented. Let me know if any refinements are needed! 🚀
Here's the corrected checklist for your PR:
PR Checklist
For all contributions
- [ ] I've added myself to the [list of contributors](https://github.com/aeon-toolkit/aeon/blob/main/.all-contributorsrc) (Optional – Check only if you want to be listed).
- [x] The PR title follows the convention: [DOC] Added more prominent examples of using aeon with sklearn.
For documentation updates
- [x] Examples are structured clearly for new users.
- [x] Markdown descriptions are concise and helpful.
Check out this pull request on ![]()
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
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-commitchecks for all files - [ ] Run
mypytypecheck tests - [ ] Run all
pytesttests and configurations - [ ] Run all notebook example tests
- [ ] Run numba-disabled
codecovtests - [ ] Stop automatic
pre-commitfixes (always disabled for drafts) - [ ] Disable numba cache loading
- [ ] Push an empty commit to re-run CI checks
Hello, is this still active?
Going to close this now to clean up PRs. If you want to continue, feel free to reopen.