Interface IAnomalyDetectionProvider
- Namespace
- Scaleout.Modules.DigitalTwin.Abstractions
- Assembly
- Scaleout.Modules.DigitalTwin.Abstractions.dll
Encapsulates the capabilities of a ScaleOut real-time digital twin anomaly detection provider.
public interface IAnomalyDetectionProviderMethods
DetectAnomaly(Dictionary<string, float>)
Detects anomalies by using the trained algorithm and the provided property values
bool DetectAnomaly(Dictionary<string, float> properties)Parameters
propertiesDictionary<string, float>A dictionary of the properties to use for the prediction
Returns
- bool
True if an anomaly is detected, False otherwise
GetPredictionScore(Dictionary<string, float>)
Obtain a prediction score (between 0 and 1) by using the trained algorithm and the provided property values.
float GetPredictionScore(Dictionary<string, float> properties)Parameters
propertiesDictionary<string, float>A dictionary of the properties to use for the prediction
Returns
- float
A number between 0 and 1: the closer to 1, the higher the chance an anomaly is detected.
ReportAnomalyDataAsync(Dictionary<string, float>, bool)
Add anomaly data. Used for retraining ML algorithms, anomaly data consists in a collection of properties and their associated values, along with a label to indicate whether these properties constitute an anomaly.
Task ReportAnomalyDataAsync(Dictionary<string, float> properties, bool isAnomaly)Parameters
propertiesDictionary<string, float>A collection of properties and their values
isAnomalyboolTrue if the values constitute an anomaly