tangent_works.AnomalyDetection

class tangent_works.AnomalyDetection(time_series=None, configuration=None)

A class used to build anomaly detection models and detect anomalies.

Parameters

CODE

    time_series : TimeSeries, optional
            Time series data used for building the model and detecting anomalies.
        configuration : Dict[str, Any], optional
            Configuration used for building the model.

Attributes

CODE

    result_table : pd.DataFrame, optional
        Anomaly detection results table (is None when detect method was not called or new model was built).
    rca_table : pd.DataFrame, optional
        Root cause analysis table (is None when rca method was not called or new model was built).
    time_series : TimeSeries, optional
        Time series data used for building the model and detecting anomalies.
    configuration : AnomalyDetectionBuildConfiguration
        Configuration used for building the model.
    model : AnomalyDetectionModel, optional
        Anomaly detection model.

Methods

CODE

    from_model(model):
        Creates AnomalyDetection object from existing model.
    build_model(inplace):
        Builds anomaly detection model.
    detect(time_series, inplace):
        Detects anomalies in the time series data.
    rca(configuration, time_series, inplace):
        Performs root cause analysis.