[DOC] Documentation improvement of BaseDeepClassifier and BaseCollectionEstimator

[kevinzb56]

Reference Issues/PRs

Solves #2509

What does this implement/fix? Explain your changes.

This PR adds comprehensive documentation for the BaseCollectionEstimator class in the aeon library. The documentation follows the established format used for other base classes (e.g., BaseClassifier) and includes:

• A clear description of the class's purpose and functionality.

• A list of defining methods, grouped into logical categories (preprocessing, input checking, input conversion, and shape checking).

• Inherited inspection methods and state attributes.

• Additional context about the class's role in the library.

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

Any other comments?

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.

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

[MatthewMiddlehurst]

This seems better to me. Any thoughts @lucifer4073 as you opened the issue?

[lucifer4073]

Hi @MatthewMiddlehurst,

This PR looks good. It would be beneficial to address the documentation for other base classes that currently lack it, potentially in a separate PR..

[kevinzb56]

@lucifer4073 @MatthewMiddlehurst I’d be happy to address this issue for the other base classes as well. If it’s alright with you, may I proceed with creating a PR for those once this current one is merged?
Thank you!

[kevinzb56]

Hi @lucifer4073 @MatthewMiddlehurst,

Just checking if it’s alright for me to work on a PR for the other base classes once this one is merged. Would appreciate your confirmation whenever you get a chance!

Thank you!

[baraline]

LGTM, thanks !
It would be nice to have such docs for the other base class indeed ! I think you can go ahead @kevinzb56 and create PRs for those too if you want.

[kevinzb56]

@baraline thank you so much! I'll make the other PRs too.

[kevinzb56]

@all-contributors please add @kevinzb56 for code

[allcontributors]

@kevinzb56

I've put up a pull request to add @kevinzb56! 🎉

[MatthewMiddlehurst]

@all-contributors please add @kevinzb56 for docs

[allcontributors]

@MatthewMiddlehurst

I've put up a pull request to add @kevinzb56! 🎉

[MatthewMiddlehurst]

@all-contributors please add @kevinzb56 for docs

[allcontributors]

@MatthewMiddlehurst

I've put up a pull request to add @kevinzb56! 🎉