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

FitMultivariateAnomaly implements FitMultivariateAnomaly More...

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

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 SetConnectionString (string value)
 Sets value for connectionString More...
 
FitMultivariateAnomaly SetContainerName (string value)
 Sets value for containerName More...
 
FitMultivariateAnomaly SetDiagnosticsInfo (object value)
 Sets value for diagnosticsInfo More...
 
FitMultivariateAnomaly SetDisplayName (string value)
 Sets value for displayName More...
 
FitMultivariateAnomaly SetEndTime (string value)
 Sets value for endTime More...
 
FitMultivariateAnomaly SetEndpoint (string value)
 Sets value for endpoint 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 SetSasToken (string value)
 Sets value for sasToken More...
 
FitMultivariateAnomaly SetSlidingWindow (int value)
 Sets value for slidingWindow More...
 
FitMultivariateAnomaly SetStartTime (string value)
 Sets value for startTime More...
 
FitMultivariateAnomaly SetStorageKey (string value)
 Sets value for storageKey More...
 
FitMultivariateAnomaly SetStorageName (string value)
 Sets value for storageName More...
 
FitMultivariateAnomaly SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
FitMultivariateAnomaly SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
FitMultivariateAnomaly SetSuppressMaxRetriesExceededException (bool value)
 Sets value for suppressMaxRetriesExceededException 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 GetConnectionString ()
 Gets connectionString value More...
 
string GetContainerName ()
 Gets containerName value More...
 
object GetDiagnosticsInfo ()
 Gets diagnosticsInfo value More...
 
string GetDisplayName ()
 Gets displayName value More...
 
string GetEndTime ()
 Gets endTime value More...
 
string GetEndpoint ()
 Gets endpoint 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...
 
string GetSasToken ()
 Gets sasToken value More...
 
int GetSlidingWindow ()
 Gets slidingWindow value More...
 
string GetStartTime ()
 Gets startTime value More...
 
string GetStorageKey ()
 Gets storageKey value More...
 
string GetStorageName ()
 Gets storageName value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey value More...
 
bool GetSuppressMaxRetriesExceededException ()
 Gets suppressMaxRetriesExceededException 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< FitMultivariateAnomalyRead ()
 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
uidAn 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
datasetThe 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

◆ GetConnectionString()

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

Gets connectionString value

Returns
connectionString: Connection String for your storage account used for uploading files.

◆ GetContainerName()

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

Gets containerName value

Returns
containerName: Container that will be used to upload files to.

◆ GetDiagnosticsInfo()

object Synapse.ML.Cognitive.FitMultivariateAnomaly.GetDiagnosticsInfo ( )

Gets diagnosticsInfo value

Returns
diagnosticsInfo: diagnosticsInfo for training a multivariate anomaly detection model

◆ GetDisplayName()

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

Gets displayName value

Returns
displayName: optional field, name of the model

◆ GetEndpoint()

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

Gets endpoint value

Returns
endpoint: End Point for your storage account used for uploading files.

◆ 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: Directory name of which you want to save the intermediate data produced 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

◆ GetSasToken()

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

Gets sasToken value

Returns
sasToken: SAS Token for your storage account used for uploading files.

◆ 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.

◆ GetStorageKey()

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

Gets storageKey value

Returns
storageKey: Storage Key for your storage account used for uploading files.

◆ GetStorageName()

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

Gets storageName value

Returns
storageName: Storage Name for your storage account used for uploading files.

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Cognitive.FitMultivariateAnomaly.GetSuppressMaxRetriesExceededException ( )

Gets suppressMaxRetriesExceededException value

Returns
suppressMaxRetriesExceededException: 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
pathThe 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
pathThe path to save the object to

◆ SetAlignMode()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetAlignMode ( string  value)

Sets value for alignMode

Parameters
valueAn 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
valuearray of backoffs to use in the handler
Returns
New FitMultivariateAnomaly object

◆ SetConnectionString()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetConnectionString ( string  value)

Sets value for connectionString

Parameters
valueConnection String for your storage account used for uploading files.
Returns
New FitMultivariateAnomaly object

◆ SetContainerName()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetContainerName ( string  value)

Sets value for containerName

Parameters
valueContainer that will be used to upload files to.
Returns
New FitMultivariateAnomaly object

◆ SetDiagnosticsInfo()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetDiagnosticsInfo ( object  value)

Sets value for diagnosticsInfo

Parameters
valuediagnosticsInfo for training a multivariate anomaly detection model
Returns
New FitMultivariateAnomaly object

◆ SetDisplayName()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetDisplayName ( string  value)

Sets value for displayName

Parameters
valueoptional field, name of the model
Returns
New FitMultivariateAnomaly object

◆ SetEndpoint()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetEndpoint ( string  value)

Sets value for endpoint

Parameters
valueEnd Point for your storage account used for uploading files.
Returns
New FitMultivariateAnomaly object

◆ SetEndTime()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetEndTime ( string  value)

Sets value for endTime

Parameters
valueA 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
valuecolumn to hold http errors
Returns
New FitMultivariateAnomaly object

◆ SetFillNAMethod()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetFillNAMethod ( string  value)

Sets value for fillNAMethod

Parameters
valueAn 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
valuenumber 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
valueThe names of the input columns
Returns
New FitMultivariateAnomaly object

◆ SetIntermediateSaveDir()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetIntermediateSaveDir ( string  value)

Sets value for intermediateSaveDir

Parameters
valueDirectory name of which you want to save the intermediate data produced while training.
Returns
New FitMultivariateAnomaly object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New FitMultivariateAnomaly object

◆ SetMaxPollingRetries()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetMaxPollingRetries ( int  value)

Sets value for maxPollingRetries

Parameters
valuenumber of times to poll
Returns
New FitMultivariateAnomaly object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New FitMultivariateAnomaly object

◆ SetPaddingValue()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetPaddingValue ( int  value)

Sets value for paddingValue

Parameters
valueoptional 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
valuenumber of milliseconds to wait between polling
Returns
New FitMultivariateAnomaly object

◆ SetSasToken()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetSasToken ( string  value)

Sets value for sasToken

Parameters
valueSAS Token for your storage account used for uploading files.
Returns
New FitMultivariateAnomaly object

◆ SetSlidingWindow()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetSlidingWindow ( int  value)

Sets value for slidingWindow

Parameters
valueAn 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
valueA required field, start time of data to be used for detection/generating multivariate anomaly detection model, should be date-time.
Returns
New FitMultivariateAnomaly object

◆ SetStorageKey()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetStorageKey ( string  value)

Sets value for storageKey

Parameters
valueStorage Key for your storage account used for uploading files.
Returns
New FitMultivariateAnomaly object

◆ SetStorageName()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetStorageName ( string  value)

Sets value for storageName

Parameters
valueStorage Name for your storage account used for uploading files.
Returns
New FitMultivariateAnomaly object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New FitMultivariateAnomaly object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New FitMultivariateAnomaly object

◆ SetSuppressMaxRetriesExceededException()

FitMultivariateAnomaly Synapse.ML.Cognitive.FitMultivariateAnomaly.SetSuppressMaxRetriesExceededException ( bool  value)

Sets value for suppressMaxRetriesExceededException

Parameters
valueset 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
valueTimestamp column name
Returns
New FitMultivariateAnomaly object

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New FitMultivariateAnomaly object

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