[DOC] Documentation improvement of BaseSeriesEstimator and BaseAeonEstimator

[kevinzb56]

Reference Issues/PRs

solves #2509

What does this implement/fix? Explain your changes.

This PR adds comprehensive documentation for the BaseSeriesEstimator and BaseAeonEstimator 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 have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].

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]

Please refrain from continually opening and closing PRs, just push changes to your branch.
Also please fill out the PR template.

[kevinzb56]

@MatthewMiddlehurst I have filled out the PR template, but some tests are still failing. I followed the development guide and retried multiple times, but a few tests continue to fail. Could you provide any guidance on resolving this?

[MatthewMiddlehurst]

These were just sporadic failures, you only changed docs so its not related to your PR.

Please use a consistent style with other classes, #2516 is cleaner IMO.

[kevinzb56]

@MatthewMiddlehurst I'm getting this message printed on the terminal
flake8...................................................................Failed

• hook id: flake8
• exit code: 1

aeon/base/_base_series.py:10:89: E501 line too long (93 > 88 characters)
aeon/base/_base_series.py:11:89: E501 line too long (99 > 88 characters)
aeon/base/_base_series.py:17:89: E501 line too long (120 > 88 characters)

Is it because of the length? I tried to shorten it by removing whitespaces but still the error persists

[MatthewMiddlehurst]

yes lines can only be 88 characters in length

[kevinzb56]

@MatthewMiddlehurst Updated the docs!