BaseAnomalyDetector

class BaseAnomalyDetector

Bases: BaseAeonEstimator

Anomaly detection base class.

Methods

clone([random_state])	Obtain a clone of the object with the same hyperparameters.
fit(X[, y])	Fit anomaly detector to X, optionally to y.
fit_predict(X[, y])	Fit time series anomaly detector and find anomalies for X.
get_class_tag(tag_name[, raise_error, ...])	Get tag value from estimator class (only class tags).
get_class_tags()	Get class tags from estimator class and all its parent classes.
get_fitted_params([deep])	Get fitted parameters.
get_params([deep])	Get parameters for this estimator.
get_tag(tag_name[, raise_error, ...])	Get tag value from estimator class.
get_tags()	Get tags from estimator.
predict(X)	Find anomalies in X.
reset([keep])	Reset the object to a clean post-init state.
set_params(**params)	Set the parameters of this estimator.
set_tags(**tag_dict)	Set dynamic tags to given values.

clone(random_state=None)

Obtain a clone of the object with the same hyperparameters.

A clone is a different object without shared references, in post-init state. This function is equivalent to returning sklearn.clone of self. Equal in value to type(self)(**self.get_params(deep=False)).

Parameters:

random_stateint, RandomState instance, or None, default=None

Sets the random state of the clone. If None, the random state is not set. If int, random_state is the seed used by the random number generator. If RandomState instance, random_state is the random number generator.

Returns:

estimatorobject

Instance of type(self), clone of self (see above)

abstract fit(X, y=None)

Fit anomaly detector to X, optionally to y.

State change:

Changes state to “fitted”.

Writes to self: _is_fitted : flag is set to True.

Parameters:

XSeries or Collection, any supported type

Data to fit anomaly detector to, of python type as follows:

Series: 2D np.ndarray shape (n_channels, n_timepoints) Collection: 3D np.ndarray shape (n_cases, n_channels, n_timepoints) or list of 2D np.ndarray, case i has shape (n_channels, n_timepoints_i)

ySeries, default=None

Additional data, e.g., labels for anomaly detector.

Returns:

BaseAnomalyDetector

The fitted estimator, reference to self.

abstract fit_predict(X, y=None) → ndarray

Fit time series anomaly detector and find anomalies for X.

Parameters:

XSeries or Collection, any supported type

Data to fit anomaly detector to, of python type as follows:

Series: 2D np.ndarray shape (n_channels, n_timepoints) Collection: 3D np.ndarray shape (n_cases, n_channels, n_timepoints) or list of 2D np.ndarray, case i has shape (n_channels, n_timepoints_i)

Returns:

np.ndarray

A boolean, int or float array of length len(X), where each element indicates whether the corresponding subsequence/case is anomalous or its anomaly score.

classmethod get_class_tag(tag_name, raise_error=True, tag_value_default=None)

Get tag value from estimator class (only class tags).

Parameters:

tag_namestr

Name of tag value.

raise_errorbool, default=True

Whether a ValueError is raised when the tag is not found.

tag_value_defaultany type, default=None

Default/fallback value if tag is not found and error is not raised.

Returns:

tag_value

Value of the tag_name tag in cls. If not found, returns an error if raise_error is True, otherwise it returns tag_value_default.

Raises:

ValueError

if raise_error is True and tag_name is not in self.get_tags().keys()

Examples

>>> from aeon.classification import DummyClassifier
>>> DummyClassifier.get_class_tag("capability:multivariate")
True

classmethod get_class_tags()

Get class tags from estimator class and all its parent classes.

Returns:

collected_tagsdict

Dictionary of tag name and tag value pairs. Collected from _tags class attribute via nested inheritance. These are not overridden by dynamic tags set by set_tags or class __init__ calls.

get_fitted_params(deep=True)

Get fitted parameters.

State required:

Requires state to be “fitted”.

Parameters:

deepbool, default=True

If True, will return the fitted parameters for this estimator and contained subobjects that are estimators.

Returns:

fitted_paramsdict

Fitted parameter names mapped to their values.

get_params(deep=True)

Get parameters for this estimator.

Parameters:

deepbool, default=True

If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

paramsdict

Parameter names mapped to their values.

get_tag(tag_name, raise_error=True, tag_value_default=None)

Get tag value from estimator class.

Includes dynamic and overridden tags.

Parameters:

tag_namestr

Name of tag to be retrieved.

raise_errorbool, default=True

Whether a ValueError is raised when the tag is not found.

tag_value_defaultany type, default=None

Default/fallback value if tag is not found and error is not raised.

Returns:

tag_value

Value of the tag_name tag in self. If not found, returns an error if raise_error is True, otherwise it returns tag_value_default.

Raises:

ValueError

if raise_error is True and tag_name is not in self.get_tags().keys()

Examples

>>> from aeon.classification import DummyClassifier
>>> d = DummyClassifier()
>>> d.get_tag("capability:multivariate")
True

get_tags()

Get tags from estimator.

Includes dynamic and overridden tags.

Returns:

collected_tagsdict

Dictionary of tag name and tag value pairs. Collected from _tags class attribute via nested inheritance and then any overridden and new tags from __init__ or set_tags.

abstract predict(X) → ndarray

Find anomalies in X.

Parameters:

XSeries or Collection, any supported type

Data to fit anomaly detector to, of python type as follows:

Series: 2D np.ndarray shape (n_channels, n_timepoints) Collection: 3D np.ndarray shape (n_cases, n_channels, n_timepoints) or list of 2D np.ndarray, case i has shape (n_channels, n_timepoints_i)

Returns:

np.ndarray

A boolean, int or float array of length len(X), where each element indicates whether the corresponding subsequence/case is anomalous or its anomaly score.

reset(keep=None)

Reset the object to a clean post-init state.

After a self.reset() call, self is equal or similar in value to type(self)(**self.get_params(deep=False)), assuming no other attributes were kept using keep.

Detailed behaviour:

removes any object attributes, except:

hyper-parameters (arguments of __init__) object attributes containing double-underscores, i.e., the string “__”

runs __init__ with current values of hyperparameters (result of get_params)

Not affected by the reset are:

object attributes containing double-underscores class and object methods, class attributes any attributes specified in the keep argument

Parameters:

keepNone, str, or list of str, default=None

If None, all attributes are removed except hyperparameters. If str, only the attribute with this name is kept. If list of str, only the attributes with these names are kept.

Returns:

selfobject

Reference to self.

Raises:

TypeError

If ‘keep’ is not a string or a list of strings.

set_params(**params)

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**paramsdict

Estimator parameters.

Returns:

selfestimator instance

Estimator instance.

set_tags(**tag_dict)

Set dynamic tags to given values.

Parameters:

**tag_dictdict

Dictionary of tag name and tag value pairs.

Returns:

selfobject

Reference to self.