-
Notifications
You must be signed in to change notification settings - Fork 0
/
twitteranomalycustommodule.xml
117 lines (96 loc) · 5.76 KB
/
twitteranomalycustommodule.xml
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<!-- Defined a module using an R Script -->
<Module name="Twitter Anomaly Detection 3.0">
<Owner>WellAir</Owner>
<Description>Detects Anomalies in Time Series Data. For more information, please visit https://github.com/twitter/AnomalyDetection.</Description>
<!-- Specify the base language, script file and R function to use for this module. -->
<Language name="R" sourceFile="azureml_ts_anom_detection.R" entryPoint="AnomalyDetectionTsw" />
<!-- Define module input and output ports -->
<!-- Note: The values of the Id attributes in the Input and Arg elements must match the parameter names in the R Function CustomAddRows defined in CustomAddRows.R. -->
<Ports>
<Input id="input_dataset" name="Input Dataset" type="DataTable">
<Description>Input dataset with two columns [timestamp, value].</Description>
</Input>
<Output id="result_dataset" name="Result Dataset" type="DataTable">
<Description>List of anomalies found in the dataset.</Description>
</Output>
<Output id="plot_output" name="View Port" type="Visualization">
<Description>View the R console graphics device output.</Description>
</Output>
</Ports>
<!-- Define module parameters -->
<Arguments>
<Arg id="max_anomalies" name="Max anomalies to return" type="double">
<Properties min="0.00" max="0.999" default="0.10" />
<Description>Maximum number of anomalies that S-H-ESD will detect as a percentage of the data (default is 0.10).</Description>
</Arg>
<Arg id="direction" name="Direction" type="DropDown">
<Properties default="both">
<Item id="pos" name="Positive side of X-axis"/>
<Item id="neg" name="Negative side of X-axis"/>
<Item id="both" name="Both sides of X-axis"/>
</Properties>
<Description>Directionality of the anomalies to be detected.</Description>
</Arg>
<Arg id="alpha_significance" name="Alpha significance" type="double">
<Properties min="0.01" max="0.1" default="0.05" />
<Description>The level of statistical significance with which to accept or reject anomalies.</Description>
</Arg>
<Arg id="only_last_day" name="Only last day?" type="DropDown">
<Properties default="None" >
<Item id="None" name="None"/>
<Item id="day" name="Day"/>
<Item id="hr" name="Hour"/>
</Properties>
<Description>Find and report anomalies only within the last day or hr in the time series?</Description>
</Arg>
<Arg id="threshold" name="Threshold" type="DropDown">
<Properties default="None">
<Item id="None" name="None"/>
<Item id="med_max" name="The median of daily max values"/>
<Item id="p95" name="The 95th percentile of daily max values"/>
<Item id="p99" name="The 99th percentile of daily max values"/>
</Properties>
<Description>Only report positive going anomalies above the specified threshold.</Description>
</Arg>
<Arg id="add_expected_value" name="Add expected value column" type="bool">
<Properties default="false" />
<Description>Add an additional column to the anomalies output containing the expected value?</Description>
</Arg>
<Arg id="is_longterm_timeseries" name="Longterm time-series" type="bool">
<Properties default="false" />
<Description>Increase anomaly detection efficacy for time-series that are greater than a month? This option should be set when the input time series is longer than a month. The option enables the approach described in Vallis, Hochenbaum, and Kejariwal (2014).</Description>
</Arg>
<Arg id="piecewise_median_period_weeks" name="Piecewise median time window" type="int">
<Properties default="2" />
<Description>The piecewise median time window as described in Vallis, Hochenbaum, and Kejariwal (2014). Defaults to 2.</Description>
</Arg>
<Arg id="create_plot" name="Create plot?" type="bool">
<Properties default="true" />
<Description>A flag indicating whether a plot with both the time series and the estimated anomalies, indicated by circles, should also be returned.</Description>
</Arg>
<Arg id="apply_y_log_scaling" name="Apply log scaling?" type="bool">
<Properties default="false" />
<Description>Apply log scaling to the y-axis? This helps with viewing plots that have extremely large positive anomalies relative to the rest of the data.</Description>
</Arg>
<Arg id="x_label" name="X-axis label" type="string">
<Properties default="Time" isOptional="true" />
<Description>X-axis label to be added to the output plot. Defaults to "Time".</Description>
</Arg>
<Arg id="y_label" name="Y-axis label" type="string">
<Properties default="Value" isOptional="true" />
<Description>Y-axis label to be added to the output plot. Defaults to "Value".</Description>
</Arg>
<Arg id="plot_title" name="Plot title" type="string">
<Properties default="Anomalies" isOptional="true" />
<Description>Title for the plot output.</Description>
</Arg>
<Arg id="verbose" name="Verbose" type="bool">
<Properties default="false" />
<Description>Enable debug messages?</Description>
</Arg>
<Arg id="remove_nas" name="Remove NAs" type="bool">
<Properties default="false" />
<Description>Remove any NAs in timestamps?</Description>
</Arg>
</Arguments>
</Module>