TimeSeriesCatalog.LocalizeRootCauses Method

Definition

Namespace:

Microsoft.ML

Assembly:

Microsoft.ML.TimeSeries.dll

Package:

Microsoft.ML.TimeSeries v3.0.1

Outputs an ordered list of RootCauses. The order corresponds to which prepared cause is most likely to be the root cause.

public static System.Collections.Generic.List<Microsoft.ML.TimeSeries.RootCause> LocalizeRootCauses (this Microsoft.ML.AnomalyDetectionCatalog catalog, Microsoft.ML.TimeSeries.RootCauseLocalizationInput src, double beta = 0.5, double rootCauseThreshold = 0.95);

static member LocalizeRootCauses : Microsoft.ML.AnomalyDetectionCatalog * Microsoft.ML.TimeSeries.RootCauseLocalizationInput * double * double -> System.Collections.Generic.List<Microsoft.ML.TimeSeries.RootCause>

<Extension()>
Public Function LocalizeRootCauses (catalog As AnomalyDetectionCatalog, src As RootCauseLocalizationInput, Optional beta As Double = 0.5, Optional rootCauseThreshold As Double = 0.95) As List(Of RootCause)

Parameters

catalog

AnomalyDetectionCatalog

The anomaly detection catalog.

src

RootCauseLocalizationInput

Root cause's input. The data is an instance of RootCauseLocalizationInput.

beta

Double

Beta is a weight parameter for user to choose. It is used when score is calculated for each root cause item. The range of beta should be in [0,1]. For a larger beta, root cause point which has a large difference between value and expected value will get a high score. On the contrary, for a small beta, root cause items which has a high relative change will get a high score.

rootCauseThreshold

Double

A threshold to determine whether the point should be root cause. The range of this threshold should be in [0,1]. If the point's delta is equal to or larger than rootCauseThreshold multiplied by anomaly dimension point's delta, this point is treated as a root cause. Different threshold will turn out different results. Users can choose the delta according to their data and requirments.

Returns

List<RootCause>

Examples

Warning

It looks like the sample you are looking for has moved! Rest assured we are working on resolving this.