File size: 1,033 Bytes
3d3d712 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | name: anomaly_detection
enabled: true
required: false
description: >-
anomaly_detection function identifies anomalies from an input DataFrame of
time series. It will add a new column "Is_Anomaly", where each entry will be marked with "True" if the value is an anomaly or "False" otherwise.
parameters:
- name: df
type: DataFrame
required: true
description: >-
the input data from which we can identify the anomalies with the 3-sigma
algorithm.
- name: time_col_name
type: str
required: true
description: name of the column that contains the datetime
- name: value_col_name
type: str
required: true
description: name of the column that contains the numeric values.
returns:
- name: df
type: DataFrame
description: >-
This DataFrame extends the input DataFrame with a newly-added column
"Is_Anomaly" containing the anomaly detection result.
- name: description
type: str
description: This is a string describing the anomaly detection results.
|