Pipeline

class dtaianomaly.pipeline.Pipeline(preprocessor: Preprocessor | list[Preprocessor], detector: BaseDetector)[source]

Pipeline to combine preprocessing and anomaly detection.

The pipeline works with a single Preprocessor object or a list of Preprocessor objects. This list is converted into a ChainedPreprocessor. At the moment the Pipeline always requires a Preprocessor object passed at construction. If no preprocessing is desired, you need to explicitly pass an Identity preprocessor.

Parameters:

preprocessorPreprocessor or list of Preprocessors: The preprocessors to include in this pipeline.
detectorBaseDetector: The anomaly detector to include in this pipeline.

Examples

>>> from dtaianomaly.anomaly_detection import IsolationForest
>>> from dtaianomaly.data import demonstration_time_series
>>> from dtaianomaly.pipeline import Pipeline
>>> from dtaianomaly.preprocessing import StandardScaler
>>> X, y = demonstration_time_series()
>>> pipeline = Pipeline(StandardScaler(), IsolationForest(16))
>>> pipeline.fit(X).decision_function(X)
array([-0.01080726, -0.01053199, -0.00883758, ..., -0.05298726,
       -0.05898066, -0.05713733]...)

check_is_fitted() → None

Raise an error if this object is not fitted.

Check whether this object is fitted, and if it is not fitted, an exception is thrown.

Raises:

NotFittedError: If this object is not fitted.

decision_function(X: ndarray) → array

Compute anomaly scores.

Compute the anomaly scores for the given time series using this detector.

Parameters:

Xarray-like of shape (n_samples, n_attributes): Input time series.

Returns:

array-like of shape (n_samples): The computed anomaly scores.

fit(X: ndarray, y: ndarray = None, **kwargs) → BaseDetector

Fit this detector.

Fit this detector to the given data.

Parameters:

Xarray-like of shape (n_samples, n_attributes): Input time series.
yarray-like, default=None: Ground-truth information.
**kwargs: Additional parameters to be used to fit the anomaly detector.

Returns:

BaseDetector: Returns the instance itself.

is_fitted() → bool

Check whether this object is fitted.

Check whether all the attributes of this object that end with an underscore (‘_’) has been initialized.

Returns:

bool: True if and only if all the attributes of this object ending with ‘_’ are initialized.

piped_str() → str[source]

Return this pipeline as a pipe-representation.

Return the string representation of the preprocessor and the detector, combined with a “->” symbol.

Returns:

str: The piped representation of this pipeline.

predict_confidence(X: ndarray, X_train: ndarray = None, contamination: float = 0.05, decision_scores_given: bool = False)

Predict the confidence of the anomaly scores on the test given test data [26].

This method implements ExCeeD (Example-wise Confidence of anomaly Detectors) to estimate the confidence. ExCeed transforms the predicted decision scores to probability estimates using a Bayesian approach, which enables to assign a confidence score to each prediction which captures the uncertainty of the anomaly detector in that prediction.

Parameters:

Xarray-like of shape (n_samples, n_attributes): The test time series for which the confidence of anomaly scores should be predicted.
X_trainarray-like of shape (n_samples_train, n_attributes), default=None: The training time series, which can be used as reference. If X_train=None, the test set is used as reference set.
contaminationfloat, default=0.05: The (estimated) contamination rate for the data, i.e., the expected percentage of anomalies.
decision_scores_givenbool, default=False: Whether the given X and X_train represent time series data or decision scores. If decision_scores_given=False (default), then the given arrays are interpreted as time series. Otherwise, they are interpreted as decision scores, as computed by decision_function().

Returns:

array-like of shape (n_samples): The confidence of this anomaly detector in each prediction in the given test time series.

predict_proba(X: ndarray) → ndarray

Predict anomaly probabilities.

Estimate the probability of a sample of X being anomalous, based on the anomaly scores obtained from decision_function by rescaling them to the range of [0, 1] via min-max scaling.

Parameters:

Xarray-like of shape (n_samples, n_attributes): Input time series.

Returns:

array-like of shape (n_samples): 1D array with the same length as X, with values in the interval [0, 1], in which a higher value implies that the instance is more likely to be anomalous.

Raises:

ValueError: If scores is not a valid array.
ValueError: If the prediction scores from ‘decision_function’ are constant, but not in the interval [0, 1], because these values can not unambiguously be transformed to an anomaly probability.

requires_fitting() → bool

Check whether this object requires fitting.

Check whether any of the attributes of this object ends with an underscore (‘_’), which indicates that the attribute is set when the object is fitted. Note that this method does not check whether the object is fitted, i.e., whether the attributes have been set.

Returns:

bool: True if and only if this object has attributes that end with ‘_’.

save(path: str | Path) → None

Save this detector.

Save detector to disk as a pickle file with extension .dtai. If the given path consists of multiple subdirectories, then the not existing subdirectories are created.

Parameters:

pathstr or Path: Location where to store the detector.