Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Cognitive.SimpleDetectAnomalies Class Reference

SimpleDetectAnomalies implements SimpleDetectAnomalies More...

Inheritance diagram for Synapse.ML.Cognitive.SimpleDetectAnomalies:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.SimpleDetectAnomalies:
Collaboration graph
[legend]

Public Member Functions

 SimpleDetectAnomalies ()
 Creates a SimpleDetectAnomalies without any parameters. More...
 
 SimpleDetectAnomalies (string uid)
 Creates a SimpleDetectAnomalies with a UID that is used to give the SimpleDetectAnomalies a unique ID. More...
 
SimpleDetectAnomalies SetConcurrency (int value)
 Sets value for concurrency More...
 
SimpleDetectAnomalies SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
SimpleDetectAnomalies SetCustomInterval (int value)
 Sets value for customInterval More...
 
SimpleDetectAnomalies SetCustomIntervalCol (string value)
 Sets value for customInterval column More...
 
SimpleDetectAnomalies SetErrorCol (string value)
 Sets value for errorCol More...
 
SimpleDetectAnomalies SetGranularity (string value)
 Sets value for granularity More...
 
SimpleDetectAnomalies SetGranularityCol (string value)
 Sets value for granularity column More...
 
SimpleDetectAnomalies SetGroupbyCol (string value)
 Sets value for groupbyCol More...
 
SimpleDetectAnomalies SetHandler (object value)
 Sets value for handler More...
 
SimpleDetectAnomalies SetImputeFixedValue (double value)
 Sets value for imputeFixedValue More...
 
SimpleDetectAnomalies SetImputeFixedValueCol (string value)
 Sets value for imputeFixedValue column More...
 
SimpleDetectAnomalies SetImputeMode (string value)
 Sets value for imputeMode More...
 
SimpleDetectAnomalies SetImputeModeCol (string value)
 Sets value for imputeMode column More...
 
SimpleDetectAnomalies SetMaxAnomalyRatio (double value)
 Sets value for maxAnomalyRatio More...
 
SimpleDetectAnomalies SetMaxAnomalyRatioCol (string value)
 Sets value for maxAnomalyRatio column More...
 
SimpleDetectAnomalies SetOutputCol (string value)
 Sets value for outputCol More...
 
SimpleDetectAnomalies SetPeriod (int value)
 Sets value for period More...
 
SimpleDetectAnomalies SetPeriodCol (string value)
 Sets value for period column More...
 
SimpleDetectAnomalies SetSensitivity (int value)
 Sets value for sensitivity More...
 
SimpleDetectAnomalies SetSensitivityCol (string value)
 Sets value for sensitivity column More...
 
SimpleDetectAnomalies SetSeries (TimeSeriesPoint[] value)
 Sets value for series More...
 
SimpleDetectAnomalies SetSeriesCol (string value)
 Sets value for series column More...
 
SimpleDetectAnomalies SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
SimpleDetectAnomalies SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
SimpleDetectAnomalies SetTimeout (double value)
 Sets value for timeout More...
 
SimpleDetectAnomalies SetTimestampCol (string value)
 Sets value for timestampCol More...
 
SimpleDetectAnomalies SetUrl (string value)
 Sets value for url More...
 
SimpleDetectAnomalies SetValueCol (string value)
 Sets value for valueCol More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
int GetCustomInterval ()
 Gets customInterval value More...
 
string GetErrorCol ()
 Gets errorCol value More...
 
string GetGranularity ()
 Gets granularity value More...
 
string GetGroupbyCol ()
 Gets groupbyCol value More...
 
object GetHandler ()
 Gets handler value More...
 
double GetImputeFixedValue ()
 Gets imputeFixedValue value More...
 
string GetImputeMode ()
 Gets imputeMode value More...
 
double GetMaxAnomalyRatio ()
 Gets maxAnomalyRatio value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
int GetPeriod ()
 Gets period value More...
 
int GetSensitivity ()
 Gets sensitivity value More...
 
TimeSeriesPoint [] GetSeries ()
 Gets series value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey value More...
 
double GetTimeout ()
 Gets timeout value More...
 
string GetTimestampCol ()
 Gets timestampCol value More...
 
string GetUrl ()
 Gets url value More...
 
string GetValueCol ()
 Gets valueCol value More...
 
void Save (string path)
 Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...
 
JavaMLWriter Write ()
 
Returns
a JavaMLWriter instance for this ML instance.

 
JavaMLReader< SimpleDetectAnomaliesRead ()
 Get the corresponding JavaMLReader instance. More...
 
SimpleDetectAnomalies SetLocation (string value)
 Sets value for location More...
 
SimpleDetectAnomalies SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

static SimpleDetectAnomalies Load (string path)
 Loads the SimpleDetectAnomalies that was previously saved using Save(string). More...
 

Detailed Description

SimpleDetectAnomalies implements SimpleDetectAnomalies

Constructor & Destructor Documentation

◆ SimpleDetectAnomalies() [1/2]

Synapse.ML.Cognitive.SimpleDetectAnomalies.SimpleDetectAnomalies ( )
inline

Creates a SimpleDetectAnomalies without any parameters.

◆ SimpleDetectAnomalies() [2/2]

Synapse.ML.Cognitive.SimpleDetectAnomalies.SimpleDetectAnomalies ( string  uid)
inline

Creates a SimpleDetectAnomalies with a UID that is used to give the SimpleDetectAnomalies a unique ID.

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetConcurrency()

int Synapse.ML.Cognitive.SimpleDetectAnomalies.GetConcurrency ( )

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Cognitive.SimpleDetectAnomalies.GetConcurrentTimeout ( )

Gets concurrentTimeout value

Returns
concurrentTimeout: max number seconds to wait on futures if concurrency >= 1

◆ GetCustomInterval()

int Synapse.ML.Cognitive.SimpleDetectAnomalies.GetCustomInterval ( )

Gets customInterval value

Returns
customInterval: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as granularity=minutely, customInterval=5.

◆ GetErrorCol()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetErrorCol ( )

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetGranularity()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetGranularity ( )

Gets granularity value

Returns
granularity: Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.

◆ GetGroupbyCol()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetGroupbyCol ( )

Gets groupbyCol value

Returns
groupbyCol: column that groups the series

◆ GetHandler()

object Synapse.ML.Cognitive.SimpleDetectAnomalies.GetHandler ( )

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetImputeFixedValue()

double Synapse.ML.Cognitive.SimpleDetectAnomalies.GetImputeFixedValue ( )

Gets imputeFixedValue value

Returns
imputeFixedValue: Optional argument, fixed value to use when imputeMode is set to "fixed"

◆ GetImputeMode()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetImputeMode ( )

Gets imputeMode value

Returns
imputeMode: Optional argument, impute mode of a time series. Possible values: auto, previous, linear, fixed, zero, notFill

◆ GetMaxAnomalyRatio()

double Synapse.ML.Cognitive.SimpleDetectAnomalies.GetMaxAnomalyRatio ( )

Gets maxAnomalyRatio value

Returns
maxAnomalyRatio: Optional argument, advanced model parameter, max anomaly ratio in a time series.

◆ GetOutputCol()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPeriod()

int Synapse.ML.Cognitive.SimpleDetectAnomalies.GetPeriod ( )

Gets period value

Returns
period: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.

◆ GetSensitivity()

int Synapse.ML.Cognitive.SimpleDetectAnomalies.GetSensitivity ( )

Gets sensitivity value

Returns
sensitivity: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted

◆ GetSeries()

TimeSeriesPoint [] Synapse.ML.Cognitive.SimpleDetectAnomalies.GetSeries ( )
inline

Gets series value

Returns
series: Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

double Synapse.ML.Cognitive.SimpleDetectAnomalies.GetTimeout ( )

Gets timeout value

Returns
timeout: number of seconds to wait before closing the connection

◆ GetTimestampCol()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetTimestampCol ( )

Gets timestampCol value

Returns
timestampCol: column representing the time of the series

◆ GetUrl()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetUrl ( )

Gets url value

Returns
url: Url of the service

◆ GetValueCol()

string Synapse.ML.Cognitive.SimpleDetectAnomalies.GetValueCol ( )

Gets valueCol value

Returns
valueCol: column representing the value of the series

◆ Load()

static SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.Load ( string  path)
static

Loads the SimpleDetectAnomalies that was previously saved using Save(string).

Parameters
pathThe path the previous SimpleDetectAnomalies was saved to
Returns
New SimpleDetectAnomalies object, loaded from path.

◆ Read()

JavaMLReader<SimpleDetectAnomalies> Synapse.ML.Cognitive.SimpleDetectAnomalies.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<SimpleDetectAnomalies> instance for this ML instance.

◆ Save()

void Synapse.ML.Cognitive.SimpleDetectAnomalies.Save ( string  path)

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters
pathThe path to save the object to

◆ SetConcurrency()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetConcurrency ( int  value)

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New SimpleDetectAnomalies object

◆ SetConcurrentTimeout()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetConcurrentTimeout ( double  value)

Sets value for concurrentTimeout

Parameters
valuemax number seconds to wait on futures if concurrency >= 1
Returns
New SimpleDetectAnomalies object

◆ SetCustomInterval()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetCustomInterval ( int  value)

Sets value for customInterval

Parameters
valueCustom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as granularity=minutely, customInterval=5.
Returns
New SimpleDetectAnomalies object

◆ SetCustomIntervalCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetCustomIntervalCol ( string  value)

Sets value for customInterval column

Parameters
valueCustom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as granularity=minutely, customInterval=5.
Returns
New SimpleDetectAnomalies object

◆ SetErrorCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetErrorCol ( string  value)

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New SimpleDetectAnomalies object

◆ SetGranularity()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetGranularity ( string  value)

Sets value for granularity

Parameters
valueCan only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.
Returns
New SimpleDetectAnomalies object

◆ SetGranularityCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetGranularityCol ( string  value)

Sets value for granularity column

Parameters
valueCan only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.
Returns
New SimpleDetectAnomalies object

◆ SetGroupbyCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetGroupbyCol ( string  value)

Sets value for groupbyCol

Parameters
valuecolumn that groups the series
Returns
New SimpleDetectAnomalies object

◆ SetHandler()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetHandler ( object  value)

Sets value for handler

Parameters
valueWhich strategy to use when handling requests
Returns
New SimpleDetectAnomalies object

◆ SetImputeFixedValue()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetImputeFixedValue ( double  value)

Sets value for imputeFixedValue

Parameters
valueOptional argument, fixed value to use when imputeMode is set to "fixed"
Returns
New SimpleDetectAnomalies object

◆ SetImputeFixedValueCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetImputeFixedValueCol ( string  value)

Sets value for imputeFixedValue column

Parameters
valueOptional argument, fixed value to use when imputeMode is set to "fixed"
Returns
New SimpleDetectAnomalies object

◆ SetImputeMode()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetImputeMode ( string  value)

Sets value for imputeMode

Parameters
valueOptional argument, impute mode of a time series. Possible values: auto, previous, linear, fixed, zero, notFill
Returns
New SimpleDetectAnomalies object

◆ SetImputeModeCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetImputeModeCol ( string  value)

Sets value for imputeMode column

Parameters
valueOptional argument, impute mode of a time series. Possible values: auto, previous, linear, fixed, zero, notFill
Returns
New SimpleDetectAnomalies object

◆ SetLinkedService()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetLinkedService ( string  value)

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New SimpleDetectAnomalies object

◆ SetLocation()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetLocation ( string  value)

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New SimpleDetectAnomalies object

◆ SetMaxAnomalyRatio()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetMaxAnomalyRatio ( double  value)

Sets value for maxAnomalyRatio

Parameters
valueOptional argument, advanced model parameter, max anomaly ratio in a time series.
Returns
New SimpleDetectAnomalies object

◆ SetMaxAnomalyRatioCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetMaxAnomalyRatioCol ( string  value)

Sets value for maxAnomalyRatio column

Parameters
valueOptional argument, advanced model parameter, max anomaly ratio in a time series.
Returns
New SimpleDetectAnomalies object

◆ SetOutputCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New SimpleDetectAnomalies object

◆ SetPeriod()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetPeriod ( int  value)

Sets value for period

Parameters
valueOptional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
Returns
New SimpleDetectAnomalies object

◆ SetPeriodCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetPeriodCol ( string  value)

Sets value for period column

Parameters
valueOptional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
Returns
New SimpleDetectAnomalies object

◆ SetSensitivity()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetSensitivity ( int  value)

Sets value for sensitivity

Parameters
valueOptional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted
Returns
New SimpleDetectAnomalies object

◆ SetSensitivityCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetSensitivityCol ( string  value)

Sets value for sensitivity column

Parameters
valueOptional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted
Returns
New SimpleDetectAnomalies object

◆ SetSeries()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetSeries ( TimeSeriesPoint []  value)

Sets value for series

Parameters
valueTime series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.
Returns
New SimpleDetectAnomalies object

◆ SetSeriesCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetSeriesCol ( string  value)

Sets value for series column

Parameters
valueTime series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.
Returns
New SimpleDetectAnomalies object

◆ SetSubscriptionKey()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New SimpleDetectAnomalies object

◆ SetSubscriptionKeyCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetSubscriptionKeyCol ( string  value)

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New SimpleDetectAnomalies object

◆ SetTimeout()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetTimeout ( double  value)

Sets value for timeout

Parameters
valuenumber of seconds to wait before closing the connection
Returns
New SimpleDetectAnomalies object

◆ SetTimestampCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetTimestampCol ( string  value)

Sets value for timestampCol

Parameters
valuecolumn representing the time of the series
Returns
New SimpleDetectAnomalies object

◆ SetUrl()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetUrl ( string  value)

Sets value for url

Parameters
valueUrl of the service
Returns
New SimpleDetectAnomalies object

◆ SetValueCol()

SimpleDetectAnomalies Synapse.ML.Cognitive.SimpleDetectAnomalies.SetValueCol ( string  value)

Sets value for valueCol

Parameters
valuecolumn representing the value of the series
Returns
New SimpleDetectAnomalies object

The documentation for this class was generated from the following file: