Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Documentation improvement of certain BaseClasses #2509

Open
lucifer4073 opened this issue Jan 21, 2025 · 3 comments
Open

[DOC] Documentation improvement of certain BaseClasses #2509

lucifer4073 opened this issue Jan 21, 2025 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lucifer4073
Copy link

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

@lucifer4073 lucifer4073 added the documentation Improvements or additions to documentation label Jan 21, 2025
@kevinzb56
Copy link
Contributor

@aeon-actions-bot assign @kevinzb56

@MatthewMiddlehurst
Copy link
Member

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

@MatthewMiddlehurst
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants