Synapse.ML.Cognitive.FitMultivariateAnomaly Class Reference

FitMultivariateAnomaly implements FitMultivariateAnomaly More...

Inheritance diagram for Synapse.ML.Cognitive.FitMultivariateAnomaly:

Collaboration diagram for Synapse.ML.Cognitive.FitMultivariateAnomaly:

Public Member Functions
	FitMultivariateAnomaly ()
	Creates a FitMultivariateAnomaly without any parameters. More...
	FitMultivariateAnomaly (string uid)
	Creates a FitMultivariateAnomaly with a UID that is used to give the FitMultivariateAnomaly a unique ID. More...
FitMultivariateAnomaly	SetAlignMode (string value)
	Sets value for alignMode More...
FitMultivariateAnomaly	SetBackoffs (int[] value)
	Sets value for backoffs More...
FitMultivariateAnomaly	SetDisplayName (string value)
	Sets value for displayName More...
FitMultivariateAnomaly	SetEndTime (string value)
	Sets value for endTime More...
FitMultivariateAnomaly	SetErrorCol (string value)
	Sets value for errorCol More...
FitMultivariateAnomaly	SetFillNAMethod (string value)
	Sets value for fillNAMethod More...
FitMultivariateAnomaly	SetInitialPollingDelay (int value)
	Sets value for initialPollingDelay More...
FitMultivariateAnomaly	SetInputCols (string[] value)
	Sets value for inputCols More...
FitMultivariateAnomaly	SetIntermediateSaveDir (string value)
	Sets value for intermediateSaveDir More...
FitMultivariateAnomaly	SetMaxPollingRetries (int value)
	Sets value for maxPollingRetries More...
FitMultivariateAnomaly	SetOutputCol (string value)
	Sets value for outputCol More...
FitMultivariateAnomaly	SetPaddingValue (int value)
	Sets value for paddingValue More...
FitMultivariateAnomaly	SetPollingDelay (int value)
	Sets value for pollingDelay More...
FitMultivariateAnomaly	SetSlidingWindow (int value)
	Sets value for slidingWindow More...
FitMultivariateAnomaly	SetStartTime (string value)
	Sets value for startTime More...
FitMultivariateAnomaly	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
FitMultivariateAnomaly	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
FitMultivariateAnomaly	SetSuppressMaxRetriesException (bool value)
	Sets value for suppressMaxRetriesException More...
FitMultivariateAnomaly	SetTimestampCol (string value)
	Sets value for timestampCol More...
FitMultivariateAnomaly	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 DetectMultivariateAnomaly	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< FitMultivariateAnomaly >	Read ()
	Get the corresponding JavaMLReader instance. More...
FitMultivariateAnomaly	SetLocation (string value)
	Sets value for location More...

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

Detailed Description

FitMultivariateAnomaly implements FitMultivariateAnomaly

Constructor & Destructor Documentation

FitMultivariateAnomaly() [1/2]

Synapse.ML.Cognitive.FitMultivariateAnomaly.FitMultivariateAnomaly ( )

inline

Creates a FitMultivariateAnomaly without any parameters.

FitMultivariateAnomaly() [2/2]

Synapse.ML.Cognitive.FitMultivariateAnomaly.FitMultivariateAnomaly ( string  uid )

inline

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

Parameters

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

Member Function Documentation

Fit()

override DetectMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.Fit

(

DataFrame

dataset

)

Fits a model to the input data.

Parameters

dataset

The DataFrame to fit the model to.

Returns

DetectMultivariateAnomaly

GetAlignMode()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.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.Cognitive.FitMultivariateAnomaly.GetBackoffs

(

)

Gets backoffs value

Returns

backoffs: array of backoffs to use in the handler

GetDisplayName()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.GetDisplayName

(

)

Gets displayName value

Returns

displayName: optional field, name of the model

GetEndTime()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.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.Cognitive.FitMultivariateAnomaly.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetFillNAMethod()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.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.Cognitive.FitMultivariateAnomaly.GetInitialPollingDelay

(

)

Gets initialPollingDelay value

Returns

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

GetInputCols()

string [] Synapse.ML.Cognitive.FitMultivariateAnomaly.GetInputCols

(

)

Gets inputCols value

Returns

inputCols: The names of the input columns

GetIntermediateSaveDir()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.GetIntermediateSaveDir

(

)

Gets intermediateSaveDir value

Returns

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

GetMaxPollingRetries()

int Synapse.ML.Cognitive.FitMultivariateAnomaly.GetMaxPollingRetries

(

)

Gets maxPollingRetries value

Returns

maxPollingRetries: number of times to poll

GetOutputCol()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPaddingValue()

int Synapse.ML.Cognitive.FitMultivariateAnomaly.GetPaddingValue

(

)

Gets paddingValue value

Returns

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

GetPollingDelay()

int Synapse.ML.Cognitive.FitMultivariateAnomaly.GetPollingDelay

(

)

Gets pollingDelay value

Returns

pollingDelay: number of milliseconds to wait between polling

GetSlidingWindow()

int Synapse.ML.Cognitive.FitMultivariateAnomaly.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.Cognitive.FitMultivariateAnomaly.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.Cognitive.FitMultivariateAnomaly.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSuppressMaxRetriesException()

bool Synapse.ML.Cognitive.FitMultivariateAnomaly.GetSuppressMaxRetriesException

(

)

Gets suppressMaxRetriesException value

Returns

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

GetTimestampCol()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.GetTimestampCol

(

)

Gets timestampCol value

Returns

timestampCol: Timestamp column name

GetUrl()

string Synapse.ML.Cognitive.FitMultivariateAnomaly.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous FitMultivariateAnomaly was saved to

Returns

New FitMultivariateAnomaly object, loaded from path.

Read()

JavaMLReader<FitMultivariateAnomaly> Synapse.ML.Cognitive.FitMultivariateAnomaly.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<FitMultivariateAnomaly> instance for this ML instance.

Save()

void Synapse.ML.Cognitive.FitMultivariateAnomaly.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()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.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 FitMultivariateAnomaly object

SetBackoffs()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetBackoffs

(

int[]

value

)

Sets value for backoffs

Parameters

value

array of backoffs to use in the handler

Returns

New FitMultivariateAnomaly object

SetDisplayName()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetDisplayName

(

string

value

)

Sets value for displayName

Parameters

value

optional field, name of the model

Returns

New FitMultivariateAnomaly object

SetEndTime()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.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 FitMultivariateAnomaly object

SetErrorCol()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New FitMultivariateAnomaly object

SetFillNAMethod()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.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 FitMultivariateAnomaly object

SetInitialPollingDelay()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetInitialPollingDelay

(

int

value

)

Sets value for initialPollingDelay

Parameters

value

number of milliseconds to wait before first poll for result

Returns

New FitMultivariateAnomaly object

SetInputCols()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetInputCols

(

string[]

value

)

Sets value for inputCols

Parameters

value

The names of the input columns

Returns

New FitMultivariateAnomaly object

SetIntermediateSaveDir()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetIntermediateSaveDir

(

string

value

)

Sets value for intermediateSaveDir

Parameters

value

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

Returns

New FitMultivariateAnomaly object

SetLocation()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New FitMultivariateAnomaly object

SetMaxPollingRetries()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetMaxPollingRetries

(

int

value

)

Sets value for maxPollingRetries

Parameters

value

number of times to poll

Returns

New FitMultivariateAnomaly object

SetOutputCol()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New FitMultivariateAnomaly object

SetPaddingValue()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetPaddingValue

(

int

value

)

Sets value for paddingValue

Parameters

value

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

Returns

New FitMultivariateAnomaly object

SetPollingDelay()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetPollingDelay

(

int

value

)

Sets value for pollingDelay

Parameters

value

number of milliseconds to wait between polling

Returns

New FitMultivariateAnomaly object

SetSlidingWindow()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.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 FitMultivariateAnomaly object

SetStartTime()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.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 FitMultivariateAnomaly object

SetSubscriptionKey()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New FitMultivariateAnomaly object

SetSubscriptionKeyCol()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New FitMultivariateAnomaly object

SetSuppressMaxRetriesException()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.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 FitMultivariateAnomaly object

SetTimestampCol()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetTimestampCol

(

string

value

)

Sets value for timestampCol

Parameters

value

Timestamp column name

Returns

New FitMultivariateAnomaly object

SetUrl()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New FitMultivariateAnomaly object

---

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

• synapse/ml/cognitive/FitMultivariateAnomaly.cs