[DOC] More prominent examples of using aeon with sklearn

[TonyBagnall]

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

[aryan0931]

@aeon-actions-bot assign @aryan0931

[NiyatiBisht08]

Hey @MatthewMiddlehurst, I am keen in solving this documentation issue. Can I please be assigned this?

[MatthewMiddlehurst]

What do you plan to add?

[an04shu]

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 .

[MatthewMiddlehurst]

What do you plan on adding?

[an04shu]

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: Regression Examples: Right now, there aren’t any concrete examples of using aeon distances with scikit-learn regression models. I plan to add a practical example demonstrating how to integrate aeon distances in a regression workflow.

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.

[MatthewMiddlehurst]

Ok feel free to open a PR and we can see how it looks. I wouldn't close this issue in it though.

[an04shu]

I've opened a PR for this. Looking forward to your feedback

[hiteshkarvil]

Hi @MatthewMiddlehurst This is a great point — I’ve also found myself wishing for more sklearn-style examples when getting started with aeon. I’ve got some experience with sklearn and would love to help out with this!

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!