[DOC] Documentation improvement of certain BaseClasses

[lucifer4073]

Describe the issue linked to the documentation

Description

Certain base classes in the classification modules (and potentially other modules) have incomplete documentation for their methods and functions.

For instance, the BaseClassifier class provides comprehensive documentation as shown below:

"""
Abstract base class for time series classifiers.

    class name: BaseClassifier

Defining methods:
    fitting         - fit(self, X, y)
    predicting      - predict(self, X)
                    - predict_proba(self, X)

Inherited inspection methods:
    hyper-parameter inspection  - get_params()
    fitted parameter inspection - get_fitted_params()

State:
    fitted model/strategy   - by convention, any attributes ending in "_"
    fitted state flag       - is_fitted (property)
    fitted state inspection - check_is_fitted()
"""

However, other base classes, such as BaseDeepClassifier and BaseCollectionEstimator, lack similar documentation for their methods and functions.

Suggested Solution

1. Add detailed docstrings for all base classes similar to the example provided for BaseClassifier.
2. Review documentation across all modules to identify other classes with incomplete or missing docstrings.

Additional Notes

• This issue may extend to modules beyond classification.
• If needed, I am happy to contribute by creating a PR to address this documentation gap.

Suggest a potential alternative/fix

No response

[kevinzb56]

@aeon-actions-bot assign @kevinzb56

[MatthewMiddlehurst]

Thanks for opening the issue, agree these can be better.

[MatthewMiddlehurst]

There will definitely be more than these two I think, so feel free to contribute to those also.

[Anurag0git]

@lucifer4073 Please can you assign me this issue

[Samriddhi2711]

@lucifer4073 could you please assign me this issue

[MatthewMiddlehurst]

Please read the contributor guide. There is also a PR for this open already, so if you are doing a class separate from those please post here.

[lucifer4073]

Hi @kevinzb56 , are you still working on this?

[kevinzb56]

Hello @lucifer4073, I have already submitted a PR for the BaseDeepClassifier and BaseCollectionEstimator classes. Once this PR is reviewed and approved, I would be happy to make similar improvements to other classes as well.