-
Notifications
You must be signed in to change notification settings - Fork 208
[DOC] More prominent examples of using aeon with sklearn #1921
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
Comments
@aeon-actions-bot assign @aryan0931 |
Hey @MatthewMiddlehurst, I am keen in solving this documentation issue. Can I please be assigned this? |
What do you plan to add? |
Hi @MatthewMiddlehurst , I have experience in scientific computing and AI-driven projects, and I'm familiar with both sklearn and documentation structuring. I can enhance the examples to make it easier for sklearn users to get started with aeon. Let me know if I can take this up . |
What do you plan on adding? |
Thanks for the clarification! After reviewing the documentation, I noticed that while it covers classification (using KNeighborsClassifier) and clustering (DBSCAN), there are still some areas where more clarity could be helpful. I’d like to contribute by adding: Better Data Formatting Guidance: The docs mention the difference between aeon’s 3D format (n_cases, n_channels, n_timepoints) and sklearn’s 2D format but don’t provide step-by-step instructions on converting between the two. I’d like to add clear examples of how to reshape data correctly. Preprocessing Tips: Since sklearn expects 2D arrays, preprocessing is crucial when working with time-series data. I’ll include guidance on structuring datasets properly, ensuring compatibility, and avoiding common errors. |
Ok feel free to open a PR and we can see how it looks. I wouldn't close this issue in it though. |
I've opened a PR for this. Looking forward to your feedback |
Hi @MatthewMiddlehurst I’m happy to put together a “getting started for sklearn users” section with examples for clustering, classification, regression, and cross-validation. Let me know if that sounds good to you! |
Describe the issue linked to the documentation
it may just be me, but looking around our docs for examples on how to use aeon with sklearn cross validation etc, all I found was this
https://www.aeon-toolkit.org/en/v0.10.0/examples/distances/sklearn_distances.html
I know there is more there, but I think "getting started if you are familiar with sklearn" with loads of examples for clustering, classification and regression or something would be helpful
Suggest a potential alternative/fix
No response
The text was updated successfully, but these errors were encountered: