[DOC] Add Shapelets Transformer Documentation (Issue #3028)

[bhakunisagar512-ui]

This PR adds comprehensive documentation for RDST shapelets, including:

• Explanation of all shapelet attributes
• Code examples for accessing shapelet values
• Threshold/SO explanation
• Visualization example

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

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
• Regenerate expected results for testing
• Push an empty commit to re-run CI checks

[hadifawaz1999]

Thanks for this, pinging @baraline here, i think the placement should be inside the transformer api no ?

[baraline]

Hi, the file you created doesn't follow the existing project structure

• If you want to change the API documentation, modify the docstring directly in the python file defining the class. If not already specified, this is where you could put the table where you describe the attributes

• If you want to add examples, you can change the example notebook. This would match what you have done after where you give examples. These are located in the examples folders. We don't have a transformation example for shapelet, but the classification one is quite complete. The best approach might be to create a RDST specific notebook in the transformation folder that we could complete with what is already explained in the classification notebook.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB