diff --git a/aeon/base/_base_collection.py b/aeon/base/_base_collection.py index ea3b21ed32..4d7f4b4564 100644 --- a/aeon/base/_base_collection.py +++ b/aeon/base/_base_collection.py @@ -1,4 +1,24 @@ -"""Base class for estimators that fit collections of time series.""" +""" +Base class for estimators that fit collections of time series. + + class name: BaseCollectionEstimator + +Defining methods: + preprocessing - _preprocess_collection(self, X, store_metadata=True) + input checking - _check_X(self, X) + input conversion - _convert_X(self, X) + shape checking - _check_shape(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() + +""" from abc import abstractmethod diff --git a/aeon/classification/deep_learning/base.py b/aeon/classification/deep_learning/base.py index 2ed56bc0bc..61ddeb3a72 100644 --- a/aeon/classification/deep_learning/base.py +++ b/aeon/classification/deep_learning/base.py @@ -1,6 +1,23 @@ """ Abstract base class for the Keras neural network classifiers. + class name: BaseDeepClassifier + +Defining methods: + fitting - fit(self, X, y) + predicting - predict(self, X) + - predict_proba(self, X) + model building - build_model(self, input_shape, n_classes) (abstract method) + +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() + The reason for this class between BaseClassifier and deep_learning classifiers is because we can generalise tags, _predict and _predict_proba """