SimpleFitMultivariateAnomaly implements SimpleFitMultivariateAnomaly More...

Inheritance diagram for Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly:

[legend]

Collaboration diagram for Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly:

[legend]

Public Member Functions
	SimpleFitMultivariateAnomaly ()
	Creates a SimpleFitMultivariateAnomaly without any parameters. More...

	SimpleFitMultivariateAnomaly (string uid)
	Creates a SimpleFitMultivariateAnomaly with a UID that is used to give the SimpleFitMultivariateAnomaly a unique ID. More...

SimpleFitMultivariateAnomaly	SetAlignMode (string value)
	Sets value for alignMode More...

SimpleFitMultivariateAnomaly	SetBackoffs (int[] value)
	Sets value for backoffs More...

SimpleFitMultivariateAnomaly	SetDisplayName (string value)
	Sets value for displayName More...

SimpleFitMultivariateAnomaly	SetEndTime (string value)
	Sets value for endTime More...

SimpleFitMultivariateAnomaly	SetErrorCol (string value)
	Sets value for errorCol More...

SimpleFitMultivariateAnomaly	SetFillNAMethod (string value)
	Sets value for fillNAMethod More...

SimpleFitMultivariateAnomaly	SetInitialPollingDelay (int value)
	Sets value for initialPollingDelay More...

SimpleFitMultivariateAnomaly	SetInputCols (string[] value)
	Sets value for inputCols More...

SimpleFitMultivariateAnomaly	SetIntermediateSaveDir (string value)
	Sets value for intermediateSaveDir More...

SimpleFitMultivariateAnomaly	SetMaxPollingRetries (int value)
	Sets value for maxPollingRetries More...

SimpleFitMultivariateAnomaly	SetOutputCol (string value)
	Sets value for outputCol More...

SimpleFitMultivariateAnomaly	SetPaddingValue (int value)
	Sets value for paddingValue More...

SimpleFitMultivariateAnomaly	SetPollingDelay (int value)
	Sets value for pollingDelay More...

SimpleFitMultivariateAnomaly	SetSlidingWindow (int value)
	Sets value for slidingWindow More...

SimpleFitMultivariateAnomaly	SetStartTime (string value)
	Sets value for startTime More...

SimpleFitMultivariateAnomaly	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

SimpleFitMultivariateAnomaly	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

SimpleFitMultivariateAnomaly	SetSuppressMaxRetriesException (bool value)
	Sets value for suppressMaxRetriesException More...

SimpleFitMultivariateAnomaly	SetTimestampCol (string value)
	Sets value for timestampCol More...

SimpleFitMultivariateAnomaly	SetUrl (string value)
	Sets value for url More...

string	GetAlignMode ()
	Gets alignMode value More...

int[]	GetBackoffs ()
	Gets backoffs value More...

string	GetDisplayName ()
	Gets displayName value More...

string	GetEndTime ()
	Gets endTime value More...

string	GetErrorCol ()
	Gets errorCol value More...

string	GetFillNAMethod ()
	Gets fillNAMethod value More...

int	GetInitialPollingDelay ()
	Gets initialPollingDelay value More...

string[]	GetInputCols ()
	Gets inputCols value More...

string	GetIntermediateSaveDir ()
	Gets intermediateSaveDir value More...

int	GetMaxPollingRetries ()
	Gets maxPollingRetries value More...

string	GetOutputCol ()
	Gets outputCol value More...

int	GetPaddingValue ()
	Gets paddingValue value More...

int	GetPollingDelay ()
	Gets pollingDelay value More...

int	GetSlidingWindow ()
	Gets slidingWindow value More...

string	GetStartTime ()
	Gets startTime value More...

string	GetSubscriptionKey ()
	Gets subscriptionKey value More...

bool	GetSuppressMaxRetriesException ()
	Gets suppressMaxRetriesException value More...

string	GetTimestampCol ()
	Gets timestampCol value More...

string	GetUrl ()
	Gets url value More...

override SimpleDetectMultivariateAnomaly	Fit (DataFrame dataset)
	Fits a model to the input data. 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< SimpleFitMultivariateAnomaly >	Read ()
	Get the corresponding JavaMLReader instance. More...

SimpleFitMultivariateAnomaly	SetLocation (string value)
	Sets value for location More...

Static Public Member Functions
static SimpleFitMultivariateAnomaly	Load (string path)
	Loads the SimpleFitMultivariateAnomaly that was previously saved using Save(string). More...

Detailed Description

SimpleFitMultivariateAnomaly implements SimpleFitMultivariateAnomaly

Constructor & Destructor Documentation

◆ SimpleFitMultivariateAnomaly() [1/2]

Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SimpleFitMultivariateAnomaly ( )

inline

Creates a SimpleFitMultivariateAnomaly without any parameters.

◆ SimpleFitMultivariateAnomaly() [2/2]

Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SimpleFitMultivariateAnomaly ( string uid )

inline

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

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ Fit()

override SimpleDetectMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.Fit ( DataFrame dataset )

Fits a model to the input data.

Parameters

dataset The DataFrame to fit the model to.

Returns: SimpleDetectMultivariateAnomaly

◆ GetAlignMode()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetAlignMode ( )

Gets alignMode value

Returns: alignMode: An optional field, indicates how we align different variables into the same time-range which is required by the model.{Inner, Outer}

◆ GetBackoffs()

int [] Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetBackoffs ( )

Gets backoffs value

Returns: backoffs: array of backoffs to use in the handler

◆ GetDisplayName()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetDisplayName ( )

Gets displayName value

Returns: displayName: optional field, name of the model

◆ GetEndTime()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetEndTime ( )

Gets endTime value

Returns: endTime: A required field, end time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.

◆ GetErrorCol()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetFillNAMethod()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetFillNAMethod ( )

Gets fillNAMethod value

Returns: fillNAMethod: An optional field, indicates how missed values will be filled with. Can not be set to NotFill, when alignMode is Outer.{Previous, Subsequent, Linear, Zero, Fixed}

◆ GetInitialPollingDelay()

int Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetInitialPollingDelay ( )

Gets initialPollingDelay value

Returns: initialPollingDelay: number of milliseconds to wait before first poll for result

◆ GetInputCols()

string [] Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetInputCols ( )

Gets inputCols value

Returns: inputCols: The names of the input columns

◆ GetIntermediateSaveDir()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetIntermediateSaveDir ( )

Gets intermediateSaveDir value

Returns: intermediateSaveDir: Blob storage location in HDFS where intermediate data is saved while training.

◆ GetMaxPollingRetries()

int Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns: maxPollingRetries: number of times to poll

◆ GetOutputCol()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPaddingValue()

int Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetPaddingValue ( )

Gets paddingValue value

Returns: paddingValue: optional field, is only useful if FillNAMethod is set to Fixed.

◆ GetPollingDelay()

int Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetPollingDelay ( )

Gets pollingDelay value

Returns: pollingDelay: number of milliseconds to wait between polling

◆ GetSlidingWindow()

int Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetSlidingWindow ( )

Gets slidingWindow value

Returns: slidingWindow: An optional field, indicates how many history points will be used to determine the anomaly score of one subsequent point.

◆ GetStartTime()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetStartTime ( )

Gets startTime value

Returns: startTime: A required field, start time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.

◆ GetSubscriptionKey()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesException()

bool Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetSuppressMaxRetriesException ( )

Gets suppressMaxRetriesException value

Returns: suppressMaxRetriesException: set true to suppress the maxumimum retries exception and report in the error column

◆ GetTimestampCol()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetTimestampCol ( )

Gets timestampCol value

Returns: timestampCol: Timestamp column name

◆ GetUrl()

string Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.Load ( string path )

static

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

Parameters

path	The path the previous SimpleFitMultivariateAnomaly was saved to

Returns: New SimpleFitMultivariateAnomaly object, loaded from path.

◆ Read()

JavaMLReader<SimpleFitMultivariateAnomaly> Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.Read ( )

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<SimpleFitMultivariateAnomaly> instance for this ML instance.

◆ Save()

void Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.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

path	The path to save the object to

◆ SetAlignMode()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetAlignMode ( string value )

Sets value for alignMode

Parameters

value An optional field, indicates how we align different variables into the same time-range which is required by the model.{Inner, Outer}

Returns: New SimpleFitMultivariateAnomaly object

◆ SetBackoffs()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetBackoffs ( int[] value )

Sets value for backoffs

Parameters

value array of backoffs to use in the handler

Returns: New SimpleFitMultivariateAnomaly object

◆ SetDisplayName()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetDisplayName ( string value )

Sets value for displayName

Parameters

value optional field, name of the model

Returns: New SimpleFitMultivariateAnomaly object

◆ SetEndTime()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetEndTime ( string value )

Sets value for endTime

Parameters

value A required field, end time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.

Returns: New SimpleFitMultivariateAnomaly object

◆ SetErrorCol()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New SimpleFitMultivariateAnomaly object

◆ SetFillNAMethod()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetFillNAMethod ( string value )

Sets value for fillNAMethod

Parameters

value An optional field, indicates how missed values will be filled with. Can not be set to NotFill, when alignMode is Outer.{Previous, Subsequent, Linear, Zero, Fixed}

Returns: New SimpleFitMultivariateAnomaly object

◆ SetInitialPollingDelay()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetInitialPollingDelay ( int value )

Sets value for initialPollingDelay

Parameters

value number of milliseconds to wait before first poll for result

Returns: New SimpleFitMultivariateAnomaly object

◆ SetInputCols()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetInputCols ( string[] value )

Sets value for inputCols

Parameters

value The names of the input columns

Returns: New SimpleFitMultivariateAnomaly object

◆ SetIntermediateSaveDir()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetIntermediateSaveDir ( string value )

Sets value for intermediateSaveDir

Parameters

value Blob storage location in HDFS where intermediate data is saved while training.

Returns: New SimpleFitMultivariateAnomaly object

◆ SetLocation()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New SimpleFitMultivariateAnomaly object

◆ SetMaxPollingRetries()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetMaxPollingRetries ( int value )

Sets value for maxPollingRetries

Parameters

value number of times to poll

Returns: New SimpleFitMultivariateAnomaly object

◆ SetOutputCol()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New SimpleFitMultivariateAnomaly object

◆ SetPaddingValue()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetPaddingValue ( int value )

Sets value for paddingValue

Parameters

value optional field, is only useful if FillNAMethod is set to Fixed.

Returns: New SimpleFitMultivariateAnomaly object

◆ SetPollingDelay()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetPollingDelay ( int value )

Sets value for pollingDelay

Parameters

value number of milliseconds to wait between polling

Returns: New SimpleFitMultivariateAnomaly object

◆ SetSlidingWindow()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetSlidingWindow ( int value )

Sets value for slidingWindow

Parameters

value An optional field, indicates how many history points will be used to determine the anomaly score of one subsequent point.

Returns: New SimpleFitMultivariateAnomaly object

◆ SetStartTime()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetStartTime ( string value )

Sets value for startTime

Parameters

value A required field, start time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.

Returns: New SimpleFitMultivariateAnomaly object

◆ SetSubscriptionKey()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New SimpleFitMultivariateAnomaly object

◆ SetSubscriptionKeyCol()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New SimpleFitMultivariateAnomaly object

◆ SetSuppressMaxRetriesException()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetSuppressMaxRetriesException ( bool value )

Sets value for suppressMaxRetriesException

Parameters

value set true to suppress the maxumimum retries exception and report in the error column

Returns: New SimpleFitMultivariateAnomaly object

◆ SetTimestampCol()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetTimestampCol ( string value )

Sets value for timestampCol

Parameters

value Timestamp column name

Returns: New SimpleFitMultivariateAnomaly object

◆ SetUrl()

SimpleFitMultivariateAnomaly Synapse.ML.Services.Anomaly.SimpleFitMultivariateAnomaly.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New SimpleFitMultivariateAnomaly object

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

synapse/ml/services/anomaly/SimpleFitMultivariateAnomaly.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SimpleFitMultivariateAnomaly() [1/2]

◆ SimpleFitMultivariateAnomaly() [2/2]

Member Function Documentation

◆ Fit()

◆ GetAlignMode()

◆ GetBackoffs()

◆ GetDisplayName()

◆ GetEndTime()

◆ GetErrorCol()

◆ GetFillNAMethod()

◆ GetInitialPollingDelay()

◆ GetInputCols()

◆ GetIntermediateSaveDir()

◆ GetMaxPollingRetries()

◆ GetOutputCol()

◆ GetPaddingValue()

◆ GetPollingDelay()

◆ GetSlidingWindow()

◆ GetStartTime()

◆ GetSubscriptionKey()

◆ GetSuppressMaxRetriesException()

◆ GetTimestampCol()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAlignMode()

◆ SetBackoffs()

◆ SetDisplayName()

◆ SetEndTime()

◆ SetErrorCol()

◆ SetFillNAMethod()

◆ SetInitialPollingDelay()

◆ SetInputCols()

◆ SetIntermediateSaveDir()

◆ SetLocation()

◆ SetMaxPollingRetries()

◆ SetOutputCol()

◆ SetPaddingValue()

◆ SetPollingDelay()

◆ SetSlidingWindow()

◆ SetStartTime()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetSuppressMaxRetriesException()

◆ SetTimestampCol()

◆ SetUrl()