Open
Description
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
- Add detailed docstrings for all base classes similar to the example provided for
BaseClassifier. - 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